Skip to content

Commit

Permalink
Update 2.0_use_and_contribute_to_teampsd_manual.md
Browse files Browse the repository at this point in the history
Added further information about Spell Checker, Link Checker, merging a pull request, and deleting a feature branch.
  • Loading branch information
ljmoody committed Nov 22, 2024
1 parent 614afbb commit 01e7c75
Showing 1 changed file with 62 additions and 4 deletions.
66 changes: 62 additions & 4 deletions 2.0_use_and_contribute_to_teampsd_manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,11 +173,45 @@ There are several editor actions that will screen your documents for proper form

- The **Spell Checker** checks for spelling errors or unknown acronyms in your commit and its associated files. This check usually passes with no errors. If the spell checker throws an error, you may need to either 1) correct a spelling mistake in your document or 2) add it to Team PSD's custom dictionary file the Spell Checker uses.

> Screenshot w/callouts to be developed.
Click the caret next to Spell Checker to reveal the spelling errors found. In the image below, lines 14-18 identify unkown words and/or spelling mistakes.

Check warning on line 176 in 2.0_use_and_contribute_to_teampsd_manual.md

View workflow job for this annotation

GitHub Actions / ActionChecker

Unknown word (unkown)

- The **Markdown Link Checker** will test all the links in your document to make sure they work. **It is normal for this checker to throw errors for links within the VA domain. These can be ignored.**
<img alt="Image of Spell Checker results." src="https://raw.githubusercontent.com/lzim/teampsd/gh-pages/images/spell_checker_results.png">

> Screenshot w/callouts to be developed.
##### Correct a Misspelling in a Markdown File

From the example above, there is one misspelling: chapterr. The Spell Checkers gives the line number in which spelling errors were found.

Check warning on line 182 in 2.0_use_and_contribute_to_teampsd_manual.md

View workflow job for this annotation

GitHub Actions / ActionChecker

Unknown word (chapterr)

<img alt="Image of ActionChecker line showing misspelling." src="https://raw.githubusercontent.com/lzim/teampsd/gh-pages/images/spell_checker_misspelling.png">

We can tell that this spelling mistake is in line #190 of the document "2.0_use_and_contribute_to_teampsd_manual.md".

<img alt="Image of ActionChecker line showing misspelling." src="https://raw.githubusercontent.com/lzim/teampsd/gh-pages/images/spell_checker_misspelling_markdown.png">

Go to the identified markdown file, correct the mistake, and make a commit.

##### Update cspellcdict.txt

Check warning on line 192 in 2.0_use_and_contribute_to_teampsd_manual.md

View workflow job for this annotation

GitHub Actions / ActionChecker

Unknown word (cspellcdict)

From the example above, there are two unknown words: "callouts" and "GH". We can amend the custom dictionary file so these errors won't show again.

Check warning on line 194 in 2.0_use_and_contribute_to_teampsd_manual.md

View workflow job for this annotation

GitHub Actions / ActionChecker

Unknown word (callouts)

Check warning on line 194 in 2.0_use_and_contribute_to_teampsd_manual.md

View workflow job for this annotation

GitHub Actions / ActionChecker

Unknown word (GH)

To do this, navigate to the repo you're working within (in this example, it's the teampsd repo), select the gh-pages branch (not the feature branch you've been working in), and click the .github/workflows folder. Then click on cspellcdict.txt (Team PSD's custom dictionary).

Check warning on line 196 in 2.0_use_and_contribute_to_teampsd_manual.md

View workflow job for this annotation

GitHub Actions / ActionChecker

Unknown word (cspellcdict)

<img alt="Image showing navigation steps to reach custom dictionary." src="https://raw.githubusercontent.com/lzim/teampsd/gh-pages/images/spell_checker_nav2cspellcdict.png">

Edit this file by adding the previously unknown word(s)/acronyms to the list. Bonus points if you add them in the correct alphabetical order! As seen in the screenshot below, both unknown words were added. Your future self (and teammates) may appreciate singular and/or plural versions of a word being added to this file, too. Commit your changes when done.

<img alt="Image of cspellcdict file showing added words." src="https://raw.githubusercontent.com/lzim/teampsd/gh-pages/images/spell_checker_cspellcdict_add.png">

Check warning on line 202 in 2.0_use_and_contribute_to_teampsd_manual.md

View workflow job for this annotation

GitHub Actions / ActionChecker

Unknown word (cspellcdict)

- The **Markdown Link Checker** tests all the links in your document to make sure they work correctly. Links include hyperlinks to internal and external (to VA domain) webpages, links to image files, and links to content within the document itself.

Click the caret next to Markdown Link Checker to reveal the status of all links within your committed files. Scroll past the colored text until you see a checkmark (working link) or an X (non-working link) within brackets beside each link.

Examples of the different types of links are shown below:

<img alt="Image of Markdown Link Checker links with callouts defining each type of link." src="https://raw.githubusercontent.com/lzim/teampsd/gh-pages/images/link_checker_link_types.png">

Check warning on line 210 in 2.0_use_and_contribute_to_teampsd_manual.md

View workflow job for this annotation

GitHub Actions / ActionChecker

Unknown word (callouts)

***It is normal for this checker to throw errors for links within the VA domain. These can safely be ignored.**

Make any link corrections needed within the document(s) and commit your changes.

- The **Markdown Linter for Directory Level Scan** tests your markdown file for compliance with markdown editorial rules. For example, it checks for additional spaces after each line, proper sequence of headers, bulleted lists, and other basic editorial screenings.

Expand All @@ -187,4 +221,28 @@ Once edits based on failed checks and feedback from reviewers have been implemen

### Publish to the Master gh-pages Branch

Merge the feature branch into the gh-pages head branch and double-check that your chapterr was published at https://mtl.how/teampsd_manual.
Once you've reviewed ActionChecker details and addressed errors, you can request teammates review your request. You can also merge the pull request yourself.

To merge the pull request, return to the Pull requests tab and click the Merge pull request button:

<img alt="Image of in-process pull request with merge pull request button highlighted." src="https://raw.githubusercontent.com/lzim/teampsd/gh-pages/images/merge_pull_request.png">

Then click the Confirm merge button:

<img alt="Image of in-process pull request with confirm merge button highlighted." src="https://raw.githubusercontent.com/lzim/teampsd/gh-pages/images/confirm_merge_pull_request.png">

Follow the progress of your merge by clicking the Actions tab. Be patient; it can take a few minutes for the workflows to complete. An example of the status change is provided below:

<img alt="Image of workflow status icons in both pending and complete states." src="https://raw.githubusercontent.com/lzim/teampsd/gh-pages/images/merge_complete.png">

Once you see a green status next to "pages build and deployment", double-check that your chapter was published at https://mtl.how/teampsd_manual. Once you see your changes live in the manual, you can delete the feature branch. This can be done in two ways:

- Click the Delete branch button on the pull request:

<img alt="Image of button to delete the feature branch from a pull request." src="https://raw.githubusercontent.com/lzim/teampsd/gh-pages/images/feature_branch_delete1.png">

--OR--

- Navigate to the teampsd repo, click the master branch dropdown, and select View all branches. Locate your feature branch and click the trash can icon on the right-hand side of the screen:

<img alt="Image with highlights showing clicks needed to delete feature branch from Branches page." src="https://raw.githubusercontent.com/lzim/teampsd/gh-pages/images/feature_branch_delete2.png">

0 comments on commit 01e7c75

Please sign in to comment.