📖 Olivekl patch 1 #1039
Merged
📖 Olivekl patch 1 #1039
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
azeemshaikh38
approved these changes
Sep 17, 2021
There was a problem hiding this comment.
@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
|
@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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs update: collect links to all docs into README.md with new Table of Contents/organization