Improve contributing docs (#1852)

Signed-off-by: Carlisia <carlisia@vmware.com>
vmware-tanzu · Sep 16, 2019 · 6ef67fe · 6ef67fe
1 parent c55845f
commit 6ef67fe
Show file tree

Hide file tree

Showing 19 changed files with 311 additions and 456 deletions.
diff --git a/README.md b/README.md
@@ -36,45 +36,25 @@ If you encounter issues, review the [troubleshooting docs][30], [file an issue][
 
 ## Contributing
 
-Thanks for taking the time to join our community and start contributing!
-
-Feedback and discussion are available on [the mailing list][24].
-
-### Before you start
-
-* Please familiarize yourself with the [Code of Conduct][8] before contributing.
-* See [CONTRIBUTING.md][5] for instructions on the developer certificate of origin that we require.
-* Read how [we're using ZenHub][26] for project and roadmap planning
-
-### Pull requests
-
-* We welcome pull requests. Feel free to dig through the [issues][4] and jump in.
+If you are ready to jump in and test, add code, or help with documentation, follow the instructions on our [Start contributing](https://velero.io/docs/master/start-contributing/) documentation for guidance on how to setup Velero for development.
 
 ## Changelog
 
 See [the list of releases][6] to find out about feature changes.
 
 [1]: https://travis-ci.org/heptio/velero.svg?branch=master
 [2]: https://travis-ci.org/heptio/velero
-
 [4]: https://github.com/heptio/velero/issues
-[5]: https://github.com/heptio/velero/blob/master/CONTRIBUTING.md
 [6]: https://github.com/heptio/velero/releases
-
-[8]: https://github.com/heptio/velero/blob/master/CODE_OF_CONDUCT.md
 [9]: https://kubernetes.io/docs/setup/
 [10]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-with-homebrew-on-macos
 [11]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#tabset-1
 [12]: https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/dns/README.md
 [14]: https://github.com/kubernetes/kubernetes
-
 [24]: https://groups.google.com/forum/#!forum/projectvelero
 [25]: https://kubernetes.slack.com/messages/velero
-[26]: https://velero.io/docs/zenhub
-
 [28]: https://velero.io/docs/install-overview
 [29]: https://velero.io/docs/
 [30]: https://velero.io/docs/troubleshooting
-
 [99]: https://velero.io/docs/support-matrix
 [100]: /site/docs/master/img/velero.png
diff --git a/site/_data/master-toc.yml b/site/_data/master-toc.yml
@@ -35,6 +35,12 @@ toc:
         url: /backup-reference
       - page: Restore reference
         url: /restore-reference
+      - page: Run in any namespace
+        url: /namespace
+      - page: Extend with plugins
+        url: /plugins
+      - page: Extend with hooks
+        url: /hooks
   - title: Troubleshoot
     subfolderitems:
       - page: Troubleshooting
@@ -45,18 +51,16 @@ toc:
         url: /debugging-restores
       - page: Troubleshoot Restic
         url: /restic#troubleshooting
-  - title: Customize
+  - title: Contribute
     subfolderitems:
+      - page: Start Contributing
+        url: /start-contributing
+      - page: Development
+        url: /development
       - page: Build from source
         url: /build-from-source
-      - page: Run in any namespace
-        url: /namespace
-      - page: Extend
-        url: /extend
-      - page: Extend with plugins
-        url: /plugins
-      - page: Extend with hooks
-        url: /hooks
+      - page: Run locally
+        url: /run-locally
   - title: More information
     subfolderitems:
       - page: Backup file format

diff --git a/site/_data/v1-0-0-toc.yml b/site/_data/v1-0-0-toc.yml
@@ -60,4 +60,4 @@ toc:
       - page: API types
         url: /api-types
       - page: FAQ
-        url: /faq
+        url: /faq
diff --git a/site/_data/v1-1-0-toc.yml b/site/_data/v1-1-0-toc.yml
@@ -35,6 +35,12 @@ toc:
         url: /backup-reference
       - page: Restore reference
         url: /restore-reference
+      - page: Run in any namespace
+        url: /namespace
+      - page: Extend with plugins
+        url: /plugins
+      - page: Extend with hooks
+        url: /hooks
   - title: Troubleshoot
     subfolderitems:
       - page: Troubleshooting
@@ -45,18 +51,16 @@ toc:
         url: /debugging-restores
       - page: Troubleshoot Restic
         url: /restic#troubleshooting
-  - title: Customize
+  - title: Contribute
     subfolderitems:
+      - page: Start Contributing
+        url: /start-contributing
+      - page: Development
+        url: /development
       - page: Build from source
         url: /build-from-source
-      - page: Run in any namespace
-        url: /namespace
-      - page: Extend
-        url: /extend
-      - page: Extend with plugins
-        url: /plugins
-      - page: Extend with hooks
-        url: /hooks
+      - page: Run locally
+        url: /run-locally
   - title: More information
     subfolderitems:
       - page: Backup file format

diff --git a/site/community.md b/site/community.md
@@ -8,6 +8,11 @@ id: community
 
 If you’re a newcomer, check out the “[Good first issue](https://github.com/heptio/velero/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+first+issue%22)” and “[Help wanted](https://github.com/heptio/velero/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3A%22Help+wanted%22+)” labels in the Velero repository.
 
+Read how [we're using ZenHub](https://velero.io/docs/master/zenhub) for project and roadmap planning.
+
+If you are ready to jump in and test, add code, or help with documentation, follow the instructions on our [Start contributing](https://velero.io/docs/master/start-contributing/) documentation for guidance on how to setup Velero for development.
+
+
 You can follow the work we do, see our milestones, and our backlog on our [ZenHub board](https://app.zenhub.com/workspace/o/heptio/velero/boards?filterLogic=all&repos=99143276).
 
 * Follow us on Twitter at [@projectvelero](https://twitter.com/projectvelero)

diff --git a/site/docs/master/README.md b/site/docs/master/README.md
@@ -36,19 +36,7 @@ If you encounter issues, review the [troubleshooting docs][30], [file an issue][
 
 ## Contributing
 
-Thanks for taking the time to join our community and start contributing!
-
-Feedback and discussion are available on [the mailing list][24].
-
-### Before you start
-
-* Please familiarize yourself with the [Code of Conduct][8] before contributing.
-* See [CONTRIBUTING.md][5] for instructions on the developer certificate of origin that we require.
-* Read how [we're using ZenHub][26] for project and roadmap planning
-
-### Pull requests
-
-* We welcome pull requests. Feel free to dig through the [issues][4] and jump in.
+If you are ready to jump in and test, add code, or help with documentation, follow the instructions on our [Start contributing](https://velero.io/docs/master/start-contributing/) documentation for guidance on how to setup Velero for development.
 
 ## Changelog
 
@@ -58,10 +46,8 @@ See [the list of releases][6] to find out about feature changes.
 [2]: https://travis-ci.org/heptio/velero
 
 [4]: https://github.com/heptio/velero/issues
-[5]: https://github.com/heptio/velero/blob/master/CONTRIBUTING.md
 [6]: https://github.com/heptio/velero/releases
 
-[8]: https://github.com/heptio/velero/blob/master/CODE_OF_CONDUCT.md
 [9]: https://kubernetes.io/docs/setup/
 [10]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-with-homebrew-on-macos
 [11]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#tabset-1
@@ -70,12 +56,10 @@ See [the list of releases][6] to find out about feature changes.
 
 [24]: https://groups.google.com/forum/#!forum/projectvelero
 [25]: https://kubernetes.slack.com/messages/velero
-[26]: /zenhub.md
-
 
 [28]: install-overview.md
 [29]: https://velero.io/docs/master/
 [30]: troubleshooting.md
 
 [99]: support-matrix.md
-[100]: img/velero.png
+[100]: img/velero.png