How do I edit the website?

There are two ways to edit the website:

  • Directly on the GitHub website

  • In local repositories

All contributions are licensed under the Apache Software License version 2.0

Directly on the GitHub website

The website pages can be edited on the GitHub website. It’s a very quick process and ideal for fixing typos or updating information.

Steps to edit a file:

  1. Go to the page you want to edit.

  2. Look for a link called "Edit this Page" and click on it.

  3. Edit the file.

  4. Preview your changes.

  5. Provide a title and description for your pull request.

  6. Click on the "Propose file change" button.

In local repositories

To edit files locally, it’s important to understand how the website is generated and where the files are located. The site generator is located in its own repository. The documentation is located in the main Apache Camel repository and sub-project repositories, such as Camel-K and Camel Quarkus. Have a look at the How does the website work? page for more details.

Steps to edit a file:

  1. Fork and clone the site generator repository and the Camel repository that contains the documentation you want to change.

  2. Follow the build instructions located in the site generator’s README file.

  3. Open Antora’s antora-playbook.yml configuration file and change the content sources to local repositories.

  4. Edit the file.

  5. Build the website.

  6. Preview your changes locally.

  7. Revert changes to antora-playbook.yml.

  8. Push your changes to your forked repositories and send a pull request.

It’s a good idea to spend some time and learn how Antora and Hugo work.
Back to top