Installation docs update#1416
Conversation
Modified texts for steps 3-4 Signed-off-by: Jeremiah Howard <jhoward0922@gmail.com>
Capturing screenshots of the installation instructions of OSSF Scorecard Signed-off-by: Jeremiah Howard <jhoward0922@gmail.com>
Signed-off-by: Jeremiah Howard <jhoward0922@gmail.com>
Signed-off-by: Jeremiah Howard <jhoward0922@gmail.com>
Signed-off-by: Jeremiah Howard <jhoward0922@gmail.com>
Signed-off-by: Jeremiah Howard <jhoward0922@gmail.com>
Updated screenshots of the installation instructions, and added extra detailed steps. Co-authored-by: Silas Morgan <victorsmorgan@gmail.com> Co-authored-by: Kemon Bynum <kemonbynum18@gmail.com> Co-authored-by: Jordin Jones <j.a.jones107732@spartans.nsu.edu> Co-authored-by: Elijah Everett <elijaheverett3271@gmail.com> Co-authored-by: Emily Lovell <emily.marie.lovell@gmail.com> Signed-off-by: Jeremiah Howard <jhoward0922@gmail.com>
|
What do you think @spencerschrock? |
Signed-off-by: Jeremiah Howard <jhoward0922@gmail.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1416 +/- ##
===========================================
- Coverage 63.17% 29.17% -34.00%
===========================================
Files 4 12 +8
Lines 296 802 +506
===========================================
+ Hits 187 234 +47
- Misses 94 550 +456
- Partials 15 18 +3 |
|
Thanks for the PR, @JeremiahAHoward! |
There was a problem hiding this comment.
Thanks so much for your contribution @JeremiahAHoward !
I'll leave some minor phrasing feedback below, and am also going to push a suggested Markdown formatting change to my fork to demonstrate how we can improve the numbered lists going forward (it's a bit tricky to suggest the proper indentation required for each step, so it's probably easier to just show you the difference in an actual commit).
It looks like you'll also need to bring the branch up-to-date with the latest from main, and we'll need to figure out why Codecov started failing as a result of deleting install04.png from the images directory.
Codecov has some rate limiting issues and runs inconsistently. We never migrated to their new format (see ossf/scorecard#3862). Considering this is a README only change, I wouldn't stress on the coverage. |
|
@JeremiahAHoward as promised, check out this commit for an example of the ordered lists syntax I was referencing above. Feel free to use that as inspiration, or copy-paste the raw markdown into your branch 🙂 |
Signed-off-by: Jeremiah Howard <jhoward0922@gmail.com>
Signed-off-by: Jeremiah Howard <jhoward0922@gmail.com>
Signed-off-by: Jeremiah Howard <jhoward0922@gmail.com>
Signed-off-by: Jeremiah Howard <jhoward0922@gmail.com>
Signed-off-by: Jeremiah Howard <jhoward0922@gmail.com>
|
@lelia, @spencerschrock Thank you both for your feedback on our pull request. We addressed the edits asked of us and decided to leave the numbered steps to continue numerically, to preserve markdown readability. We noticed as long as the indentation was properly formatted in markdown, GitHub will automatically correct any discrepancies in list numbering. Please let us know if there is anything else you notice :) |
My team and I updated the installation screenshots, this fixes #1409.
I worked with @emmet0r, @SilasVM, @Wavyeli32, @Jordin221, @klbynum.
Shoutout to @marcinguy for working on #1403 which provided some insight into helping us.