started contribution guide #2281
Conversation
|
The documentation part is currently only the renamed maintainance.md and needs more work. |
| $ vim examples/source/1.components/amp-awesome/api.js | ||
| ``` | ||
|
|
||
| If your sample, does not fit into one of the existing categories, please [create an issue](https://github.com/ampproject/docs/issues/new) first and ask for feedback. |
There was a problem hiding this comment.
Should we encourage to ping the team either on #wg-outreach or via an issue in any case? This would enable us to push example ideas in a specific direction to cover certain use cases.
There was a problem hiding this comment.
I think a formal issue is better in this case
contributing/samples.md
Outdated
| - draft [default: true] | ||
| - true | ||
| - false | ||
| - tags [default: ''] |
There was a problem hiding this comment.
Multi-category filtering still needs to be implemented, I'll file an issue.
contributing/samples.md
Outdated
|
|
||
| ``` | ||
| - formats | ||
| - websites |
There was a problem hiding this comment.
maybe update this sample with a format that isn't websites
contributing/samples.md
Outdated
|
|
||
| ## Frontmatter | ||
|
|
||
| Samples can define a YAML-based frontmatter. Here is a template to get you started: |
There was a problem hiding this comment.
I'm not sure I understand "can define". Must they have a defined YAML-based frontmatter?
contributing/samples.md
Outdated
|
|
||
| **Note the triple dash `<!---`!**. Also make sure to list all supported formats (websites,ads,email,stories). | ||
|
|
||
| If your sample is specific to an AMP Format, please define it as well: |
There was a problem hiding this comment.
This is a bit confusing. Maybe something like:
You must list all the supported AMP formats for your sample. If your sample is specific AMP format, define that single format.
contributing/samples.md
Outdated
| Other supported flags are: | ||
|
|
||
| ```yaml | ||
| - formats [default: websites,ads,email,stories]: |
There was a problem hiding this comment.
Does the [default: websites,ads,email,stories] need to be defined in my frontmatter?
There was a problem hiding this comment.
turned these into YAML comments
contributing/samples.md
Outdated
|
|
||
| ## Writing the sample | ||
|
|
||
| Samples are annotated HTML files. Use HTML comments (`<!-- ... -->`) to document your sample code: |
There was a problem hiding this comment.
This sounds like we should wrap our sample code in HTML comments. Maybe something like:
Add documentation to your sample's code by wrapping text in HTML comments.
No description provided.