From 0210ac02b72428a0f560643f3eae464bb63b9f93 Mon Sep 17 00:00:00 2001 From: Nate Archer Date: Fri, 13 Sep 2019 16:40:19 -0500 Subject: [PATCH 1/2] Fix merge conflict --- docs/code/code-import-first-repo.asciidoc | 48 +++++++++++++++++++ docs/code/code-repo-management.asciidoc | 2 +- docs/code/index.asciidoc | 6 +-- .../code/public/lib/documentation_links.ts | 2 +- 4 files changed, 53 insertions(+), 5 deletions(-) create mode 100644 docs/code/code-import-first-repo.asciidoc diff --git a/docs/code/code-import-first-repo.asciidoc b/docs/code/code-import-first-repo.asciidoc new file mode 100644 index 0000000000000..0ce3b94322f95 --- /dev/null +++ b/docs/code/code-import-first-repo.asciidoc @@ -0,0 +1,48 @@ +[[code-import-first-repo]] +== Import your first repo + +The easiest way to get started with *Code* is to 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 the <>. + +[float] +==== Enable Code app +While in beta, you can turn on *Code* by adding the following line to `kibana.yaml`: + +[source,yaml] +---- +xpack.code.ui.enabled: true +---- + +[float] +==== Import your first repository +. In {Kib}, navigate to *Code*. + +. In the *Repository URL* field, paste the following GitHub clone URL: ++ +[source,bash] +---- +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. ++ +[role="screenshot"] +image::images/code-import-repo.png[] + +. After the indexing is complete, navigate to the repo by clicking its name in the list. ++ +[role="screenshot"] +image::images/code-starter-root.png[] ++ +Congratulations! You just imported your first repo into *Code*. + +include::code-repo-management.asciidoc[] diff --git a/docs/code/code-repo-management.asciidoc b/docs/code/code-repo-management.asciidoc index b408a74657dcb..e7af158d1ce49 100644 --- a/docs/code/code-repo-management.asciidoc +++ b/docs/code/code-repo-management.asciidoc @@ -7,7 +7,7 @@ image::images/code-repo-management.png[] [float] ==== Add and delete a repo -The <> 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. +The <> page 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 an SSH key to {kib} to clone private repos. diff --git a/docs/code/index.asciidoc b/docs/code/index.asciidoc index fed1ee1d3adbe..799b356cb42c3 100644 --- a/docs/code/index.asciidoc +++ b/docs/code/index.asciidoc @@ -4,7 +4,7 @@ [partintro] -- -beta[] +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 and empowers your team to understand your codebase faster than ever before. @@ -15,7 +15,7 @@ Elastic *Code* provides an easy-to-use code search solution that scales with you * Symbol table * Full-text search with repo and language filters -<> with *Code* by importing your first repo. +<> with *Code* by importing your first repo. -- -include::code-getting-started.asciidoc[] +include::code-import-first-repo.asciidoc[] diff --git a/x-pack/legacy/plugins/code/public/lib/documentation_links.ts b/x-pack/legacy/plugins/code/public/lib/documentation_links.ts index 53da0b46518b9..30cf273746901 100644 --- a/x-pack/legacy/plugins/code/public/lib/documentation_links.ts +++ b/x-pack/legacy/plugins/code/public/lib/documentation_links.ts @@ -12,7 +12,7 @@ export const documentationLinks = { codeIntelligence: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/code.html`, gitFormat: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/code.html`, codeInstallLangServer: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/code-install-lang-server.html`, - codeGettingStarted: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/code-getting-started.html`, + codeGettingStarted: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/code-import-first-repo.html`, codeRepoManagement: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/code-repo-management.html`, codeSearch: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/code-search.html`, codeOtherFeatures: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/code-basic-nav.html`, From 3e211dc63a3bfbc5764df541a346565dd2f51ccd Mon Sep 17 00:00:00 2001 From: DonNateR Date: Mon, 23 Sep 2019 09:30:23 -0500 Subject: [PATCH 2/2] Remove getting started doc --- docs/code/code-getting-started.asciidoc | 48 ------------------------- 1 file changed, 48 deletions(-) delete mode 100644 docs/code/code-getting-started.asciidoc diff --git a/docs/code/code-getting-started.asciidoc b/docs/code/code-getting-started.asciidoc deleted file mode 100644 index e5a2f98abf876..0000000000000 --- a/docs/code/code-getting-started.asciidoc +++ /dev/null @@ -1,48 +0,0 @@ -[[code-getting-started]] -== Getting Started with Code - -The easiest way to get started with *Code* is to 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 the <>. - -[float] -==== Enable Code app -While in beta, you can turn on *Code* by adding the following line to `kibana.yaml`: - -[source,yaml] ----- -xpack.code.ui.enabled: true ----- - -[float] -==== Import your first repository -. In {Kib}, navigate to *Code*. - -. In the *Repository URL* field, paste the following GitHub clone URL: -+ -[source,bash] ----- -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. -+ -[role="screenshot"] -image::images/code-import-repo.png[] - -. After the indexing is complete, navigate to the repo by clicking its name in the list. -+ -[role="screenshot"] -image::images/code-starter-root.png[] -+ -Congratulations! You just imported your first repo into *Code*. - -include::code-repo-management.asciidoc[]