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

docs: update /contributing docs #30607

Merged
merged 27 commits into from
Apr 9, 2021
Merged
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
742b9f4
chore: group docs contributions pages into a subfolder
meganesu Mar 15, 2021
8aa7063
wip: update docs templates overview
meganesu Mar 16, 2021
cdad28b
wip: outline How-To Guide template
meganesu Mar 16, 2021
fe2b6ea
wip: remove reference to www directory
meganesu Mar 16, 2021
e4917e8
chore: add image with doc type quadrants (from divio)
meganesu Mar 16, 2021
2239597
wip: outline 'how to write a X' docs
meganesu Mar 31, 2021
ad369a0
docs: first draft of 'how to write a how-to guide'
meganesu Mar 31, 2021
1c307b1
docs: add context to intro of blog contributions page
meganesu Apr 1, 2021
212ef10
docs: add TODO reminder about updating the doc system image
meganesu Apr 1, 2021
5820ad4
docs: add numbered list of steps to how-to guide
meganesu Apr 1, 2021
28a1bc6
docs: update how to use a plugin, to match How-To Guide template
meganesu Apr 2, 2021
e96536f
docs: add how-to guide exemplar to /contributing template
meganesu Apr 2, 2021
c847168
docs: update how-to guide template
meganesu Apr 2, 2021
5984d26
docs: copy edits
meganesu Apr 2, 2021
4ea719f
docs: (wip) update reference guide template
meganesu Apr 2, 2021
0a3b2b2
docs: create conceptual guide contributing doc
meganesu Apr 6, 2021
94a722e
docs: update heading capitalization to match style guide
meganesu Apr 6, 2021
530ed70
docs: create reference guide contributing doc
meganesu Apr 6, 2021
ba9c4a9
docs: update docs template landing page (rename to docs structure)
meganesu Apr 7, 2021
0aa5a6f
docs: update the point to Support page instead of Twitter
meganesu Apr 7, 2021
3b8999f
docs: update docs contributions guidelines (local dev setup, links, etc)
meganesu Apr 7, 2021
ba26ed3
docs: apply suggestions from code review
meganesu Apr 7, 2021
d0044d1
chore: delete stub pages
meganesu Apr 8, 2021
64751c6
remove stub issue
meganesu Apr 8, 2021
e8052c9
docs: update style guide
meganesu Apr 8, 2021
79e7b2e
docs: apply suggestions from code review
meganesu Apr 8, 2021
744cd66
fix: lint
meganesu Apr 8, 2021
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
remove stub issue
  • Loading branch information
meganesu committed Apr 8, 2021
commit 64751c6f9001d888753d92660b92692da67b13ea
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: How to Write a Plugin README
issue: https://github.com/gatsbyjs/gatsby/issues/21599
---

A plugin README is like a Reference Guide for a specific plugin. It should describe what the plugin does, how to install and configure it, and how to use it in your site.
Expand Down