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.

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) expand more on the "default" field for parameters #2927

Merged
merged 4 commits into from
Oct 17, 2023

Conversation

schristoff
Copy link
Member

No description provided.

@@ -51,6 +51,15 @@ You can also provide any other attributes, as specified by the CNAB [parameters]
default: "wordpress"
```

If using the default parameter field it must be set. However, it must be passed in as an empty
Copy link
Contributor

Choose a reason for hiding this comment

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

it's not clear to me what these two sentences mean, maybe could be clearer?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure! Is there an exact part that is confusing to you?

Copy link
Contributor

@ludfjig ludfjig Sep 27, 2023

Choose a reason for hiding this comment

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

What does "it must be set" mean, and why you gotta set them to some empty value

Copy link
Contributor

Choose a reason for hiding this comment

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

how about the following:

If you decide to use the default parameter field, you must set it as the empty value

does this capture everything you want to say?

Copy link
Contributor

@ludfjig ludfjig Sep 29, 2023

Choose a reason for hiding this comment

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

I still dont understand why it has to be empty. Isn't this in contradiction with the above example?

You can also provide any other attributes, as specified by the CNAB [parameters](https://github.com/cnabio/cnab-spec/blob/master/101-bundle-json.md#parameters) specification. To specify a default value, for example, you could provide the following parameter definition:
```yaml
- name: database_name
type: string
default: "wordpress"
```

@@ -51,6 +51,15 @@ You can also provide any other attributes, as specified by the CNAB [parameters]
default: "wordpress"
```

If using the default parameter field it must be set. However, it must be passed in as an empty
Copy link
Contributor

Choose a reason for hiding this comment

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

how about the following:

If you decide to use the default parameter field, you must set it as the empty value

does this capture everything you want to say?

@schristoff schristoff enabled auto-merge (squash) October 10, 2023 21:18
@schristoff schristoff merged commit b63338b into getporter:main Oct 17, 2023
8 checks passed
@schristoff schristoff deleted the schristoff_defaultingparams branch October 17, 2023 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants