Create new Contribute to docs section, move existing content

extend/contribute/api-docs/checklist.md → contribute-docs/api-docs/checklist.md

@@ -28,6 +28,6 @@ Use this checklist to verify the quality, completeness, and consistency of your
 ## Quality assurance
 
 - Preview your changes locally before submitting (see [Contribute locally: Elasticsearch quickstart](./quickstart.md))
-- [Lint your API docs](guidelines.md#lint-your-api-docs) to identify and fix issues
+- [Lint your API docs](./guidelines.md#lint-your-api-docs) to identify and fix issues
 - Check all links to ensure they work correctly
 - Ensure examples are realistic and error-free

extend/contribute/api-docs/guidelines.md → contribute-docs/api-docs/guidelines.md

@@ -510,7 +510,7 @@ paths:
 :::{tab-item} Elasticsearch
 :sync: elasticsearch
 
-**External documentation links** use the `@ext_doc_id` annotation to connect to narrative guides. This is transformed into an OpenAPI `externalDocs` field in the [compilation process](overview.md#example-elasticsearch):
+**External documentation links** use the `@ext_doc_id` annotation to connect to narrative guides. This is transformed into an OpenAPI `externalDocs` field in the [compilation process](./overview.md#example-elasticsearch):
 
 ```ts
 /**
@@ -621,7 +621,7 @@ The [Elasticsearch API specification](https://github.com/elastic/elasticsearch-s
 - **Spectral**: Configuration in `.spectral.yaml`
 - **Redocly**: Configuration in `redocly.yaml`
 
-Refer to [the Elasticsearch quickstart](quickstart.md#lint-your-docs) to learn how to run the linter locally.
+Refer to [the Elasticsearch quickstart](./quickstart.md#lint-your-docs) to learn how to run the linter locally.
 
 ::::
 ::::

extend/contribute/api-docs/help.md → contribute-docs/api-docs/help.md

@@ -2,15 +2,15 @@
 
 The API docs workflow is pretty complicated, and there's lots of moving parts. It takes a village to produce excellent API docs, so don't hesitate to ask for help if you get stuck or have questions.
 
-If you're not sure who owns a specific API, check out the [API ownership table](workflows.md) to find the right team.
+If you're not sure who owns a specific API, check out the [API ownership table](./workflows.md) to find the right team.
 
 ## Report issues
 
 ### API docs issues
 
 When you find a bug or gap in the API docs:
 
-- If you're comfortable making the change, open a PR in the [relevant repo](workflows.md)
+- If you're comfortable making the change, open a PR in the [relevant repo](./workflows.md)
 - Alternatively, open an issue in either:
    -  [elastic/docs-content](https://www.github.com/elastic/docs-content/issues) (public repo)
    - [elastic/docs-content-internal](https://www.github.com/elastic/docs-content-internal/issues) (Elastic employees only)

extend/contribute/api-docs/overview.md → contribute-docs/api-docs/overview.md

@@ -3,10 +3,10 @@
 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](../index.md) for an overview of the two systems.
 :::
 
-While the implementation details [vary significantly across teams](workflows.md), at a high level:
+While the implementation details [vary significantly across teams](./workflows.md), at a high level:
 
 - We use [OpenAPI](https://spec.openapis.org/oas/latest.html) files to generate REST API documentation
 - Our API docs are hosted by [Bump.sh](https://bump.sh/)

contribute-docs/api-docs/toc.yml

@@ -0,0 +1,9 @@
+toc:
+  - file: index.md
+  - file: overview.md
+  - file: checklist.md
+  - file: guidelines.md
+  - file: organize-annotate.md
+  - file: quickstart.md
+  - file: workflows.md
+  - file: help.md

contribute-docs/toc.yml

@@ -0,0 +1,11 @@
+toc:
+  - file: index.md
+  - 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

docset.yml

@@ -1,3 +1,3 @@
 project: 'Elastic documentation'
 max_toc_depth: 2
 
@@ -78,6 +78,7 @@
   - toc: troubleshoot
   - toc: release-notes
   - toc: reference
+  - toc: contribute-docs
   - toc: extend
   - file: archive.md
   - file: versions.md

extend/index.md

@@ -55,4 +55,4 @@ Ready to get started? Explore the [Elastic API Reference]({{apis}}).
 
 ## 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.
+You can contribute to the Elastic documentation in several ways. Refer to [Contribute to Elastic documentation](./../contribute-docs/index.md) for an overview.

extend/toc.yml

@@ -1,14 +1,2 @@
 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
+  - file: index.md

redirects.yml

@@ -467,4 +467,15 @@ redirects:
   'solutions/observability/apm/jaeger.md': 'solutions/observability/apm/ingest/jaeger.md'
   'solutions/observability/apm/monitor-aws-lambda-functions.md': 'solutions/observability/apm/ingest/monitor-aws-lambda-functions.md'
 # Related to https://github.com/elastic/docs-content/pull/3142
-  'deploy-manage/deploy/self-managed/networkaddress-cache-ttl.md': 'deploy-manage/deploy/self-managed/important-settings-configuration.md'
+  'deploy-manage/deploy/self-managed/networkaddress-cache-ttl.md': 'deploy-manage/deploy/self-managed/important-settings-configuration.md'
+
+# Related to contribute-docs restructure - moved from extend/contribute/ to contribute-docs/
+  'extend/contribute/index.md': 'contribute-docs/index.md'
+  'extend/contribute/api-docs/index.md': 'contribute-docs/api-docs/index.md'
+  'extend/contribute/api-docs/overview.md': 'contribute-docs/api-docs/overview.md'
+  'extend/contribute/api-docs/checklist.md': 'contribute-docs/api-docs/checklist.md'
+  'extend/contribute/api-docs/guidelines.md': 'contribute-docs/api-docs/guidelines.md'
+  'extend/contribute/api-docs/organize-annotate.md': 'contribute-docs/api-docs/organize-annotate.md'
+  'extend/contribute/api-docs/quickstart.md': 'contribute-docs/api-docs/quickstart.md'
+  'extend/contribute/api-docs/workflows.md': 'contribute-docs/api-docs/workflows.md'
+  'extend/contribute/api-docs/help.md': 'contribute-docs/api-docs/help.md'