-
Notifications
You must be signed in to change notification settings - Fork 485
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
📖 Olivekl patch 1 #1039
📖 Olivekl patch 1 #1039
Conversation
Add new Contents section at top that includes links to to other documentation pages. Remove old Contents section that linked only to the page below.
Change “Supportability” to “Prerequisites” and add GoLang requirement. Rename “Troubleshooting” to “Report Problems” and remove Slack reference Rename “Contributing” to “Get Involved” and add Slack reference. Tweak headings for clarity/concision.
Fix link (Get Involved)
Moved content on page to match new Table of Contents format Added subheadings linking out to other pages to match new Table of Contents format Renamed "Motivation" to "What is Scorecards?"
Removed out-of-date info on Pass/Fail scoring from Usage section Added info about previous Pass/Fail scoring to Public Data section Removed out-of-date Pass/Fail example from Package Manager section
Changed links from absolute to relative paths Moved "Overview" section to top
Renamed "Learn More About Each Check" section to "Detailed Check Documentation"
Added example for format flag Trimmed example for package manager (since removing the out-of-date results example)
Moved "Basic Usage" heading Minor tweaks for clarity
Change "Get Involved" heading to "Connect with the Scorecards Community"
Replace colon with comma for consistency
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks Kara!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@olivekl Extremely happy with this change. Than you!
Expect the one comment which makes it incorrect to install. After we fix this it can be merged.
Fix line formatting Fix explanation of BigQuery pass/fail scoring Update install command
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
@olivekl can you update this PR with #1046 (comment) |
Let's do this in a follow up PR. |
@olivekl I made some changes to resolve merge conflicts. Please take a look and let me know if its good to go and I can merge it. |
Docs update: collect links to all docs into README.md with new Table of Contents/organization