gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
static-cms/website/content/docs/contributor-guide.md

36 lines
2.8 KiB
Markdown
Raw Normal View History

Migrate netlify-cms-www site into this repo (#860) * Add frontmatter to docs files (prep to move) * Move docs into position for website migration * Migrate website from netlify-cms-www Some modifications, including most of the changes in https://github.com/netlify/netlify-cms-www/pull/58 (previously reverted). Also updated the readme and added hugo-bin for quicker onboarding of new docs contributors. * Remove netlify.toml This allows separate build commands for cms-demo and netlifycms.org. * Remove website/netlify.toml May re-add later, but it's not doing anything for now. * Remove unused content file
2017-12-04 16:42:20 -08:00
---
add docs menu sections (#1366)
2018-05-17 17:14:29 -04:00
title: Contributor Guide
WTD19: Improve Contrib Guide and Create Style Guide (#2336) * getting started with the contributor guide updates for Netlify CMS at WTD19PDX * places to get involved header * create/mimi-style-guide initial commit * added guide for new terms * completed Documentation Formatting Standards * starting headings and content for contributing guidelines * added guide for inline code and commands * added guide for object field names * added guide for string and integer field values * added guide for code snippet formatting * added content best practices * Updated contributor guide * added guide for Patterns to avoid. Also added Note at the top * Update contributor-guide.md * Update and rename style-guide.md to writing-style-guide.md
2019-07-24 16:30:10 -05:00
weight: 20
convert website from hugo to gatsby (#1369)
2018-07-25 07:47:26 -04:00
group: contributing
Migrate netlify-cms-www site into this repo (#860) * Add frontmatter to docs files (prep to move) * Move docs into position for website migration * Migrate website from netlify-cms-www Some modifications, including most of the changes in https://github.com/netlify/netlify-cms-www/pull/58 (previously reverted). Also updated the readme and added hugo-bin for quicker onboarding of new docs contributors. * Remove netlify.toml This allows separate build commands for cms-demo and netlifycms.org. * Remove website/netlify.toml May re-add later, but it's not doing anything for now. * Remove unused content file
2017-12-04 16:42:20 -08:00
---
Revert "remove internal docs" This reverts commit 8cfe2c549dc350bb7650c1b0321813c5f17ce2d8.
2017-11-27 14:22:11 -05:00
We're hoping that Netlify CMS will do for the [JAMstack](https://www.jamstack.org) what WordPress did for dynamic sites back in the day. We know we can't do that without building a thriving community of contributors and users, and we'd love to have you join us.
WTD19: Improve Contrib Guide and Create Style Guide (#2336) * getting started with the contributor guide updates for Netlify CMS at WTD19PDX * places to get involved header * create/mimi-style-guide initial commit * added guide for new terms * completed Documentation Formatting Standards * starting headings and content for contributing guidelines * added guide for inline code and commands * added guide for object field names * added guide for string and integer field values * added guide for code snippet formatting * added content best practices * Updated contributor guide * added guide for Patterns to avoid. Also added Note at the top * Update contributor-guide.md * Update and rename style-guide.md to writing-style-guide.md
2019-07-24 16:30:10 -05:00
## Getting started with contributing
Being a developer is not a requirement for contributing to Netlify CMS, you only need the desire, a web browser, and a [GitHub account](https://github.com/join). The GitHub repo has a step-by-step [guide](https://github.com/netlify/netlify-cms/blob/master/CONTRIBUTING.md) to get started with the code.
## The basics of the Netlify CMS docs
docs: incorrect repo url in Contributor Guide (#2503)
2019-07-27 15:47:54 +02:00
The documentation for Netlify CMS is written in [Markdown](http://daringfireball.net/projects/markdown/) (a good cheatsheet on Markdown is [here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)), with the source residing on [GitHub](https://github.com/netlify/netlify-cms) in the `/website/content/docs` folder.
WTD19: Improve Contrib Guide and Create Style Guide (#2336) * getting started with the contributor guide updates for Netlify CMS at WTD19PDX * places to get involved header * create/mimi-style-guide initial commit * added guide for new terms * completed Documentation Formatting Standards * starting headings and content for contributing guidelines * added guide for inline code and commands * added guide for object field names * added guide for string and integer field values * added guide for code snippet formatting * added content best practices * Updated contributor guide * added guide for Patterns to avoid. Also added Note at the top * Update contributor-guide.md * Update and rename style-guide.md to writing-style-guide.md
2019-07-24 16:30:10 -05:00
The GitHub website allows you to submit issues, work with files, search for content, and browse changes that have been submitted in the past and those that are being submitted now (aka Pull Requests).
## Style guidelines
Fix broken link (#2522)
2019-08-07 14:45:07 -04:00
A [style guide](/docs/writing-style-guide/) is available to help provide context around grammar, code styling, syntax, etc.
WTD19: Improve Contrib Guide and Create Style Guide (#2336) * getting started with the contributor guide updates for Netlify CMS at WTD19PDX * places to get involved header * create/mimi-style-guide initial commit * added guide for new terms * completed Documentation Formatting Standards * starting headings and content for contributing guidelines * added guide for inline code and commands * added guide for object field names * added guide for string and integer field values * added guide for code snippet formatting * added content best practices * Updated contributor guide * added guide for Patterns to avoid. Also added Note at the top * Update contributor-guide.md * Update and rename style-guide.md to writing-style-guide.md
2019-07-24 16:30:10 -05:00
## Filing issues
If you have a GitHub account, you can file an [issue](https://github.com/netlify/netlify-cms/issues) (aka bug report) against the Netlify CMS docs. Even if you're not able to, or don't know how to, fix the issue (see [Improve existing content](#improve-existing-content)), it helps to start the conversation.
When filing an issue, it is important to remember the [Code of Conduct](https://github.com/netlify/netlify-cms/blob/master/CODE_OF_CONDUCT.md).
## Improve existing content
If you are able to offer up a change to existing content, we welcome this. Once you've forked the repo, and changed the content, you would file a pull request (PR). The repo [Contributing file](https://github.com/netlify/netlify-cms/blob/master/CONTRIBUTING.md) lays out the correct format for PRs.
## Other places to get involved
Revert "remove internal docs" This reverts commit 8cfe2c549dc350bb7650c1b0321813c5f17ce2d8.
2017-11-27 14:22:11 -05:00
While we work on building this page (and you can help!), here are some links with more information about getting involved:
docs(fix): revert prettier formatting on markdown files (#1612) Prettier formatting our markdown files is causing bugs because of the differences between Gatsby's parser and Prettier's. Also, Prettier formats the inline code-blocks containing example CMS configs, but the formatting it uses doesn't really make much sense or match the suggested CMS config style. It doesn't actually make much sense to format the docs anyway, since we use the CMS itself to edit/generate them.
2018-08-14 11:33:13 -06:00
* [Setup instructions and Contribution Guidelines](https://github.com/netlify/netlify-cms/blob/master/CONTRIBUTING.md)
chore: switch chat links to slack (#2782)
2019-10-22 20:59:04 -04:00
* [Join our Community Chat](https://netlifycms.org/chat)
docs(fix): revert prettier formatting on markdown files (#1612) Prettier formatting our markdown files is causing bugs because of the differences between Gatsby's parser and Prettier's. Also, Prettier formats the inline code-blocks containing example CMS configs, but the formatting it uses doesn't really make much sense or match the suggested CMS config style. It doesn't actually make much sense to format the docs anyway, since we use the CMS itself to edit/generate them.
2018-08-14 11:33:13 -06:00
* [Code of Conduct](https://github.com/netlify/netlify-cms/blob/master/CODE_OF_CONDUCT.md)
* [Project Milestones](https://github.com/netlify/netlify-cms/milestones)
* [Good First Issues](https://github.com/netlify/netlify-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22+-label%3Aclaimed)
Reference in New Issue Copy Permalink