From 616ebdc3ccd23e3fb1e082fa9347cf1e3f5a0a47 Mon Sep 17 00:00:00 2001 From: Laura M <124643236+ljmoody@users.noreply.github.com> Date: Wed, 27 Nov 2024 17:26:39 -0700 Subject: [PATCH 1/2] added Linter for Directory Level Scan info --- 2.0_use_and_contribute_to_teampsd_manual.md | 26 ++++++++++----------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/2.0_use_and_contribute_to_teampsd_manual.md b/2.0_use_and_contribute_to_teampsd_manual.md index 5e900ed7c..d85b79199 100644 --- a/2.0_use_and_contribute_to_teampsd_manual.md +++ b/2.0_use_and_contribute_to_teampsd_manual.md @@ -56,7 +56,7 @@ The chapters where the key term was found in will appear in the Table of Content ![glossary chapter example image](https://user-images.githubusercontent.com/59668647/89900499-acde8e80-db98-11ea-8d39-6765219fd552.png) -## Contribute to the Manual using GitHub +## Contribute to the Manual Using GitHub ### Create a Feature Branch from the GH-Pages Branch @@ -143,7 +143,7 @@ There are several ways to create a pull request; below is one example. Image of pull request form. -### Check the File against GitHub Actions +### Check the File Against GitHub Actions Once a pull request has been made, an automatic process checks the file(s) against the repo's Linter Actions. Scroll down the pull request page to see real-time progress of the Linter Actions. The screenshot below shows Actions in progress with no issues so far in the checks: @@ -157,13 +157,13 @@ Linter Actions are automated processes that check your code for issues, errors, **Review Linter Results** -If the Actions progress area has a red X and "All checks have failed" message (like the screenshot below), click on Details in the ActionChecker to navigate to the Spell Checker, Markdown Link Checker, and Markdown Linter for Directory Level Scan. The ActionChecker returns the "All checks have failed" error with _any_ failed action (one or many). A failing ActionChecker _does not prevent one from deploying updates to the manual_; although "all checks have failed", users can still select to merge their pull request (see further information below). +If the Actions progress area has a red X and "All checks have failed" message (like the screenshot below), click on Details in the ActionChecker to navigate to the Spell Checker, Markdown Link Checker, and Markdown Linter for Directory Level Scan. The ActionChecker returns the "All checks have failed" error with _any_ failed action (one or many). **A failing ActionChecker _does not prevent one from deploying updates to the manual_**; although "All checks have failed", **users can still merge their pull request** (see [Publish to the Master gh-pages Branch](#publish-to-the-master-gh-pages-branch)). Image of ActionChecker identifying errors. **ActionChecker details screen:** -Check for a red X by each GitHub Action and read the output of where errors occurred. Some errors you can address yourself, some are safely ignorable, and others may need to be addressed by the Development Team. (Errors do not prevent changes from happening; you can still merge.) +Check for a red "X" by each GitHub Action and read the output of where errors occurred. Some errors you can address yourself, some are safely ignorable, and others may need to be addressed by the Development Team. As a reminder, _errors do not prevent changes from happening; you can still merge the pull request_. Image of ActionChecker details screen. @@ -179,7 +179,7 @@ Click the caret next to Spell Checker to reveal the spelling errors found. In th ##### Correct a Misspelling in a Markdown File -From the example above, there is one misspelling: chapterr. The Spell Checker show the line number in which spelling errors were found. +From the example above, there is one misspelling: chapterr. The Spell Checker shows the line number in which spelling errors were found. Image of ActionChecker line showing misspelling. @@ -191,9 +191,9 @@ Go to the identified markdown file, correct the mistake, and make a commit. ##### Update cspellcdict.txt -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. +From the example above, there are two unknown words: "callouts" and "GH". The custom dictionary file can be amended so these errors won't show again (for those specific words). -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). +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). Image showing navigation steps to reach custom dictionary. @@ -213,17 +213,17 @@ Examples of the different types of links are shown below: 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. +- 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. **If any formatting errors like the ones below are identified, they can be safely ignored and the pull request can be merged.** The image below shows how to "read" the error messages for this linter. -> Screenshot w/callouts to be developed. +Image of linter error messages with callouts that detail each part of the error message. -Once edits based on failed checks and feedback from reviewers have been implemented, the pull request is ready to be merged. +If you desire a deep dive into the rules this linter checks for, [this is a good resource](https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md). ### Publish to the Master gh-pages Branch Once you have reviewed ActionChecker details and addressed any critical errors, you can request teammates review your pull request. Depending on their feedback, you may need to respond to their comments or questions. -You can merge the pull request yourself. Remember, errors do not prevent changes from happening; you can still merge. Users can always revert changes (pull requests). To merge the pull request, return to the Pull requests tab and click the Merge pull request button: +**You can merge the pull request yourself. Remember, errors do not prevent changes from happening; you can still merge.** It is always posssible to revert changes (pull requests). To merge the pull request, return to the Pull requests tab, navigate to your pull request, and click the Merge pull request button: Image of in-process pull request with merge pull request button highlighted. @@ -240,13 +240,13 @@ Once you see a green status next to "pages build and deployment", double-check t ### Delete the Feature Branch -Once you observe your changes live in the manual, please delete the feature branch. This can be done in two ways: +**Once you observe your changes live in the manual**, please delete the feature branch to help reduce clutter. This can be done in two ways: - Click the Delete branch button on the pull request: Image of button to delete the feature branch from a pull request. ---OR-- +—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: From f07c942b49463d878cdf29687dfef0a1c0c6f9ae Mon Sep 17 00:00:00 2001 From: Laura M <124643236+ljmoody@users.noreply.github.com> Date: Wed, 27 Nov 2024 17:30:44 -0700 Subject: [PATCH 2/2] corrected misspelling --- 2.0_use_and_contribute_to_teampsd_manual.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/2.0_use_and_contribute_to_teampsd_manual.md b/2.0_use_and_contribute_to_teampsd_manual.md index d85b79199..3b5bd26aa 100644 --- a/2.0_use_and_contribute_to_teampsd_manual.md +++ b/2.0_use_and_contribute_to_teampsd_manual.md @@ -223,7 +223,7 @@ If you desire a deep dive into the rules this linter checks for, [this is a good Once you have reviewed ActionChecker details and addressed any critical errors, you can request teammates review your pull request. Depending on their feedback, you may need to respond to their comments or questions. -**You can merge the pull request yourself. Remember, errors do not prevent changes from happening; you can still merge.** It is always posssible to revert changes (pull requests). To merge the pull request, return to the Pull requests tab, navigate to your pull request, and click the Merge pull request button: +**You can merge the pull request yourself. Remember, errors do not prevent changes from happening; you can still merge.** It is always possible to revert changes (pull requests). To merge the pull request, return to the Pull requests tab, navigate to your pull request, and click the Merge pull request button: Image of in-process pull request with merge pull request button highlighted.