Skip to content

Commit ecedc49

Browse files
authored
pkg/schema, doc: improve doc for schema and bundle image reference (#1933)
* pkg/schema, doc: fix doc for schema and bundle image reference Signed-off-by: Yingrong Zhao <yingrong.zhao@gmail.com> * use wildcard for redirect Signed-off-by: Yingrong Zhao <yingrong.zhao@gmail.com>
1 parent 49a42a9 commit ecedc49

File tree

6 files changed

+11
-6
lines changed

6 files changed

+11
-6
lines changed

docs/content/author-bundles.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -475,6 +475,8 @@ Here is a breakdown of all the supported fields on an image in this section of t
475475
* `labels`: Key/value pairs used to specify identifying attributes of the image.
476476
* `tag`: The tag of the image (only recommended when/if digest isn't known/available).
477477

478+
When referencing an image, only fully qualified image reference is supported, e.g. library/hello-world instead of just hello-world.
479+
478480
A last note on `digest`. Taking the example of the library `nginx` Docker image, we can get the repository digest like so:
479481

480482
```console

docs/content/reference/file-formats.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,6 @@ parameters:
129129
130130
\* The bundle section requires a repository and one of the following fields: digest, version, or tag.
131131
132-
[cs-schema]: https://raw.githubusercontent.com/getporter/porter/release/v1/pkg/schema/credential-set.schema.json
133-
[ps-schema]: https://raw.githubusercontent.com/getporter/porter/release/v1/pkg/schema/parameter-set.schema.json
134-
[inst-schema]: https://raw.githubusercontent.com/getporter/porter/release/v1/pkg/schema/installation.schema.json
132+
[cs-schema]: https://porter.sh/schema/v1/credential-set.schema.json
133+
[ps-schema]: https://porter.sh/schema/v1/parameter-set.schema.json
134+
[inst-schema]: https://porter.sh/schema/v1/installation.schema.json

docs/static/_redirects

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,6 @@
5050
/:version/porter-darwin-amd64 https://github.com/getporter/porter/releases/download/:version/porter-darwin-amd64 302
5151
/:version/porter-linux-amd64 https://github.com/getporter/porter/releases/download/:version/porter-linux-amd64 302
5252
/:version/porter-windows-amd64.exe https://github.com/getporter/porter/releases/download/:version/porter-windows-amd64.exe 302
53+
54+
# Redirect the schema json files
55+
/schema/:version/* https://raw.githubusercontent.com/getporter/porter/release/:version/pkg/schema/:splat

pkg/schema/credential-set.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$id": "https://cnab.io/v1/credential-set.schema.json",
2+
"$id": "https://porter.sh/schema/v1/credential-set.schema.json",
33
"$schema": "http://json-schema.org/draft-07/schema#",
44
"definitions": {
55
"valueMapping": {

pkg/schema/installation.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$id": "https://cnab.io/v1/installation.schema.json",
2+
"$id": "https://porter.sh/schema/v1/installation.schema.json",
33
"$schema": "http://json-schema.org/draft-07/schema#",
44
"properties": {
55
"name": {

pkg/schema/parameter-set.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$id": "https://cnab.io/v1/parameter-set.schema.json",
2+
"$id": "https://porter.sh/schema/v1/parameter-set.schema.json",
33
"$schema": "http://json-schema.org/draft-07/schema#",
44
"definitions": {
55
"valueMapping": {

0 commit comments

Comments
 (0)