search

aws-cloudformation / cloudformation-resource-schema

The CloudFormation Resource Schema defines the shape and semantic for resources provisioned by CloudFormation. It is used by provider developers using the CloudFormation RPDK.
Apache License 2.0
95 stars 38 forks source link

documenting resourceLink in README #82

Closed PatMyron closed 4 years ago

PatMyron commented 4 years ago

https://github.com/aws-cloudformation/aws-cloudformation-resource-schema/pull/67

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

benbridts commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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.