Contributing to Keycloak

Format: AsciiDoc for a Maven-built docs site · Client: Red Hat / Keycloak · Year: 2024

A contributor guide that teaches newcomers how to submit documentation changes to Keycloak with git and GitHub. It is included to show a different source format — AsciiDoc — and a different problem: writing for contributors who may be new to Git, so each command comes with the reason to run it. The original AsciiDoc source shows the markup; the excerpt below is the rendered result.

View the original source (AsciiDoc)

Excerpt:

There are two ways to start. The first is the easiest, but it is less flexible. The second is more powerful, but requires setting up. For either method, you must already have a GitHub account.

Simple and Infrequent Contributions (Method One)

This method is useful for quick fixes or simple additions.

1. Find the file you want to edit in the GitHub web interface.
2. Click the file name to open it in GitHub.
3. Click the edit icon near the top right of the page contents. The icon looks like a pencil.
4. Make your edits.
5. Enter a title and description of your changes in the Commit Changes section at the bottom of the page. Enter enough detail for reviewers to know what you have changed and why.
6. Select Create a new branch for this commit and start a pull request.
7. Click Commit changes.

Excerpt from the Keycloak “Contributor’s Guide.” Back to all writing samples.