docs: update parameters doc with allowable types #1792
Conversation
Signed-off-by: “adnan” <[email protected]>
adnxn
changed the title
|
A preview of your change is located at https://deploy-preview-1792--porter.netlify.app/parameters/. You can find this link by expanding the "checks" section by clicking "show all checks" then click on the netlify preview. |
docs/content/parameters.md
Outdated
| action is executed (install/upgrade/uninstall/invoke). | ||
| action is executed (install/upgrade/uninstall/invoke). Parameters are restricted | ||
| to a list of [allowable data | ||
| types](https://porter.sh/author-bundles/#parameters). |
There was a problem hiding this comment.
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.
docs/content/parameters.md
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
rearranged the wording. lmk if that sounds better
Signed-off-by: “adnan” <[email protected]>
|
Looking at this more, I think that what I originally suggested in the issue isn't enough. Sorry about that. Below is what the user sees when they click on the new link. I don't expect most people to find the part that explains the available types easily. What if we added one more change, this time to the page below, and add a heading named "Parameter Types" and then we repeated the list of allowed types, as a bulleted list. Then we can modify the link from the other page to this one to go directly to that new heading. That should make it much easier to find the list of supported types. Browser metadata |
i agree, i think that's a better idea |
Signed-off-by: “adnan” <[email protected]>
* Fix Pushing Bundles that have a relocationMap (getporter#1815) * chore: add avinashupadhya99 to Contributors.md * docs: remove accidental packr word from contribution guide * Improve error message when cnab-to-oci fixes up a bundle * docs: fix command in contrib tutorial * docs: update parameters doc with allowable types (getporter#1792) Signed-off-by: Carolyn Van Slyck <[email protected]>
What does this change
If I understood #1114 correctly, this change improves visibility of parameter types on the main parameters documentation.
What issue does it fix
Closes #1114
Notes for the reviewer
n/a
Checklist
If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇♀️