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

WTD19: Improve Contrib Guide and Create Style Guide #2336

Merged
merged 19 commits into from
Jul 24, 2019

Conversation

jerdog
Copy link
Contributor

@jerdog jerdog commented May 19, 2019

Summary
Collaboration between @MimiDumpling and myself at Write The Docs Portland 2019. In response to #1038 and #1632. Inspiration was taken from the Kubernetes Contributing Guidelines and Style Guide as mentioned in the respective issues.

A picture of a cute animal (not mandatory but encouraged)

I submit this baby trash panda to the Netlify CMS gods
image

@netlify
Copy link

netlify bot commented May 19, 2019

Preview proposed changes to the CMS demo site in the link below:

Built with commit 25b8e54

https://deploy-preview-2336--cms-demo.netlify.com

@netlify
Copy link

netlify bot commented May 20, 2019

Preview proposed changes to netlifycms.org in the link below:

Built with commit 25b8e54

https://deploy-preview-2336--netlify-cms-www.netlify.com

Copy link
Contributor

@erquhart erquhart left a comment

Choose a reason for hiding this comment

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

Thanks for opening this, very much appreciated!

Copy link
Contributor

@erquhart erquhart left a comment

Choose a reason for hiding this comment

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

Gave the style guide another read and much of it was very useful, I mistook it for a code style guide in my first pass. Made some updates to the examples so they're more familiar, and removed some parts that didn't apply.

@jerdog thanks again for raising this!

@erquhart erquhart merged commit 7fb1168 into decaporg:master Jul 24, 2019
nathankitchen pushed a commit to nathankitchen/netlify-cms-backend-azure that referenced this pull request Feb 24, 2020
* 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
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.

3 participants