evergreen-docs:how-to-contribute-documentation
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revision | |||
| evergreen-docs:how-to-contribute-documentation [2023/06/01 12:13] – update branch name from master to main gmcharlton | evergreen-docs:how-to-contribute-documentation [2025/07/25 15:46] (current) – [Intermediate workflow] smorrison | ||
|---|---|---|---|
| Line 30: | Line 30: | ||
| ==== Intermediate workflow ==== | ==== Intermediate workflow ==== | ||
| - | - Login to GitHub (or create a free account) | + | - Login to GitHub (or create a free account). |
| - | - Find the relevant file in the [[https:// | + | - Find the relevant file in the [[https:// |
| - | * Look around until you find the content (note: the directories are mostly logically similar to the online docs table of contents sections, but may require some searching around) | + | * The directories are mostly logically similar to the online docs table of contents sections, but may require some searching around. You can also use the search bar above the modules ("Go to file") to find the file based off of the URL. The file name will be the same as the end of the URL but with " |
| - | - Click the pencil ("Edit this file") icon to edit the file in your browser **OR** If you are creating a new file, click the Add File button. Type in the file name. Make sure you are in the correct directory. | + | - Once on the page, click the pencil ("Edit this file") icon to edit the file in your browser **OR** If you are creating a new file, click the Add File button. Type in the file name. Make sure you are in the correct directory. |
| - Make your changes, using [[http:// | - Make your changes, using [[http:// | ||
| - **Test that your AsciiDoc syntax is correct.** This is not required for simple typo corrections. | - **Test that your AsciiDoc syntax is correct.** This is not required for simple typo corrections. | ||
| * PREVIEW as HTML: Any file on GitHub with the extension of " | * PREVIEW as HTML: Any file on GitHub with the extension of " | ||
| * Note that there is now an automatic checker in github that will build a test copy of your docs. Instructions on that are below. | * Note that there is now an automatic checker in github that will build a test copy of your docs. Instructions on that are below. | ||
| - | - Type a message describing your change | + | |
| - | - Click the "Propose | + | - In the pop-up that appears, type in a commit message title with " |
| - | - Click the green "Create pull request" | + | |
| - | - One of the developers will [[evergreen-docs: | + | - Click **Propose |
| + | - You will be led to a **Comparing changes** screen, where you can see the original text lines in red and the changed lines in green. | ||
| + | - Click the green **Create pull request** button. | ||
| + | - Click **Create pull request** again. | ||
| + | - If the change is related to a bug in Launchpad, copy the URL of the pull request and paste it as a comment in the bug report. | ||
| + | - One of the developers will [[evergreen-docs: | ||
| + | |||
| + | If you would like to include changes across multiple pages within one pull request, once you have completed step 12: | ||
| + | - Click **Code** at the top left of the screen. | ||
| + | - Click on the link of the patch. | ||
| + | - Repeat steps 3 to 12 above. | ||
| + | - Make sure " | ||
| + | - Click **Commit changes**. | ||
| + | - Click **Code**. | ||
| + | - Go back to main repository. | ||
| + | - Click **Compare & pull request**. | ||
| + | - Update title (you sill see the other pull requests listed below in the Commits list). | ||
| + | - Click **Create pull request** again if all changes done. | ||
| A variation of this workflow is described [[https:// | A variation of this workflow is described [[https:// | ||
| - | An alternative of the above workflow using GitHub Desktop is [[https:// | + | An alternative of the above workflow using GitHub Desktop is [[https:// |
| === Automatic build checker === | === Automatic build checker === | ||
evergreen-docs/how-to-contribute-documentation.txt · Last modified: 2025/07/25 15:46 by smorrison