Contributors Guide

Improvements to Tackle documentation are welcome.

Read the [Guidelines for Red Hat Documentation](https://redhat-documentation.github.io/) before opening a pull request.

Use the following steps to create a pull request for the Tackle documentation repository.

Fork the tackle-documentation GitHub repository.

Click the Fork button in the top right corner of the page.

Clone the forked repository locally.

$ git clone git@github.com:YOUR_USERNAME/tackle-documentation.git

Add the upstream repository.

git remote add -f upstream git@github.com:tackle-documentation.git

Check out a topic branch.

$ git checkout -b BRANCH_NAME upstream/main

Make the desired edits.

The documentation is written in AsciiDoc. Review the AsciiDoc Guidelines and Tips section of this guide before making changes.
Build the guides to verify your changes.
1. Navigate to the appropriate guide’s directory and issue the following command. Note that you must have Asciidoctor installed.
  $ cd documentation/<document> $ asciidoctor -t -dbook -a toc -o html master.adoc
2. View the generated HTML file in a browser.
Add each new or updated file to git.
```
$ git add FILE_NAME.adoc
```
Commit the changes locally.
```
$ git commit -m "My commit message."
```
Push the changes to your forked repository.
```
$ git push origin HEAD
```
Open a pull request to merge your changes to the master branch.
1. Navigate to your forked repository in a browser: https://github.com/YOUR_USERNAME/konveyor/tackle-documentation.
2. Open a new pull request. Be sure to review the diff before submitting.
3. A member of the Tackle documentation team will merge or provide feedback on your request.

Building the Guides

Navigate to the appropriate guide’s directory and issue the following command. Note that you must have Asciidoctor installed.

$ cd documentation/<document>
$ asciidoctor -t -dbook -a toc -o html master.adoc

View the generated HTML file in a browser.

The Tackle guides are published downstream on the Red Hat Customer Portal.