mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
6517579518
# Backport This will backport the following commits from `main` to `9.0`: - [[docs] Migrate docs from AsciiDoc to Markdown (#212558)](https://github.com/elastic/kibana/pull/212558) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Colleen McGinnis","email":"colleen.mcginnis@elastic.co"},"sourceCommit":{"committedDate":"2025-03-04T13:56:07Z","message":"[docs] Migrate docs from AsciiDoc to Markdown (#212558)\n\nMigrate docs from AsciiDoc to Markdown. The preview can be built after\n#212557 is merged.\n\n@florent-leborgne please tag reviewers, add the appropriate label(s),\nand take this out of draft when you're ready.\n\nNote: More files are deleted than added here because the content from\nsome files was moved to\n[elastic/docs-content](https://github.com/elastic/docs-content).\n\n**What has moved to\n[elastic/docs-content](https://github.com/elastic/docs-content)?**\n\nPublic-facing narrative and conceptual docs have moved. Most can now be\nfound under the following directories in the new docs:\n- explore-analyze: Discover, Dashboards, Visualizations, Reporting,\nAlerting, dev tools...\n- deploy-manage: Stack management (Spaces, user management, remote\nclusters...)\n- troubleshooting: .... troubleshooting pages\n\n**What is staying in the Kibana repo?**\n\n- Reference content (= anything that is or could be auto-generated):\nSettings, syntax references\n- Release notes\n- Developer guide\n\n---------\n\nCo-authored-by: Florent Le Borgne <florent.leborgne@elastic.co>","sha":"1814c60017da172427cd270bf2c99a8e144d378c","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","backport:version","v9.1.0"],"number":212558,"url":"https://github.com/elastic/kibana/pull/212558","mergeCommit":{"message":"[docs] Migrate docs from AsciiDoc to Markdown (#212558)\n\nMigrate docs from AsciiDoc to Markdown. The preview can be built after\n#212557 is merged.\n\n@florent-leborgne please tag reviewers, add the appropriate label(s),\nand take this out of draft when you're ready.\n\nNote: More files are deleted than added here because the content from\nsome files was moved to\n[elastic/docs-content](https://github.com/elastic/docs-content).\n\n**What has moved to\n[elastic/docs-content](https://github.com/elastic/docs-content)?**\n\nPublic-facing narrative and conceptual docs have moved. Most can now be\nfound under the following directories in the new docs:\n- explore-analyze: Discover, Dashboards, Visualizations, Reporting,\nAlerting, dev tools...\n- deploy-manage: Stack management (Spaces, user management, remote\nclusters...)\n- troubleshooting: .... troubleshooting pages\n\n**What is staying in the Kibana repo?**\n\n- Reference content (= anything that is or could be auto-generated):\nSettings, syntax references\n- Release notes\n- Developer guide\n\n---------\n\nCo-authored-by: Florent Le Borgne <florent.leborgne@elastic.co>","sha":"1814c60017da172427cd270bf2c99a8e144d378c"}},"sourceBranch":"main","suggestedTargetBranches":["9.0"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","labelRegex":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/212558","number":212558,"mergeCommit":{"message":"[docs] Migrate docs from AsciiDoc to Markdown (#212558)\n\nMigrate docs from AsciiDoc to Markdown. The preview can be built after\n#212557 is merged.\n\n@florent-leborgne please tag reviewers, add the appropriate label(s),\nand take this out of draft when you're ready.\n\nNote: More files are deleted than added here because the content from\nsome files was moved to\n[elastic/docs-content](https://github.com/elastic/docs-content).\n\n**What has moved to\n[elastic/docs-content](https://github.com/elastic/docs-content)?**\n\nPublic-facing narrative and conceptual docs have moved. Most can now be\nfound under the following directories in the new docs:\n- explore-analyze: Discover, Dashboards, Visualizations, Reporting,\nAlerting, dev tools...\n- deploy-manage: Stack management (Spaces, user management, remote\nclusters...)\n- troubleshooting: .... troubleshooting pages\n\n**What is staying in the Kibana repo?**\n\n- Reference content (= anything that is or could be auto-generated):\nSettings, syntax references\n- Release notes\n- Developer guide\n\n---------\n\nCo-authored-by: Florent Le Borgne <florent.leborgne@elastic.co>","sha":"1814c60017da172427cd270bf2c99a8e144d378c"}}]}] BACKPORT--> Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
41 lines
2.4 KiB
Markdown
41 lines
2.4 KiB
Markdown
---
|
|
mapped_pages:
|
|
- https://www.elastic.co/guide/en/kibana/current/add-data-tutorials.html
|
|
---
|
|
|
|
# Add data tutorials [add-data-tutorials]
|
|
|
|
`Add Data` in the {{kib}} Home application contains tutorials for setting up data flows in the Elastic stack.
|
|
|
|
Each tutorial contains three sets of instructions:
|
|
|
|
* `On Premise.` Set up a data flow when both {{kib}} and {{es}} are running on premise.
|
|
* `On Premise Elastic Cloud.` Set up a data flow when {{kib}} is running on premise and {{es}} is running on Elastic Cloud.
|
|
* `Elastic Cloud.` Set up a data flow when both {{kib}} and {{es}} are running on Elastic Cloud.
|
|
|
|
|
|
## Creating a new tutorial [_creating_a_new_tutorial]
|
|
|
|
1. Create a new directory in the [tutorials directory](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/home/server/tutorials).
|
|
2. In the new directory, create a file called `index.ts` that exports a function. The function must return a function object that conforms to the `TutorialSchema` interface [tutorial schema](https://github.com/elastic/kibana/tree/master/src/platform/plugins/shared/home/server/services/tutorials/lib/tutorial_schema.ts).
|
|
3. Register the tutorial in [register.ts](https://github.com/elastic/kibana/tree/master/src/platform/plugins/shared/home/server/tutorials/register.ts) by adding it to the `builtInTutorials`.
|
|
4. Add image assets to the `tutorial_resources` directory.
|
|
5. Run {{kib}} locally to preview the tutorial.
|
|
6. Create a PR and go through the review process to get the changes approved.
|
|
|
|
If you are creating a new plugin and the tutorial is only related to that plugin, you can also place the `TutorialSchema` object into your plugin folder. Add `home` to the `requiredPlugins` list in your `kibana.json` file. Then register the tutorial object by calling `home.tutorials.registerTutorial(tutorialObject)` in the `setup` lifecycle of your server plugin.
|
|
|
|
|
|
### Variables [_variables]
|
|
|
|
String values can contain variables that are substituted when rendered. Variables are specified by `{}`. For example: `{config.docs.version}` is rendered as `6.2` when running the tutorial in {{kib}} 6.2.
|
|
|
|
[Provided variables](https://github.com/elastic/kibana/tree/master/src/platform/plugins/shared/home/public/application/components/tutorial/replace_template_strings.js)
|
|
|
|
|
|
### Markdown [_markdown]
|
|
|
|
String values can contain limited Markdown syntax.
|
|
|
|
[Enabled Markdown grammars](https://elastic.github.io/eui/#/editors-syntax/markdown-format)
|
|
|