Page History

Preview the Besu documentation with MkDocs on your local machine and on Read the Docs.

Preview locally¶

We recommend previewing your work locally before pushing your changes in a PR. Since the final documentation is built with MkDocs, you must build the documentation locally with MkDocs to ensure the Markdown is correctly rendered. To preview the documentation locally:

1. Install Python 3.

2. Create a virtual environment for the project:

   • python3 -m venv env

3. Activate the virtual environment:

   • source env/bin/activate

     
     

   • An (env) now appears at the beginning of your prompt.

4. Install all the required dependencies in this virtual environment:

   • pip install -r common/build_tools/requirements.txt

5. Run the following command in the project directory:

   • mkdocs serve

6. In the output of this command, follow the link displayed on the line that looks like the following:

   • [I 190206 18:48:47 server:298] Serving on http://127.0.0.1:8000

     
     

   • In this case, go to http://127.0.0.1:8000. You can let this server run while you work on the documentation. It updates the local website automatically when you save changes in your Markdown files.

7. Deactivate the virtual environment if you work on another Python project, by running deactivate. You can preview the same documentation site again starting from step 3 and skipping step 4, until you update Python.

Preview on Read the Docs¶

When you create a PR on a documentation repository, the PR triggers CircleCI checks to verify links, Markdown syntax, writing style, and more. The documentation is also built on Read the Docs (RTD) as a PR preview.

You can find the link to this preview in the checklist at the bottom of your PR page. The preview only works for registered and permitted RTD users. Ask for help on Discord if needed.

Image Added

Thanks for taking the time to contribute to the docs!

Welcome to the documentation section of the Besu wiki!
The following links are a set of guidelines for contributing to this repo. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this wiki page.

Documentation contributions come in the form of writing new documentation, raising issues with the current docs, correcting mistakes, helping others in chat with doc content and more.

LF Accounts

Having the following accounts is necessary for contributing to besu-docs.

• If you want to contribute documentation/code, you can make a Linux Foundation (LF) account here.
• If you want to raise an issue, you can login to your Atlassian account here.

Useful contributing links

• I just have a quick question

• First contribution workflow

• Did you find a bug?

• Issues

• DCO is also needed for Besu docs (as for Besu code)

• Suggesting Enhancements

• Pull Requests - the same process is used for Besu code and Besu docs

• Code Reviews - again, the same process is used for Besu code and Besu docs

Still no luck?

Still unsure of where to start, even after looking at our good-first-issues and help-wanted tags in our issue dashboard?

...