Contribute on the web
Learn how to make documentation updates directly in your browser without setting up a local development environment.
If you're working in GitHub Codespaces or github.dev, you can install the Elastic Docs Utilities extension to simplify the authoring experience.
For content hosted on elastic.co/docs, most conceptual and narrative content is stored in the docs-content repository, and most reference content is hosted in the relevant product's repository.
To make quick edits to a single page:
Navigate to the documentation page that needs updates.
Click the Edit this page button. This opens the file in GitHub's editor.
Make your changes in the editor.
Click Commit changes.
Write a clear, verb-focused commit message describing your changes.
Select Propose changes. This takes you to the pull request creation page where you can edit the description if necessary.
Select Create pull request to submit your changes.
An Elastician will review, merge, and propagate your change to the right places for publication.
For more details on editing files on GitHub, refer to GitHub's documentation on editing files.
Some repositories use a tagged branching strategy, 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.
For detailed backporting guidance, refer to the example in Choose the docs branching strategy for a repository.
To determine the published branches for a repository, find the repository in assembler.yml.
If you need to contribute to elastic.co/guide pages, refer to Contribute to elastic.co/guide (Asciidoc) to learn about the Asciidoc system.