Update database prefix documentation to be more detailed #143
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
joshbuker
force-pushed
the
update/prefix-documentation
branch
from
7731026
to
03a25b3
Compare
|
Alternatively, we can embed the same information in the description field using |
oliverchang
reviewed
Apr 4, 2023
joshbuker
commented
Apr 4, 2023
joshbuker
force-pushed
the
update/prefix-documentation
branch
from
6a41d11
to
ef406d4
Compare
|
That's odd...I amended my commit with the sign-off, and the build is still failing...? Edit: I missed a commit before my merge commit. It was easiest to just redo my history with a soft reset and sign off on that. |
Rather than a generic description, updated the table to provide more specific (and actionable) information: - Prefix - Database Name / Source URL - Canonical URL for a given <ID> - API Endpoint for a given <ID> - Regex for the ID May not be fully complete or accurate, but should provide more actionable guidance for OSV consumers and producers. Signed-off-by: Josh Buker <crypto@joshbuker.com>
joshbuker
force-pushed
the
update/prefix-documentation
branch
from
ef406d4
to
82c67c5
Compare
joshbuker
added a commit
to joshbuker/osv-schema
that referenced
this pull request
Apr 12, 2023
Signed-off-by: Josh Buker <crypto@joshbuker.com>
joshbuker
force-pushed
the
update/prefix-documentation
branch
from
c569cba
to
e398682
Compare
oliverchang
approved these changes
Apr 13, 2023
|
@oliverchang Heads up that you missed the sign-off on your commits. LGTM, I'll add https://gsd.id/getting-started for how to contribute to GSD (docs are WIP) after your commits are fixed, but otherwise don't see any issues. |
Yep I messed up there :) Merging ! |
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.
Rather than a generic description, updated the table to provide more specific (and actionable) information:
May not be fully complete or accurate, but should provide more actionable guidance for OSV consumers and producers.