Skip to content

Commit

Permalink
[DOCS][CODE]: Fix TOC issue for renamed Code page (elastic#45700) (el…
Browse files Browse the repository at this point in the history
…astic#45719)

* [DOCS] Fix beta tag in Code Docs

* Fix TOC issue for renames Code page
  • Loading branch information
narcher7 authored Sep 17, 2019
1 parent 8894251 commit 1461ec8
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 4 deletions.
48 changes: 48 additions & 0 deletions docs/code/code-import-first-repo.asciidoc
Original file line number Diff line number Diff line change
@@ -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 <<code-multiple-kibana-instances-config, config instructions for multiple Kibana instances>>.

[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[]
2 changes: 1 addition & 1 deletion docs/code/code-repo-management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ image::images/code-repo-management.png[]

[float]
==== 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.
The <<code-import-first-repo, Import your first repository>> 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.

Expand Down
4 changes: 2 additions & 2 deletions docs/code/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

<<code-getting-started, Get Started>> with *Code* by importing your first repo.
<<code-import-first-repo, Get Started>> with *Code* by importing your first repo.
--

include::code-getting-started.asciidoc[]
include::code-import-first-repo.asciidoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export const documentationLinks = {
codeIntelligence: `${npStart.core.docLinks.ELASTIC_WEBSITE_URL}guide/en/kibana/${npStart.core.docLinks.DOC_LINK_VERSION}/code.html`,
gitFormat: `${npStart.core.docLinks.ELASTIC_WEBSITE_URL}guide/en/kibana/${npStart.core.docLinks.DOC_LINK_VERSION}/code.html`,
codeInstallLangServer: `${npStart.core.docLinks.ELASTIC_WEBSITE_URL}guide/en/kibana/${npStart.core.docLinks.DOC_LINK_VERSION}/code-install-lang-server.html`,
codeGettingStarted: `${npStart.core.docLinks.ELASTIC_WEBSITE_URL}guide/en/kibana/${npStart.core.docLinks.DOC_LINK_VERSION}/code-getting-started.html`,
codeGettingStarted: `${npStart.core.docLinks.ELASTIC_WEBSITE_URL}guide/en/kibana/${npStart.core.docLinks.DOC_LINK_VERSION}/code-import-first-repo.html`,
codeRepoManagement: `${npStart.core.docLinks.ELASTIC_WEBSITE_URL}guide/en/kibana/${npStart.core.docLinks.DOC_LINK_VERSION}/code-repo-management.html`,
codeSearch: `${npStart.core.docLinks.ELASTIC_WEBSITE_URL}guide/en/kibana/${npStart.core.docLinks.DOC_LINK_VERSION}/code-search.html`,
codeOtherFeatures: `${npStart.core.docLinks.ELASTIC_WEBSITE_URL}guide/en/kibana/${npStart.core.docLinks.DOC_LINK_VERSION}/code-basic-nav.html`,
Expand Down

0 comments on commit 1461ec8

Please sign in to comment.