docs: streamline readme file and reorg docs #3438
Merged
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
Our README.md file was getting pretty long. I've attmepted to streamline it and move some documentation to other files, as well as updating the default procedures for how things will work in 3.3. Signed-off-by: Terri Oda <terri.oda@intel.com>
For the weeks before the 3.3 release happens, add an extra sentence about the api key. Signed-off-by: Terri Oda <terri.oda@intel.com>
Codecov Report
@@ Coverage Diff @@
## main #3438 +/- ##
==========================================
- Coverage 80.29% 79.98% -0.31%
==========================================
Files 758 758
Lines 11616 11616
Branches 1571 1571
==========================================
- Hits 9327 9291 -36
- Misses 1853 1903 +50
+ Partials 436 422 -14
Flags with carried forward coverage won't be shown. Click here to find out more. see 6 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
novafacing
approved these changes
Oct 20, 2023
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.
Our README.md file was getting pretty long. This streamlines it (moving some content to the manual or how-to guides) and reorganizes, as well as updating in preparation for 3.3 when we'll be using the mirror directly instead of needing an nvd_api_key for all installs.