Contributing to Lookyloo Documentation

You can contribute by:

  • Raising an issue you find in the documentation

  • Fixing issues by opening a pull request

  • Improving documentation

Contributor Behavior

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language

  • Focusing on what is best for the community

  • Being respectful of differing viewpoints and experiences

  • Gracefully accepting constructive criticism

Before You Begin

  • Get started by installing and getting familiar with Git.

  • Use AsciiDoc to contribute to Lookyloo documentation.

  • Refer to our style guide for guidance on formatting your documentation contributions.

General Information

Thank you for your contributions. To start contributing to Lookyloo:

  1. Create an issue describing your proposed change to the repository.

  2. The repository owners will triage and respond to your issue promptly.

  3. Fork the repository.

  4. Submit a pull request with the proposed changes. The required format for the Git commit message is "Issue # <Issue ID> - <issue_message>".

Raising an Issue

GitHub issues can be used to report bugs or submit feature requests.

When reporting an issue, you can use the issues template.

Updating Documentation

The documentation is written in the Asciidoc markup language and uses Antora.

The source documentation files are located in the modules/ROOT/pages/ directory in the Lookyloo documentation repository.


The following are required:


To update existing documentation:

  1. Checkout the branch you want to update, for example:

    git checkout main
  2. Ensure that your forked repository is in sync with the selected upstream repository:

    git fetch <lookyloo/docs>
    git reset --hard <lookyloo/docs> main
  3. Checkout a new feature branch with the <Issue #> as the name, for example:

    git checkout -b Issue#123
  4. Make changes to the documentation.

    To add a new module to the repository, add the module to the /modules/ROOT/nav.adoc file in the following format:

    * xref:<module_filename.adoc>[<module title>].

    The number of asterisks (*) denotes the heading level.

  5. Preview the documentation on the branch.

  6. Push the changes to your fork’s feature branch.

  7. Submit a pull request against to the dsignated repository.

Previewing Documentation Changes

  1. To build a preview of the doc, run the command:

    antora local-site.yml && <your_preferred_browser> build/site/index.html

Rendering Documentation

  1. Run the ./ script.

  2. Run $<browser> index.html to review the generated content.

  3. Submit a pull request against the desired Lookyloo repository.