Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 11 additions & 24 deletions docs/guides/contribute/beginners.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: First Time Contributors Guide
author: Grammaresque
author: Krista Burdine
contributors: Ezequiel Bruni
tags:
- contributing
Expand All @@ -9,65 +9,54 @@ tags:
- howto
---

# First time contributors guide
# First-Time Contributor Guide

_Everybody starts somewhere. If this is the first time you’ve contributed to open-source documentation on GitHub, congratulations for taking this step. We can’t wait to see what you have to say!_


## Git and GitHub

Learn the basics of GitHub with this 12-minute [Beginner’s Guide to Git and GitHub](https://www.udacity.com/blog/2015/06/a-beginners-git-github-tutorial.html) from Udemy.
All of our contributor instructions presuppose you have a GitHub account. If you have never done that, now is the time. If you have 12 minutes, learn the basics of what GitHub is with the [Beginner’s Guide to Git and GitHub](https://www.udacity.com/blog/2015/06/a-beginners-git-github-tutorial.html) from Udemy.

You may not start out creating and managing repositories for Rocky Linux, but this [Hello World tutorial](https://docs.github.com/en/get-started/quickstart/hello-world) walks you through creating a GitHub account, learning the lingo, and understanding how repositories work. Focus on learning how to make and Commit updates to existing docs, and how to create a Pull Request.


## Markdown

Markdown is an easy language that allows you to include formatting, code, and plain text in the same file. The first time you update a document, just follow the existing code. It won’t be long before you are ready to explore additional features. When the time comes, here’s are the basics.


Markdown is an easy language that allows you to include formatting, code, and plain text in the same file. The first time you update a document, just follow the existing code. It won’t be long before you are ready to explore additional features. When the time comes, here are the basics.

* [Basic Markdown](https://www.markdownguide.org/basic-syntax#code)
* [Basic Markdown](https://www.markdownguide.org/basic-syntax#code)
* [Extended Markdown](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks)
* Some of the more [advanced formatting](https://docs.rockylinux.org/guides/contribute/rockydocs_formatting/) options we use in our repository


## Local Repository Editor

To create a local repository, first find and install a Markdown editor that works with your computer and operating system. Here are some options, but there are others. Use what you know.

[ReText](https://github.com/retext-project/retext) - Free, cross-platform, and open source

[Zettlr](https://www.zettlr.com/) - Free, cross-platform, and open source

[Mark Text](https://github.com/marktext/marktext) - Free, cross-platform, and open source

[Remarkable](https://remarkableapp.github.io/) - Linux and Windows, open source

[NvChad](https://nvchad.com/) for the vi/vim user and the nvim client. A lot of plugins are available to enhance the editor for markdown. See [this document](https://docs.rockylinux.org/books/nvchad/) for a nice set of installation instructions.

[VS Code](https://code.visualstudio.com/) - Partially open source, by Microsoft. VS Code is a lightweight and powerful editor available for Windows, Linux and MacOS. To contribute to this document project, you should get the following extensions: Git Graph, HTML Preview, HTML Snippets, Markdown All in One, Markdown Preview Enhanced, Markdown Preview Mermaid Support, and any more that catch your fancy.

## Create a local repository

Once you have a Markdown editor installed, follow instructions to connect it to your GitHub account and download your repository to your local machine. Every time you prepare to update a document, follow these steps to sync your local and online forks with the main branch to ensure you are working with the most current version:

1. Within GitHub, sync your fork of the documentation repository with the main branch.
1. Within GitHub, sync your fork of the documentation repository with the main branch.
2. Follow your Markdown editor’s instructions to sync your current fork with your local machine.
3. Inside your Markdown editor, open the document you wish to modify.
4. Modify the document.
5. Save.
6. Commit your changes within your editor, which should sync your local repository with your online fork.
7. Within GitHub, find the updated document in your fork and create a Pull Request to merge it with the main document.


## Submit an update

_Add a missing word, correct an error, clarify a confusing bit of text._

1. Start on the page you want to update.
1. Start on the page you want to update.

Click the “Edit” pencil in the upper right corner of the document you want to update. You will be taken to the original document on GitHub.
Click the “Edit” pencil in the upper right corner of the document you want to update. You will be taken to the original document on GitHub.

The first time you contribute to the RL repository, you will be prompted with a green button to “**Fork** this **repository** and propose changes.” This creates a duplicate copy of the RL repository where you make your suggested edits. Simply click the green button and continue.

Expand All @@ -79,13 +68,13 @@ Follow the Markdown formatting. Perhaps there’s a missing word, or the link on

At the bottom of the page, write a one-line description in the title of the block entitled, “**Propose changes”**. It is helpful, but not necessary, to reference the file name found at the top of the doc.

So, if you updated a link within line 21 of the markdown text, you’d say something like, "Update README.md with correct links."
So, if you updated a link within line 21 of the markdown text, you’d say something like, "Update README.md with correct links."

**Note: Word your action in the present tense.**
**Note: Word your action in the present tense.**

Then click Propose changes, which will **Commit** your changes to a complete document within your forked repository.

4. Review changes
4. Review changes

Now you can look at what you’ve done, line by line. Did you miss anything? Back up to the previous page and correct it again (you’ll have to start over), then click Propose Changes again.

Expand All @@ -101,8 +90,6 @@ Click the big green button that says Create Pull Request. Good news, you still h

Once the RL team gets your request, they will respond in one of three ways.



* Accept and merge your PR
* Comment with feedback and ask for changes
* Deny your PR with explanation
Expand Down