From c70dd65bfb53bd2442cbff133fbed441e96615a7 Mon Sep 17 00:00:00 2001 From: Steven Spencer Date: Wed, 4 Jan 2023 19:10:43 -0600 Subject: [PATCH] Add new child documents to .pages and fix some formatting issues * added `beginners.md` and `createnew.md` to the `.pages` file for /docs/guides/contribute/ to fix them not displaying * made changes to the meta formatting, which will allow the titles to display correctly as well as the tags * changed the header levels so that there was 1 level 1 heading and the rest were level 2 --- docs/guides/contribute/.pages | 2 ++ docs/guides/contribute/beginners.md | 17 ++++++++--------- docs/guides/contribute/createnew.md | 13 ++++++------- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/guides/contribute/.pages b/docs/guides/contribute/.pages index 650ecb29ce..e225930584 100644 --- a/docs/guides/contribute/.pages +++ b/docs/guides/contribute/.pages @@ -1,6 +1,8 @@ --- nav: - ... | README*.md + - ... | beginners*.md + - ... | createnew*.md - ... | rockydocs_web_dev*.md - ... | mkdocs_lsyncd*.md - ... | local_docs*.md diff --git a/docs/guides/contribute/beginners.md b/docs/guides/contribute/beginners.md index 17d4f92c6b..618cd4fa1b 100644 --- a/docs/guides/contribute/beginners.md +++ b/docs/guides/contribute/beginners.md @@ -1,5 +1,4 @@ - - -## First time contributors guide +# First time contributors 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 +## 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. 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 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. @@ -33,7 +32,7 @@ Markdown is an easy language that allows you to include formatting, code, and pl * Some of the more [advanced formatting](https://docs.rockylinux.org/guides/contribute/rockydocs_formatting/) options we use in our repository -### Local Repository Editor +## 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. @@ -49,7 +48,7 @@ To create a local repository, first find and install a Markdown editor that work [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 +## 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: @@ -62,7 +61,7 @@ Once you have a Markdown editor installed, follow instructions to connect it to 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 +## Submit an update _Add a missing word, correct an error, clarify a confusing bit of text._ diff --git a/docs/guides/contribute/createnew.md b/docs/guides/contribute/createnew.md index b0520aa934..0ad750a54f 100644 --- a/docs/guides/contribute/createnew.md +++ b/docs/guides/contribute/createnew.md @@ -1,19 +1,18 @@ - - -## Create a new document +# How To Create a New Document in GitHub _When you are ready to submit your original written documentation for approval, follow these easy steps:_ -### With the GitHub GUI +## With the GitHub GUI You can complete almost all tasks from the web GUI on GitHub. Here's an example of adding a file you've created on your local machine to the Rocky Linux documentation GitHub repository. @@ -30,7 +29,7 @@ You can complete almost all tasks from the web GUI on GitHub. Here's an example 9. Write a brief message in the "Write" section letting the administrators know what you've done. (New document, revision, suggested change, etc.,) then submit your change. -### From the Git Command-Line +## From the Git Command-Line If you prefer to run Git locally on your machine, you can clone the [Rocky Linux Documentation](https://github.com/rocky-linux/documentation) repository, make changes, and then commit changes afterward. To make things simple, execute steps 1-3 using the **With the GitHub GUI** approach above, then: