Skip to content

Commit 8737184

Browse files
update contributing on the web docs (#474)
* update contributing on the web docs * updates to bookmarks * Update docset.yml * Update on-the-web.md * Update on-the-web.md --------- Co-authored-by: Martijn Laarman <[email protected]>
1 parent 17660e1 commit 8737184

File tree

2 files changed

+52
-4
lines changed

2 files changed

+52
-4
lines changed

docs/contribute/on-the-web.md

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,52 @@
11
# Contribute on the web
22

3-
1. On the right side of the page you want to edit, select **Edit this page**.
4-
1. Do something on GitHub.
5-
1. Take the dog for a walk.
6-
1. Success!
3+
This section will help you understand how to update and contribute to our documentation post-migration.
4+
5+
## **Updating Documentation**
6+
7+
Depending on the version that your update impacts you may need to take different steps.
8+
9+
### **Update content for Version 8.x and earlier** [update-content-for-version-8.x-and-earlier]
10+
11+
For content that is related to 8.x, these changes should be done in the original source folders in their respective repositories. Here’s how you can do it:
12+
13+
1. Navigate to the page that is impacted
14+
2. Click the **edit** button
15+
3. Ensure the targeted branch is \<insert proper branch\>
16+
4. Make the necessary updates.
17+
5. Commit your changes and create a pull request.
18+
6. Add the appropriate labels per repo as found at [Page: Working across docs repos](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/61604182/Working+across+docs+repos)
19+
20+
Note: If you are working in a repo like Kibana or the cloud repo where backports can be complicated. You can use the [backport tool](https://github.com/sorenlouv/backport) to manage your backport.
21+
22+
### **Update content for Version 9.0 and later** [update-content-for-version-9.0-and-later]
23+
24+
For content related to version 9.0 and future versions, updates should be made in the [`docs-content`](https://github.com/elastic/docs-content) repository. Follow these steps to ensure your contributions are correctly made:
25+
26+
1. Navigate to the page that is impacted
27+
2. Click the **Edit** button.
28+
3. Identify the section that requires updates.
29+
4. Make the necessary updates.
30+
5. Commit your changes and create a pull request.
31+
32+
33+
## **What if I need to update both 8.x and 9.x docs?**
34+
35+
If you need to merge changes that relate to version 8.x to the 9.0 and later documentation it is recommended to update the 9.x documentation first in markdown. Then you can convert the updates to asciidoc and make the changes to the 8.x documentation. To do this, follow these steps:
36+
37+
1. Install [pandoc](https://pandoc.org/installing.html) to convert your markdown file to asciidoc
38+
2. Update the content 9.x first in markdown as described in [Version 9.0 and Later](#update-content-for-version-9.0-and-later) in the [`docs-content`](https://github.com/elastic/docs-content) repository
39+
3. Run your changes through pandoc
40+
1. If you need to bring over the entire file you can run the following command and it will create an asciidoc file for you. `pandoc -f gfm -t asciidoc ./<file-name>.md -o <file-name>.asciidoc`
41+
2. If you just need to port a specific section you can use: `pandoc -f gfm -t asciidoc ./<file-name>.md` and the output of the file will be in your command window from which you can copy.
42+
4. Follow the steps in [Update content for Version 8.x and earlier](#update-content-for-version-8.x-and-earlier) to publish your changes.
43+
5. If the change is too large or complicated, create a new issue in the [`docs-content`](https://github.com/elastic/docs-content) repository detailing the changes made for the team to triage.
44+
6. Merge the changes and close the issue once the updates are reflected in the [`docs-content`](https://github.com/elastic/docs-content) repository.
45+
46+
## **Migration Considerations**
47+
48+
During the migration, content may be moved around, and there won't be a 1-to-1 mapping between old and new locations. This means updates may need to be applied in multiple places. If your changes affect version 8.x content, consider merging those changes in the 9.x content first and then add it to the appropriate 8.x content. If you have any issues create an issue in the [`docs-content`](https://github.com/elastic/docs-content) repository.
49+
50+
% To be added “Kibana and Cloud repository instructions. You need to target main to backport. Changes in main will be lost and you need to recreate it in the new architecture after the freeze is over.
51+
52+
% Need a good category mapping across the content .. not to the file level for area level

docs/docset.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ external_hosts:
2020
- commonmark.org
2121
- github.io
2222
- github.com
23+
- pandoc.org
24+
- atlassian.net
2325
- elastic.dev
2426
- visualstudio.com
2527
exclude:

0 commit comments

Comments
 (0)