Contributing⚓︎
Prerequisites:⚓︎
Occasional contributions:
- An account on GitHub
- Basic Knowledge of Markdown
- A text editor: Kate (already installed), Atom, VSCode, VIM, Emacs, etc.
For large contributions:
- Git on your local computer and the knowledge on how to use it. Git is a command line interface program and it has a number of GUI interfaces.
If you are new to Git or new to the command line we recommend using the Atom text editor. It's a beautiful and capable editor with a great GUI for Git and GitHub.
Note that there's a difference between Git and GitHub. Git is the Version Control System application that you run locally on your computer. It handles the source of the documentation that we write. It controls the main document base as well as your modifications; and merges your modifications with document base while keeping track of every change. GitHub is an online service to host the documentation and gives us a web GUI to collaboratively work on it.
Before Editing or adding new documentation⚓︎
TODO: Add internal links
If you intend to make minor edits or corrections, proceed with Editing on the GitHub site itself as described below, otherwise it is recommend to Edit using Git on your own.
If you are making a considerable edits or adding new pages consider coordinating with the Documentation Team, especially if you are new to the project. This will get you stared quickly and will ensure the acceptance of your contributions.
You can reach us in the following channels: - Make an issue in the GitHub Repository to discuss your contribution (Recommended). - Telegram - This is where we all hang out. Great for introductions and quick fire questions. - Discord - Same as Telegram. - Mailing list - The official communication channel.
Edit on the GitHub website⚓︎
Ref: https://docs.fedoraproject.org/en-US/fedora-docs/contributing/contributing-to-existing-docs/
TODO: write this section
- Fork
- Branch
- Edit
- Commit
- Pull request
Edit using Git on your computer⚓︎
Ref: https://docs.fedoraproject.org/en-US/fedora-docs/contributing/git/
TODO: write this section
- Fork on GitHub
- Pull
- Branch
- Edit
- Commit
- Push branch
- Pull request on GitHub
Using Mkdocs on your local computer⚓︎
TODO: expand this section
This will give you the best experience as it provides you with a live preview of the documentation as you write it with all the markdown and special mkdocs formatting that we use. You have to use the "Using Git on your local computer" method and while editing launch the mkdocs local server