Skip to content

Commit ae74b70

Browse files
committed
more cleanup
1 parent 10ee6c4 commit ae74b70

File tree

21 files changed

+122
-86
lines changed

21 files changed

+122
-86
lines changed

docs/source/docset.yml

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,21 @@ toc:
3131
- folder: migration
3232
children:
3333
- file: index.md
34-
- file: guide.md
35-
- file: file-structure.md
36-
- file: mapping.md
37-
- file: tabs.md
38-
- file: gh-action.md
39-
- file: codeowner.md
34+
- folder: freeze
35+
children:
36+
- file: index.md
37+
- file: codeowner.md
38+
- file: gh-action.md
39+
- file: syntax.md
40+
- file: ia.md
41+
- file: versioning.md
42+
- file: engineering.md
43+
- folder: guide
44+
children:
45+
- file: index.md
46+
- file: file-structure.md
47+
- file: mapping.md
48+
- file: migration-scripts.md
4049
- folder: configure
4150
children:
4251
- file: index.md

docs/source/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Elastic Docs V3 is our next-generation documentation platform designed to improv
66

77
**What do you want to do today?**
88

9-
* [Contribute to Elastic documentation](/contribute/index.html)
10-
* [Learn about migration to Elastic Docs V3](/migration/index.html)
11-
* [Configure content sets in V3](/configure/index.html)
12-
* [Learn about V3 syntax](/syntax/index.html)
13-
* [Contribute to V3 (developer guide)](/development/index.html)
9+
* [Contribute to Elastic documentation](./contribute/index.html)
10+
* [Learn about migration to Elastic Docs V3](./migration/index.html)
11+
* [Configure content sets in V3](./configure/index.html)
12+
* [Learn about V3 syntax](./syntax/index.html)
13+
* [Contribute to V3 (developer guide)](./development/index.md)
1414

1515
## About this repo
1616

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Reference docs guidelines
3+
---
4+
5+
## Engineering ownership of reference documentation
6+
7+
As part of the transition to Elastic Docs v3, responsibility for maintaining reference documentation will reside with Engineering teams so that code and corresponding documentation remain tightly integrated, allowing for easier updates and greater accuracy.
8+
9+
After migration, all narrative and instructional documentation actively maintained by writers will move to the elastic/docs-content repository. Reference documentation, such as API specifications, will remain in the respective product repositories so that Engineering teams can manage both the code and its related documentation in one place.
10+
11+
## API documentation guidelines
12+
13+
To improve consistency and maintain high-quality reference documentation, all API documentation must adhere to the following standards:
14+
15+
* **Switch to OAS (OpenAPI specification)**: Engineering teams should stop creating AsciiDoc-based API documentation. All API documentation should now use OAS files, alongside our API documentation that lives at elastic.co/docs/api.
16+
* **Comprehensive API descriptions**: Ensure that OAS files include:
17+
* API descriptions
18+
* Request descriptions
19+
* Response descriptions
20+
* **Fix linting warnings**: Address all new and existing linting warnings in OAS files to maintain clean and consistent documentation.

docs/source/migration/codeowner.md renamed to docs/source/migration/freeze/codeowner.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: Documentation freeze CODEOWNERS
2+
title: Codeowner
33
---
44

55
This document lists the CODEOWNERS configuration used to enforce documentation freezes across Elastic repositories. During a documentation freeze, the `@docs-freeze-team` must approve any pull requests that modify documentation files (`.asciidoc`) before they can be merged. This prevents unintended documentation changes during crucial periods such as releases.
66

77
To regenerate this list, run the following commands from the repository root:
88

99
```sh
10-
cd docs/source/migration/scripts/codeowner-gen
10+
cd docs/source/migration/freeze/scripts/codeowner-gen
1111
python3 codeowner.py
1212
```
1313

docs/source/migration/gh-action.md renamed to docs/source/migration/freeze/gh-action.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Documentation Freeze GH Action
2+
title: GH Action
33
---
44

55
## Overview
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Documentation Freeze
3+
---
4+
5+
During the documentation freeze, the Docs team will focus almost entirely on migration tasks to ensure all content is successfully migrated and will handle only emergency documentation requests and release-related activities. When the migration is complete, writers will address documentation requests needed during the documentation freeze, ensuring that updates align with the new information architecture and format.
6+
7+
To make the transition to Elastic Docs v3 as smooth as possible, we’ve established a process to track and manage documentation requests during the migration:
8+
9+
* Open an issue in [elastic/docs-content](https://github.com/elastic/docs-content/issues), including details about the documentation requirements, links to resources, and drafts of documentation in GDocs.
10+
* Post in [#docs](https://elastic.slack.com/archives/C0JF80CJZ) for emergency documentation requests.
11+
12+
During the documentation freeze, maintaining consistency and avoiding conflicts is key. To prevent documentation changes from merging during the documentation freeze, [CODEOWNERS](./codeowner.md) and a [GH Action](./gh-action.md) are being added to /docs directories for public-facing documentation in all relevant repositories.
File renamed without changes.

0 commit comments

Comments
 (0)