Skip to content

Commit 730c8a9

Browse files
authored
[docs] [chore] clean up after migrating some contribution, syntax guide (#2168)
1 parent 0df3bcc commit 730c8a9

File tree

10 files changed

+46
-691
lines changed

10 files changed

+46
-691
lines changed

docs/_docset.yml

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,21 @@ toc:
2929
- file: index.md
3030
- hidden: 404.md
3131
- hidden: developer-notes.md
32+
- hidden: contribute/cumulative-docs/index.md
33+
- hidden: contribute/cumulative-docs/guidelines.md
34+
- hidden: contribute/cumulative-docs/badge-placement.md
35+
- hidden: contribute/cumulative-docs/example-scenarios.md
36+
- hidden: contribute/cumulative-docs/reference.md
3237
- folder: contribute
3338
children:
3439
- file: index.md
35-
- file: locally.md
36-
- file: on-the-web.md
3740
- file: move.md
3841
- file: redirects.md
39-
- folder: cumulative-docs
40-
children:
41-
- file: index.md
42-
- hidden: guidelines.md
43-
- hidden: badge-placement.md
44-
- hidden: example-scenarios.md
45-
- hidden: reference.md
4642
- file: branching-strategy.md
4743
- file: add-repo.md
4844
- file: release-new-version.md
45+
- hidden: locally.md
46+
- hidden: on-the-web.md
4947
- folder: building-blocks
5048
children:
5149
- file: index.md

docs/_redirects.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ redirects:
2323
"yy": "bb"
2424
'testing/redirects/third-page.md':
2525
anchors:
26-
'removed-anchor':
26+
'removed-anchor':

docs/building-blocks/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
navigation_title: Building blocks
2+
navigation_title: Core architecture concepts
33
---
44

5-
# Building blocks
5+
# Core architecture concepts and building blocks
66

77
This section explains the core concepts and building blocks that make up the docs-builder architecture. Understanding these concepts will help you work effectively with distributed documentation and cross-repository linking.
88

docs/contribute/add-repo.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
navigation_title: "Add a new repo to the docs"
3+
---
4+
15
# Add a new repository to the docs
26

37
Elastic documentation is built from many assembled repositories using `docs-builder assemble`. Adding a new repository requires making the assembly process aware of its existence.
@@ -55,7 +59,7 @@ references:
5559
```
5660

5761
:::{tip}
58-
In this file, you can optionally specify custom branches to deploy docs from, depending on your preferred [branching strategy](/contribute/branching-strategy.md). You might want to change your branching strategy so you can have more control over when content added for a specific release is published.
62+
In this file, you can optionally specify custom branches to deploy docs from, depending on your preferred [branching strategy](branching-strategy.md). You might want to change your branching strategy so you can have more control over when content added for a specific release is published.
5963
:::
6064

6165
Then, edit the [`navigation.yml`](https://github.com/elastic/docs-builder/blob/main/config/navigation.yml) file to add the repository to the navigation. Refer to [navigation.yml](../configure/site/navigation.md) for more information.

docs/contribute/branching-strategy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
navigation_title: Choose a branching strategy
2+
navigation_title: Choose a repo branch strategy
33
---
44

55
# Choose the docs branching strategy for a repository

docs/contribute/index.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
1-
# Elastic Docs contribution guide
1+
# How-to guides
22

3-
:::{note}
4-
👋 This page has moved to [elastic.co/docs](https://www.elastic.co/docs/contribute-docs/).
3+
:::{tip}
4+
Looking for contribution guides on how to write the docs? Refer to [Contribute to docs](https://www.elastic.co/docs/contribute-docs/) on the main Elastic documentation site.
55
:::
6+
7+
Use these guides for tasks like managing documentation files and folders, configuring repositories, and handling releases.
8+
9+
## Manage files and links
10+
11+
- [Move files and folders](move.md): Move files or folders and automatically update all links in the documentation.
12+
- [Manage redirects across doc sets](redirects.md): Set up redirects when moving or deleting pages to prevent broken links.
13+
14+
## Repository management
15+
16+
- [Add a new repository to the docs](add-repo.md): Add a new docs repository to the assembly process.
17+
- [Choose a branching strategy](branching-strategy.md): Choose the right docs branching strategy for your repository.
18+
19+
## Release management
20+
21+
- [Release a new documentation version](release-new-version.md): Update the docs site when a new version of the Elastic Stack or other versioned product is released.

docs/contribute/redirects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
navigation_title: "Redirects"
2+
navigation_title: "Set up redirects"
33
---
44

55
# Manage redirects across doc sets

docs/contribute/release-new-version.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
navigation_title: Release a new docs version
3+
---
4+
15
# Release a new documentation version
26

37
When a new version of the Elastic Stack (or another versioned product) is released, the docs site must be updated to recognize it. This process primarily involves updating version metadata in the shared site configuration.

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Elastic Docs V3 is our next-generation documentation platform designed to improv
88

99
## What do you want to do today?
1010

11-
* [Contribute to Elastic documentation](./contribute/index.md)
12-
* [Learn about migration to Elastic Docs V3](./migration/index.md)
13-
* [Configure content sets in V3](./configure/index.md)
11+
* [Contribute to Elastic documentation](https://www.elastic.co/docs/contribute-docs/)
1412
* [Learn about V3 syntax](./syntax/index.md)
13+
* [Configure content sets in V3](./configure/index.md)
1514
* [Contribute to V3 (developer guide)](./development/index.md)
15+
* [Learn about migration to Elastic Docs V3](./migration/index.md)

0 commit comments

Comments
 (0)