From f31a53c1f440dfde7afd86e48993c2f0254f333e Mon Sep 17 00:00:00 2001 From: Nate Archer Date: Fri, 6 Sep 2019 13:48:30 -0500 Subject: [PATCH] [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 --- docs/code/code-basic-nav.asciidoc | 2 +- docs/code/code-getting-started.asciidoc | 9 ++++++--- docs/code/code-install-lang-server.asciidoc | 6 ++---- docs/code/code-repo-management.asciidoc | 9 +++++---- docs/code/code-search.asciidoc | 2 +- docs/code/code-semantic-nav.asciidoc | 10 +++++++--- docs/code/index.asciidoc | 8 +++++--- 7 files changed, 27 insertions(+), 19 deletions(-) diff --git a/docs/code/code-basic-nav.asciidoc b/docs/code/code-basic-nav.asciidoc index 77a56b24801c..ccd290532b66 100644 --- a/docs/code/code-basic-nav.asciidoc +++ b/docs/code/code-basic-nav.asciidoc @@ -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[] diff --git a/docs/code/code-getting-started.asciidoc b/docs/code/code-getting-started.asciidoc index ec279238c6dc..e5a2f98abf87 100644 --- a/docs/code/code-getting-started.asciidoc +++ b/docs/code/code-getting-started.asciidoc @@ -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. diff --git a/docs/code/code-install-lang-server.asciidoc b/docs/code/code-install-lang-server.asciidoc index 1bb5a24f0c7f..ba50cfd8de32 100644 --- a/docs/code/code-install-lang-server.asciidoc +++ b/docs/code/code-install-lang-server.asciidoc @@ -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"] diff --git a/docs/code/code-repo-management.asciidoc b/docs/code/code-repo-management.asciidoc index dde3c4dbc6fd..e3ebd809f480 100644 --- a/docs/code/code-repo-management.asciidoc +++ b/docs/code/code-repo-management.asciidoc @@ -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: diff --git a/docs/code/code-search.asciidoc b/docs/code/code-search.asciidoc index 777669be8139..c3086bfb850a 100644 --- a/docs/code/code-search.asciidoc +++ b/docs/code/code-search.asciidoc @@ -10,7 +10,7 @@ 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 conduct a 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 refine the results by using the repo and language filters on the left. diff --git a/docs/code/code-semantic-nav.asciidoc b/docs/code/code-semantic-nav.asciidoc index c85c7e87fda5..a1535f1449df 100644 --- a/docs/code/code-semantic-nav.asciidoc +++ b/docs/code/code-semantic-nav.asciidoc @@ -1,15 +1,19 @@ [[code-semantic-nav]] == Semantic code navigation -If the file is one of *Code’s* <> and the corresponding language server is <>, 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 <> +- You have installed the corresponding <> [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[] diff --git a/docs/code/index.asciidoc b/docs/code/index.asciidoc index 060357958953..d29ac440d6e2 100644 --- a/docs/code/index.asciidoc +++ b/docs/code/index.asciidoc @@ -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 <> with *Code* by importing your first repo. --