[DOCS][CODE]: Code docs grammar edits and adjustments (#44838)

* [DOCS] Fix beta tag in Code Docs

* [DOCS][7.x][CODE]: Code docs grammar edits and adjustments

* Address Gail's feedback

* More feedback
This commit is contained in:
Nate Archer 2019-09-06 13:48:30 -05:00 committed by GitHub
parent f8ba0238ee
commit f31a53c1f4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 27 additions and 19 deletions

View file

@ -19,7 +19,7 @@ image::images/code-blame.png[]
[float]
==== Branch selector
You can use the Branch selector to view different branches of a repo. Note that code intelligence and search index are not available for any branch other than master branch.
You can use the Branch selector to view different branches of a repo. Note that code intelligence and search index are not available for any branch other than the master branch.
include::code-semantic-nav.asciidoc[]

View file

@ -1,7 +1,7 @@
[[code-getting-started]]
== Getting Started with Code
The easiest way to get started with *Code* is to simply import a real-world repository.
The easiest way to get started with *Code* is to import a real-world repository.
[float]
==== Before you begin
@ -11,7 +11,8 @@ If you are in an environment where you have multiple {kib} instances in a cluste
[float]
==== Enable Code app
In beta, Code needs to be turned on by adding the following line to `kibana.yaml`
While in beta, you can turn on *Code* by adding the following line to `kibana.yaml`:
[source,yaml]
----
xpack.code.ui.enabled: true
@ -19,7 +20,7 @@ xpack.code.ui.enabled: true
[float]
==== Import your first repository
. Navigate to the Code app.
. In {Kib}, navigate to *Code*.
. In the *Repository URL* field, paste the following GitHub clone URL:
+
@ -28,6 +29,8 @@ xpack.code.ui.enabled: true
https://github.com/Microsoft/TypeScript-Node-Starter
----
`https` is recommend for cloning git repositories.
. Click *Import*.
+
A new item in the list displays the cloning and indexing progress of the `TypeScript-Node-Starter` repo.

View file

@ -6,11 +6,9 @@
[role="screenshot"]
image::images/code-lang-server-tab.png[]
The following languages are supported for the current version:
For the current version, *Code* supports the following languages in addition to TypeScript:
* Built-in language support: `TypeScript`
* Additional language support: `Java`
* `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 you restart the {kib} instance.
[role="screenshot"]

View file

@ -23,10 +23,11 @@ In some cases you might need to manually refresh the index besides automatic ind
==== Clone URL management
For security reasons, *Code* only allows the following hostnames in the git clone URL by default:
[source,yaml]
----
['github.com', 'gitlab.com', 'bitbucket.org', 'gitbox.apache.org', 'eclipse.org']
----
- `github.com`
- `gitlab.com`
- `bitbucket.org`
- `gitbox.apache.org`
- `eclipse.org`
You can add your own hostname (for example, acme.com) to the whitelist by adding the following line to your `config/kibana.yaml` file:

View file

@ -10,7 +10,7 @@ image::images/code-quick-search.png[]
[float]
==== Full-text search
If the quick search results dont contain what you are looking for, you can press Enter to conduct a full text search.
If the quick search results dont 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 refine the results by using the repo and language filters on the left.

View file

@ -1,15 +1,19 @@
[[code-semantic-nav]]
== Semantic code navigation
If the file is one of *Codes* <<code-install-lang-server, supported languages>> and the corresponding language server is <<code-install-lang-server, properly installed>>, you can navigate the files with semantic code navigation features.
You can navigate a file with semantic code navigation features if:
- *Code* supports the file's <<code-install-lang-server, language>>
- You have installed the corresponding <<code-install-lang-server, language server>>
[float]
==== Goto definition and find reference
Hovering your cursor over a symbol in a file opens information about the symbol, including its qualified name and documentation, when available. You can perform two actions:
* *Goto Definition* navigates to the symbol definition. If the definition is defined in another repo, *Code* can find the definition if the definition repo is also imported.
* *Goto Definition* navigates to the symbol definition. Definitions defined in a different repo can be found, provided that you have imported the repo with the definition.
* *Find Reference* opens a panel that lists all the places where the symbol is referenced in the current repo.
* *Find Reference* opens a panel that lists all references to the symbol.
[role="screenshot"]
image::images/code-semantic-nav.png[]

View file

@ -6,12 +6,14 @@
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:
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 and empowers your team to understand your codebase faster than ever before.
*Code* offers the following functions:
* Jump to definition and find references for a symbol
* Find references and definitions for any object or symbol
* Typeahead search for symbol definition, file, and repo
* Symbol table
* Full text search with repo and language filters
* Full-text search with repo and language filters
<<code-getting-started, Get Started>> with *Code* by importing your first repo.
--