diff --git a/extend/contribute/api-docs/overview.md b/extend/contribute/api-docs/overview.md index 043e0722f7..25903979d2 100644 --- a/extend/contribute/api-docs/overview.md +++ b/extend/contribute/api-docs/overview.md @@ -3,7 +3,7 @@ This page explains at a high-level how API docs work at Elastic today, with context on how this differs from our previous approaches and where we're heading. Use this page to understand the core primitives and workflows that apply across all Elastic teams, so you can contribute effectively. :::{tip} -The API docs use a different system to the main Elastic docs. Refer to [Contribute to Elastic docs](../../contribute/index.md) for an overview of the two systems. +The API docs use a different system to the main Elastic docs. Refer to [Contribute to Elastic docs](/extend/contribute/index.md) for an overview of the two systems. ::: While the implementation details [vary significantly across teams](workflows.md), at a high level: diff --git a/extend/contribute/toc.yml b/extend/contribute/toc.yml new file mode 100644 index 0000000000..c315adeb85 --- /dev/null +++ b/extend/contribute/toc.yml @@ -0,0 +1,13 @@ +project: 'Contribute' +toc: + - file: index.md + children: + - file: api-docs/index.md + children: + - file: api-docs/overview.md + - file: api-docs/checklist.md + - file: api-docs/guidelines.md + - file: api-docs/organize-annotate.md + - file: api-docs/quickstart.md + - file: api-docs/workflows.md + - file: api-docs/help.md \ No newline at end of file diff --git a/extend/index.md b/extend/index.md index 110f8b8de8..e6521b021c 100644 --- a/extend/index.md +++ b/extend/index.md @@ -1,26 +1 @@ -# Extend and contribute - -This section contains information on how to extend or contribute to our various products. - -## Contributing to Elastic documentation - -You can contribute to the Elastic documentation in several ways. - -Refer to [Contribute to Elastic documentation](./contribute/index.md) for an overview. - -## Contributing to Elastic Projects - -You can contribute to various projects, including: - -- [Kibana](kibana://extend/index.md): Enhance our data visualization platform by contributing to Kibana. -- [Logstash](logstash://extend/index.md): Help us improve the data processing pipeline with your contributions to Logstash. -- [Beats](beats://extend/index.md): Add new features or beats to our lightweight data shippers. - -## Creating Integrations - -Extend the capabilities of Elastic by creating integrations that connect Elastic products with other tools and systems. Visit our [Integrations Guide](integrations://extend/index.md) to get started. - -## Elasticsearch Plugins - -Develop custom plugins to add new functionalities to Elasticsearch. Check out our [Elasticsearch Plugins Development Guide](elasticsearch://extend/index.md) for detailed instructions and best practices. - +# Extend \ No newline at end of file diff --git a/extend/intro/index.md b/extend/intro/index.md new file mode 100644 index 0000000000..e7c278b23f --- /dev/null +++ b/extend/intro/index.md @@ -0,0 +1,31 @@ +--- +navigation_title: Extend and contribute +description: Extend and contribute to Elastic +--- + +# Extend and contribute to Elastic + +This section contains information on how to extend or contribute to our various products. + +## Contributing to Elastic documentation + +You can contribute to the Elastic documentation in several ways. + +Refer to [Contribute to Elastic documentation](/extend/contribute/index.md) for an overview. + +## Contributing to Elastic Projects + +You can contribute to various projects, including: + +- [Kibana](kibana://extend/index.md): Enhance our data visualization platform by contributing to Kibana. +- [Logstash](logstash://extend/index.md): Help us improve the data processing pipeline with your contributions to Logstash. +- [Beats](beats://extend/index.md): Add new features or beats to our lightweight data shippers. + +## Creating Integrations + +Extend the capabilities of Elastic by creating integrations that connect Elastic products with other tools and systems. Visit our [Integrations Guide](integrations://extend/index.md) to get started. + +## Elasticsearch Plugins + +Develop custom plugins to add new functionalities to Elasticsearch. Check out our [Elasticsearch Plugins Development Guide](elasticsearch://extend/index.md) for detailed instructions and best practices. + diff --git a/extend/intro/toc.yml b/extend/intro/toc.yml new file mode 100644 index 0000000000..f2ab236796 --- /dev/null +++ b/extend/intro/toc.yml @@ -0,0 +1,2 @@ +toc: + - file: index.md \ No newline at end of file diff --git a/extend/toc.yml b/extend/toc.yml index 01bd216017..f0de48c957 100644 --- a/extend/toc.yml +++ b/extend/toc.yml @@ -1,14 +1,5 @@ +project: 'Extend' toc: - file: index.md - children: - - file: contribute/index.md - children: - - file: contribute/api-docs/index.md - children: - - file: contribute/api-docs/overview.md - - file: contribute/api-docs/checklist.md - - file: contribute/api-docs/guidelines.md - - file: contribute/api-docs/organize-annotate.md - - file: contribute/api-docs/quickstart.md - - file: contribute/api-docs/workflows.md - - file: contribute/api-docs/help.md \ No newline at end of file + - toc: intro + - toc: contribute \ No newline at end of file