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

documenting resourceLink in README #82

Merged
merged 1 commit into from
Mar 5, 2020
Merged

documenting resourceLink in README #82

merged 1 commit into from
Mar 5, 2020

Conversation

PatMyron
Copy link
Contributor

#67

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@benbridts
Copy link

It might be nice to have the comment about urls starting with https:// as an option. "Can I link to my own website" will be the first question that a third party developer will ask.

@PatMyron
Copy link
Contributor Author

It might be nice to have the comment about urls starting with https:// as an option. "Can I link to my own website" will be the first question that a third party developer will ask.

Yeah I've been debating how much information should be repeated in the README. Wanted to at least get something involving resourceLink in the README, but something about the pattern would probably be useful to pull in as well:
https://github.com/aws-cloudformation/aws-cloudformation-resource-schema/blob/5f3aa9ce9932d0b6525bf885c838cd12e1511720/src/main/resources/schema/provider.definition.schema.v1.json#L226

@benbridts
Copy link

Maybe adding a bit of proza to https://github.com/aws-cloudformation/cloudformation-cli/blob/master/doc_source/resource-type-schema.md might solve this? Schema's are great for validating values, they don't provide a lot of readability or context about what a particular property does.

This might be more of a thing that can to be looked at outside of this pull request.

Copy link
Contributor

@vladtsir vladtsir left a comment

Choose a reason for hiding this comment

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

tested in my account, worked great

@PatMyron PatMyron requested a review from miparnisari March 5, 2020 00:42
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.

4 participants