Skip to content

Commit 942577b

Browse files
committed
restore how-to guides into contribute folder, update navigation and all internal links, remove problematic redirects.
1 parent cbacb4c commit 942577b

File tree

16 files changed

+40
-50
lines changed

16 files changed

+40
-50
lines changed

docs/_docset.yml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,22 +29,23 @@ toc:
2929
- file: index.md
3030
- hidden: 404.md
3131
- hidden: developer-notes.md
32-
- hidden: contribute/index.md
33-
- hidden: contribute/locally.md
34-
- hidden: contribute/on-the-web.md
35-
- hidden: contribute/cumulative-docs/index.md
36-
- hidden: contribute/cumulative-docs/guidelines.md
37-
- hidden: contribute/cumulative-docs/badge-placement.md
38-
- hidden: contribute/cumulative-docs/example-scenarios.md
39-
- hidden: contribute/cumulative-docs/reference.md
40-
- folder: how-to
32+
- folder: contribute
4133
children:
4234
- file: index.md
4335
- file: move.md
4436
- file: redirects.md
4537
- file: branching-strategy.md
4638
- file: add-repo.md
4739
- file: release-new-version.md
40+
- hidden: locally.md
41+
- hidden: on-the-web.md
42+
- folder: cumulative-docs
43+
children:
44+
- hidden: index.md
45+
- hidden: guidelines.md
46+
- hidden: badge-placement.md
47+
- hidden: example-scenarios.md
48+
- hidden: reference.md
4849
- folder: building-blocks
4950
children:
5051
- file: index.md

docs/_redirects.yml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
redirects:
2-
'contribute/move.md': 'index.md'
3-
'contribute/redirects.md': 'index.md'
4-
'contribute/branching-strategy.md': 'index.md'
5-
'contribute/add-repo.md': 'index.md'
6-
'contribute/release-new-version.md': 'index.md'
72
'migration/freeze/gh-action.md' : 'index.md'
83
'migration/freeze/index.md' : 'index.md'
94
'testing/redirects/4th-page.md': 'testing/redirects/5th-page.md'

docs/building-blocks/assembled-documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The assembler:
1919

2020
Assembled documentation is configured through the site configuration, which defines:
2121

22-
* [assembler.yml](../configure/site/index.md): Which repositories to include and [their branching strategy](../how-to/branching-strategy.md).
22+
* [assembler.yml](../configure/site/index.md): Which repositories to include and [their branching strategy](../contribute/branching-strategy.md).
2323
* [navigation.yml](../configure/site/index.md): Navigation and url prefixes for TOC's.
2424
* [versions.yml](../configure/site/versions.md): Defines the various versioning schemes of products/solutions being documented.
2525
* [products.yml](../configure/site/products.md): Defines the product catalog (id, name) and ties it to a specific versioning scheme.

docs/cli/docset/diff-validate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Gathers the local changes by inspecting the git log, stashed and unstashed chang
44

55
It currently validates the following:
66

7-
* Ensures that renames and deletions are reflected in [redirects.yml](../../how-to/redirects.md).
7+
* Ensures that renames and deletions are reflected in [redirects.yml](../../contribute/redirects.md).
88

99
## Usage
1010

docs/cli/docset/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ locate the `docset.yml` anywhere in the directory tree automatically and build t
2222
## Refactor commands
2323

2424
- [mv](mv.md) - move a file or folder to a new location. This will rewrite all links in all files too.
25-
- [diff validate](diff-validate.md) - validate that local changes are reflected in [redirects.yml](../../how-to/redirects.md)
25+
- [diff validate](diff-validate.md) - validate that local changes are reflected in [redirects.yml](../../contribute/redirects.md)
2626

docs/configure/site/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Configure the documentation site in these files:
1414

1515
## Redirects
1616

17-
Redirects are also configured at the site-level. See [](../../how-to/redirects.md) for more information.
17+
Redirects are also configured at the site-level. See [](../../contribute/redirects.md) for more information.
1818

1919
## Synonyms
2020

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:::{warning}
2-
Some repositories use a [tagged branching strategy](/how-to/branching-strategy.md), which means that their docs are published from a branch that is not `main` or `master`. In these cases, documentation changes need to be made to `main` or `master`, and then backported to the relevant branches.
2+
Some repositories use a [tagged branching strategy](/contribute/branching-strategy.md), which means that their docs are published from a branch that is not `main` or `master`. In these cases, documentation changes need to be made to `main` or `master`, and then backported to the relevant branches.
33

4-
For detailed backporting guidance, refer to the example in [Choose the docs branching strategy for a repository](/how-to/branching-strategy.md#workflow-2-tagged).
4+
For detailed backporting guidance, refer to the example in [Choose the docs branching strategy for a repository](/contribute/branching-strategy.md#workflow-2-tagged).
55

66
To determine the published branches for a repository, find the repository in [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/config/assembler.yml).
77
:::

docs/how-to/add-repo.md renamed to docs/contribute/add-repo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ references:
5959
```
6060

6161
:::{tip}
62-
In this file, you can optionally specify custom branches to deploy docs from, depending on your preferred [branching strategy](/how-to/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.
6363
:::
6464

6565
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.
File renamed without changes.

docs/contribute/index.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
1+
# How-to guides
12

2-
# Contribute to docs
3-
4-
:::{note}
5-
👋 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.
65
:::
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.

0 commit comments

Comments
 (0)