Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update parameters doc with allowable types #1792

Merged
merged 3 commits into from
Oct 11, 2021
Merged

docs: update parameters doc with allowable types #1792

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b6fc2a2
update parameters doc with allowable types
adnxn Oct 7, 2021
cf60fb2
to squash: address wording issues
adnxn Oct 7, 2021
2e2e156
to squash: add parameters-type section
adnxn Oct 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/content/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ Parameter values are resolved from a combination of supplied parameter set
files, user-specified overrides and defaults defined by the bundle itself.
The resolved values are added to a claim receipt, which is passed in to
the bundle execution environment, e.g. the docker container, when the bundle
action is executed (install/upgrade/uninstall/invoke).
action is executed (install/upgrade/uninstall/invoke). Parameters are restricted
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's move this sentence about allowed types right after the first sentence in the paragraph after "When you are authoring a bundle,...".

The first paragraph is discussing defining parameters, which is more relevant to the content that you just added.

Copy link
Contributor Author

@adnxn adnxn Oct 7, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rearranged the wording. lmk if that sounds better

to a list of [allowable data
types](https://porter.sh/author-bundles/#parameters).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you take a look at your preview page, you'll see that the link here goes directly to the main website, and isn't relative to the preview website. We like to use relative links so that as you click links on a preview of the website, or on a different version of the website, like https://release-v1.porter.sh, you stay on the same site and don't just to the live site.

If you change the link to /author-bundles/#parameters, that will fix the link.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed!


## Parameter Sets

Expand Down