Update docs

Move README.md to the docs folder replacing the existing content there. We will use this for the Dashboard landing page on the website. GitHub will display the content of this new docs/README.md on the repo landing page. Update contributing doc to describe the Dashboard process since it doesn't use the TEP process described in the community repo. Also update links to work both on GitHub and on the website (relative URLs can be problematic in some cases).
pmdarius · May 16, 2022 · b34b049 · b34b049
1 parent a5190bd
commit b34b049
Show file tree

Hide file tree

Showing 18 changed files with 565 additions and 266 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -20,16 +20,40 @@ on:
   [code](https://github.com/tektoncd/community/blob/main/standards.md#coding-standards)
 - [Processes](https://github.com/tektoncd/community/blob/main/process.md) like
   [finding something to work on](https://github.com/tektoncd/community/blob/main/process.md#finding-something-to-work-on),
-  [proposing features](https://github.com/tektoncd/community/blob/main/process.md#proposing-features),
-  [reviews](https://github.com/tektoncd/community/blob/main/process.md#reviews)
-  and
-  [becoming an OWNER](https://github.com/tektoncd/community/blob/main/process.md#owners)
+  [reviews](https://github.com/tektoncd/community/blob/main/process.md#reviews),
+  and [becoming an OWNER](https://github.com/tektoncd/community/blob/main/process.md#owners)
 
 You can find details on our automation infrastructure in
 [the plumbing repo](https://github.com/tektoncd/plumbing).
 
----
 
-Except as otherwise noted, the content of this page is licensed under the [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/).
+## Proposing features
+
+If you have an idea for a feature, or if you have a solution for an existing
+issue that involves an API or UI change, we highly suggest that you propose the
+changes before implementing them.
+
+This is for two main reasons:
+
+1. [Yes is forever](https://twitter.com/solomonstre/status/715277134978113536)
+2. It's easier/cheaper to make changes before implementation (and you'll feel
+   less emotionally invested!)
+
+Post in the #dashboard channel on [slack](https://github.com/tektoncd/community/blob/main/contact.md#slack)
+or create a [new issue](https://github.com/tektoncd/dashboard/issues/new/choose) and fill in the feature request template.
+
+A great proposal will include:
+
+- **The use case(s) it solves** Who needs this and why?
+- **Requirements** What needs to be true about the solution?
+- **Alternative proposals** Even if alternatives aren't obvious, forcing
+  yourself to brainstorm a couple more approaches may give you new ideas or make
+  clear that your initial proposal is the best one
+
+Also feel free to reach out to us on [slack](https://github.com/tektoncd/community/blob/main/contact.md#slack) if you want any help/guidance.
+
+Thanks so much!!
+
+---
 
-Code samples are licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
+Except as otherwise noted, the content of this page is licensed under the [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/). Code samples are licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -8,6 +8,4 @@ Additional information:
 
 ---
 
-Except as otherwise noted, the content of this page is licensed under the [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/).
-
-Code samples are licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
+Except as otherwise noted, the content of this page is licensed under the [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/). Code samples are licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
diff --git a/README.md b/README.md