pkg/schema, doc: improve doc for schema and bundle image reference #1933
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
Signed-off-by: Yingrong Zhao <[email protected]>
VinozzZ
requested review from
carolynvs,
jeremyrickard and
vdice
as code owners
VinozzZ
changed the title
carolynvs
requested changes
Feb 24, 2022
docs/static/_redirects
Outdated
| @@ -50,3 +50,8 @@ | |||
| /:version/porter-darwin-amd64 https://github.com/getporter/porter/releases/download/:version/porter-darwin-amd64 302 | |||
| /:version/porter-linux-amd64 https://github.com/getporter/porter/releases/download/:version/porter-linux-amd64 302 | |||
| /:version/porter-windows-amd64.exe https://github.com/getporter/porter/releases/download/:version/porter-windows-amd64.exe 302 | |||
|
|
|||
| # Redirect the schema json files | |||
| /schema/v1/credential-set.schema.json https://raw.githubusercontent.com/getporter/porter/release/v1/pkg/schema/credential-set.schema.json | |||
There was a problem hiding this comment.
Instead of redirecting each file individually, let's take advantage of the netlify redirect tricks like * and :splat so that we can just have a single entry that will work for any schema file.
Also you will need to commit the change to the redirect file to the main branch too in order for netlify to use it with porter.sh.
| @@ -1,5 +1,5 @@ | |||
| { | |||
| "$id": "https://cnab.io/v1/credential-set.schema.json", | |||
| "$id": "https://porter.sh/schema/v1/credential-set.schema.json", | |||
Signed-off-by: Yingrong Zhao <[email protected]>
carolynvs
approved these changes
Feb 25, 2022
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.
Signed-off-by: Yingrong Zhao [email protected]
What does this change
This PR improves porter's doc in two area:
What issue does it fix
Closes #1908 and #1887
Notes for the reviewer
Checklist
Reviewer Checklist