Contribute on the web
This section will help you understand how to update and contribute to our documentation post-migration.
Depending on the version that your update impacts you may need to take different steps.
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:
- Navigate to the page that is impacted
- Click the edit button
- Ensure the targeted branch is <insert proper branch>
- Make the necessary updates.
- Commit your changes and create a pull request.
- Add the appropriate labels per repo as found at Page: Working across docs repos
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 to manage your backport.
For content related to version 9.0 and future versions, updates should be made in the docs-content
repository. Follow these steps to ensure your contributions are correctly made:
- Navigate to the page that is impacted
- Click the Edit button.
- Identify the section that requires updates.
- Make the necessary updates.
- Commit your changes and create a pull request.
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:
- Install pandoc to convert your markdown file to asciidoc
- Update the content 9.x first in markdown as described in Version 9.0 and Later in the
docs-content
repository - Run your changes through pandoc
- 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
- 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.
- If you need to bring over the entire file you can run the following command and it will create an asciidoc file for you.
- Follow the steps in Update content for Version 8.x and earlier to publish your changes.
- If the change is too large or complicated, create a new issue in the
docs-content
repository detailing the changes made for the team to triage. - Merge the changes and close the issue once the updates are reflected in the
docs-content
repository.
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
repository.