[Code] Updates to copy in the Code docs (#39003)
This commit is contained in:
parent
05d802ff5f
commit
b05b0ea35b
|
@ -3,7 +3,7 @@
|
|||
|
||||
[float]
|
||||
==== View file structure and information
|
||||
The *File* tree on the left is the major way for you to navigate through your folder structure. When you are on a directory, *Code* also presents a finder-like view on the right. Additionally, a file path breadcrumb makes it easy to go back to any parent directory.
|
||||
The *File* tree on the left is the primary way to navigate through your folder structure. When you are in a directory, *Code* also presents a finder-like view on the right. Additionally, a file path breadcrumb makes it easy to go back to any parent directory.
|
||||
|
||||
[float]
|
||||
==== Git History and Blame
|
||||
|
|
|
@ -1,19 +1,19 @@
|
|||
[[code-getting-started]]
|
||||
== Getting Started with Code
|
||||
|
||||
The easiest way to get started with *Code* is to import a real-world repository into *Code*.
|
||||
The easiest way to get started with *Code* is to simply import a real-world repository.
|
||||
|
||||
[float]
|
||||
==== Before you begin
|
||||
You must have a {kib} instance up and running.
|
||||
|
||||
If you are in an environment where you have multiple {kib} instances in a cluster, see <<code-multiple-kibana-instances-config, Config for multiple Kibana instances>>.
|
||||
If you are in an environment where you have multiple {kib} instances in a cluster, see the <<code-multiple-kibana-instances-config, config instructions for multiple Kibana instances>>.
|
||||
|
||||
[float]
|
||||
==== Import your first repository
|
||||
. Navigate to the Code app.
|
||||
|
||||
. In *Repository URL*, paste the following GitHub clone URL:
|
||||
. In the *Repository URL* field, paste the following GitHub clone URL:
|
||||
+
|
||||
[source,bash]
|
||||
----
|
||||
|
@ -22,7 +22,7 @@ https://github.com/Microsoft/TypeScript-Node-Starter
|
|||
|
||||
. Click *Import*.
|
||||
+
|
||||
A list item shows the cloning, then indexing progress of the `TypeScript-Node-Starter` repo.
|
||||
A new item in the list displays the cloning and indexing progress of the `TypeScript-Node-Starter` repo.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/code-import-repo.png[]
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
[[code-install-lang-server]]
|
||||
== Install language server
|
||||
|
||||
*Code* comes to with built-in language support to TypeScript. You can install additional languages as a {kib} plugin.
|
||||
*Code* comes with built-in language support for TypeScript. You can install additional languages as a {kib} plugin.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/code-lang-server-tab.png[]
|
||||
|
@ -12,7 +12,7 @@ The following languages are supported for the current version:
|
|||
|
||||
* Additional language support: `Java`
|
||||
|
||||
You can check the status of the language servers and get installation instructions on the *Language Servers* tab. Make sure the status of the language server is `INSTALLED` or `RUNNING` after your restart the {kib} instance.
|
||||
You can check the status of the language servers and get installation instructions on the *Language Servers* tab. Make sure the status of the language server is `INSTALLED` or `RUNNING` after you restart the {kib} instance.
|
||||
[role="screenshot"]
|
||||
image::images/code-lang-server-status.png[]
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
[[code-multiple-kibana-instances-config]]
|
||||
== Config for multiple {kib} instances
|
||||
If you are using multiple instances of {kib}, you must assign one {kib} instance as a *Code* `node`. Add the following line of code to your `kibana.yml` file for every {kib} instance and restart the instances:
|
||||
If you are using multiple instances of {kib}, you must manually assign at least one {kib} instance as a *Code* `node`. Add the following line of code to your `kibana.yml` file for each {kib} instance you wish to use and restart the instances:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
|
|
|
@ -9,13 +9,13 @@ image::images/code-repo-management.png[]
|
|||
==== Add and delete a repo
|
||||
The <<code-getting-started, Getting Started>> provides step-by-step instructions for adding a GitHub repo to *Code*. You can fine tune the hostname of the git clone URL in your `kibana.yml` file.
|
||||
|
||||
For security reasons, Code allows only a few trusted hostnames, such as github.com, by default. You can add SSH key to {kib} to clone private repo.
|
||||
For security reasons, Code allows only a few trusted hostnames, such as github.com, by default. You can add an SSH key to {kib} to clone private repos.
|
||||
|
||||
Deleting a repo removes it from local storage and the Elasticsearch index.
|
||||
|
||||
[float]
|
||||
==== Reindex a repo
|
||||
*Code* automatically reindexes an imported repo, but in some cases you might need to manually refresh the index. For example, you might refresh an index after a new language server is installed. Or, you might want to immediately update the index to the HEAD revision. Click *Reindex* to initiate a reindex.
|
||||
*Code* automatically reindexes an imported repo at set intervals, but in some cases you might need to manually refresh the index. For example, you might refresh an index after a new language server is installed. Or, you might want to immediately update the index to the HEAD revision. Click *Reindex* to initiate a reindex.
|
||||
|
||||
[float]
|
||||
==== Clone URL management
|
||||
|
|
|
@ -3,21 +3,21 @@
|
|||
|
||||
[float]
|
||||
==== Typeahead search
|
||||
The search bar is built to minimize the time for you to locate the result. It shows `Symbols`, `Files`, and `Repos` results as you type, and clicking on any result takes you to the definition. You can use the search type dropdown to show all types of results or limit it to a specific search type.
|
||||
The search bar is designed to help you find what you're looking for as quickly as possible. It shows `Symbols`, `Files`, and `Repos` results as you type. Clicking on any result takes you to the definition. You can use the search type dropdown to show all types of results or limit it to a specific search type.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/code-quick-search.png[]
|
||||
|
||||
[float]
|
||||
==== Full-text search
|
||||
If the quick search results don’t contain what you are looking for, you can press ‘Enter’ to bring out the full text search.
|
||||
If the quick search results don’t contain what you are looking for, you can press ‘Enter’ to conduct a full text search.
|
||||
[role="screenshot"]
|
||||
image::images/code-full-text-search.png[]
|
||||
You can further slice and dice the results using the repo and language facet filters on the left.
|
||||
You can further refine the results by using the repo and language filters on the left.
|
||||
|
||||
[float]
|
||||
==== Search filter
|
||||
You can also use the Search Filters to limit the search scope to certain repos before issuing a query. To search across all repos, remove all repo filters. By default, the search repo is limited to the current repo.
|
||||
You can also use the Search Filters to limit the search scope to certain repos before issuing a query. To search across all repos, remove any applied repo filters. By default, search results are limited to the repo you're currently viewing.
|
||||
[role="screenshot"]
|
||||
image::images/code-search-filter.png[]
|
||||
|
||||
|
|
|
@ -4,9 +4,7 @@
|
|||
[partintro]
|
||||
--
|
||||
|
||||
beta[] Interaction with source code is pervasive and essential for any technology company. How efficiently you search, navigate, and gain insight to your source code impacts how fast your organization can innovate. *Code* provides an easy-to-use code search solution that scales with your organization, so your team can focus on shipping awesome products and providing the best services. *Code* provides the following functions:
|
||||
|
||||
Code provides:
|
||||
beta[] Interaction with source code is pervasive and essential for any technology company. Speed of innovation is limited by how easy it is to search, navigate, and gain insight into your source code. Elastic *Code* provides an easy-to-use code search solution that scales with your organization. *Code* empowers your team to ship awesome products and provide the best services. *Code* offers the following functions:
|
||||
|
||||
* Jump to definition and find references for a symbol
|
||||
* Typeahead search for symbol definition, file, and repo
|
||||
|
|
Loading…
Reference in a new issue