kibana/docs/code/code-getting-started.asciidoc
Nate Archer 05d196cfa0
[DOCS][CODE]: Code docs grammar edits and adjustments (#44838) (#45039)
* [DOCS] Fix beta tag in Code Docs

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

* Address Gail's feedback

* More feedback
2019-09-06 15:09:39 -05:00

49 lines
1.3 KiB
Plaintext

[[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 <<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[]