docs: document the advisories init command#853
Open
ELHart05 wants to merge 1 commit into
Open
Conversation
Add `advisories init` alongside the existing `advisories sync` docs so air-gapped users can find the init then populate then --offline-db workflow. - cli-reference.md: add init to the usage block and the offline sync examples, with a note that init refuses to overwrite an existing file. - offline-advisory-db.md: add a workflow-modes section for environments that cannot reach OSV at all. - README.md: one-line mention in the command list next to sync. Docs only, no code changes. Verified `npm run build` in website/ still builds the Docusaurus site. Closes OWASP#850
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Documents
advisories init(shipped in #847) next to the existingadvisories syncdocs, so air-gapped users can find the init -> populate ->--offline-dbworkflow.What changed
cli-reference.md: init in the usage block, plus an offline example with the no-overwrite note.offline-advisory-db.md: a workflow-modes section for environments that cannot reach OSV at all.README.md: one-line mention next toadvisories sync.Validation
npm run buildinwebsite/builds the Docusaurus site cleanly. Docs only, no code changes.Closes #850