1814c60017
Migrate docs from AsciiDoc to Markdown. The preview can be built after #212557 is merged. @florent-leborgne please tag reviewers, add the appropriate label(s), and take this out of draft when you're ready. Note: More files are deleted than added here because the content from some files was moved to [elastic/docs-content](https://github.com/elastic/docs-content). **What has moved to [elastic/docs-content](https://github.com/elastic/docs-content)?** Public-facing narrative and conceptual docs have moved. Most can now be found under the following directories in the new docs: - explore-analyze: Discover, Dashboards, Visualizations, Reporting, Alerting, dev tools... - deploy-manage: Stack management (Spaces, user management, remote clusters...) - troubleshooting: .... troubleshooting pages **What is staying in the Kibana repo?** - Reference content (= anything that is or could be auto-generated): Settings, syntax references - Release notes - Developer guide --------- Co-authored-by: Florent Le Borgne <florent.leborgne@elastic.co>
2.4 KiB
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]
- Create a new directory in the tutorials directory.
- In the new directory, create a file called
index.tsthat exports a function. The function must return a function object that conforms to theTutorialSchemainterface tutorial schema. - Register the tutorial in register.ts by adding it to the
builtInTutorials. - Add image assets to the
tutorial_resourcesdirectory. - Run {{kib}} locally to preview the tutorial.
- 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.
Markdown [_markdown]
String values can contain limited Markdown syntax.