Merge/piwi2

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

@@ -3,29 +3,34 @@ about: Create a report to help us improve the Strapi documentation.
 title: "[Bug]: "
 labels: "type: bug, status: pending reproduction"
 issue_body: true
-inputs:
+body:
 - type: input
   attributes:
     label: Link to the documentation page or resource
-    required: true
     placeholder: https://strapi.io/documentation/developer-docs/latest/somepage.html
+  validations:
+    required: true
 - type: textarea
   attributes:
     label: Describe the bug
-    required: true
     placeholder: "A clear and concise description of what the bug is."
+  validations:
+    required: true
 - type: textarea
   attributes:
     label: Additional context
-    required: false
     placeholder: "Add any other context about the problem here."
+  validations:
+    required: false
 - type: textarea
   attributes:
     label: Suggested improvements or fixes
-    required: false
     placeholder: "A clear and concise description of what you want to happen."
+  validations:
+    required: false
 - type: textarea
   attributes:
     label: Related issue(s)/PR(s)
-    required: false
     placeholder: "Let us know if this is related to any issue/pull request."
+  validations:
+    required: false

.github/ISSUE_TEMPLATE/DOC_REQUEST.yml

@@ -3,24 +3,28 @@ about: Suggest a new part of the documentation we are missing!
 title: "[Request]: "
 labels: "type: doc request"
 issue_body: false
-inputs:
+body:
 - type: textarea
   attributes:
     label: Summary
-    required: true
     placeholder: Quick summary what's this documentation request about.
+  validations:
+    required: true
 - type: textarea
   attributes:
     label: Why is it needed?
-    required: true
     placeholder: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]"
+  validations:
+    required: true
 - type: textarea
   attributes:
     label: Suggested solution(s)
-    required: false
     placeholder: "A clear and concise description of what you want to happen."
+  validations:
+    required: false
 - type: textarea
   attributes:
     label: Related issue(s)/PR(s)
-    required: false
     placeholder: "Let us know if this is related to any issue/pull request."
+  validations:
+    required: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -3,7 +3,7 @@ Hello 👋 Thank you for submitting a pull request.
 
 To help us merge your PR, make sure to follow the instructions below:
 
-- Create or update the documentation. (Should be made against the documentation branch)
+- Create or update the documentation. (Should be made against the `main` branch)
 - Create or update the tests.
 - Refer to the issue you are closing in the PR description - fix #issue
 - Specify if the PR is in WIP (work in progress) state or ready to be merged

.gitignore

@@ -105,3 +105,7 @@ dist
 
 # Other
 *.DS_Store
+
+# IDE
+.idea
+.vscode

CONTRIBUTING.md

@@ -20,36 +20,90 @@ This project and everyone participating in it are governed by the [Strapi Code o
 
 ## Documentation
 
-Pull requests relating to fixing documentation for the latest release should be directed towards the [documentation branch](https://github.com/strapi/documentation/tree/documentation) **not** towards the main branch. Any PRs made towards the main branch will not be released until the next Strapi version release.
+Pull requests relating to fixing documentation for the latest release should be directed towards the `main` branch.
 
 ## Bugs
 
 We are using [GitHub Issues](https://github.com/strapi/documentation/issues) to manage our public bugs. We keep a close eye on this so before filing a new issue, try to make sure the problem does not already exist.
 
 ---
 
-## Before Submitting a Pull Request
+## Submitting a Pull Request
 
 The core team will review your pull request and will either merge it, request changes to it, or close it.
 
-**Before submitting your pull request** make sure the following requirements are fulfilled:
+### Contribution Prerequisites
 
-- Fork the repository and create your branch from `documentation`.
-- Run `yarn` and `yarn dev` in the specific documentation root. (Please use yarn, not npm as we maintain a yarn.lock file instead of a package-lock.json)
-
-## Contribution Prerequisites
-
-- You have [Node](https://nodejs.org/en/) at v12 only (Node v13+ are not supported) and [Yarn](https://yarnpkg.com/en/) at v1.2.0+.
+<!-- TODO Update warning about using yarn when npm v7 is out since it will support yarn.lock files — see https://blog.npmjs.org/post/621733939456933888/npm-v7-series-why-keep-package-lockjson.html -->
+- You installed the following softwares:
+  - [Node](https://nodejs.org/en/) at v12 only (Node v13+ are not supported)
+  - [Yarn](https://yarnpkg.com/en/) at v1.2.0+. **Please use yarn**, not npm, as we maintain a `yarn.lock` file instead of `package-lock.json`
 - You are familiar with Git.
 
-## Development Workflow
+### Contribution Workflow
 
 <!-- TODO add contrib-docs and link here -->
 
-**Currently WIP**
+#### Setting up
+
+1. Fork the `documentation` repository.
+2. Clone your forked `documentation` repository.
+
+    ```bash
+    # HTTPS
+    git clone https://github.com/yourgithubname/documentation.git
+
+    # SSH
+    git clone git@github.com:yourgithubname/documentation.git
+    ```
+
+3. Enter in the folder which contains either the user documentation or developer documentation (depending on what you want to contribute to).
+
+    ```bash
+    #user documentation
+    cd documentation/user-docs
+
+    #developer documentation
+    cd documentation/developer-docs
+    ```
+
+4. From the `main` branch, retrieve the latest modifications to work on an up-to-date branch.
+
+    ```bash
+    git checkout main
+    git pull
+    ```
 
-At the moment we are under a contribution freeze from the community, we will update this guide once we lift the freeze.
+5. Create your own branch on which you will work on your documentation contribution. Make sure the name of your branch indicates both the type of documentation and the topic.
 
+    ```bash
+    #user documentation
+    git checkout -b <user/branch-name>
+
+    #developer documentation
+    git checkout -b <dev/branch-name>
+    ```
+
+6. Make sure all dependencies are installed, then run the server:
+
+    ```bash
+    yarn && yarn dev
+    ```
+
+#### Writing
+We can't provide you specific procedures with step-by-step instructions to write technical documentation. But if you have any question or need help, do feel free to reach us through [our forum](https://forum.strapi.io/).
+
+#### Sharing & reviewing
+
+1. Create a pull request from your forked `documentation` repository to the original `documentation` repository, to share your contribution to the documentation.
+2. Wait for your pull request to be reviewed by a Strapi team member.
+You do not need to assign anyone. Your pull request will be handled by our team in the next 48 hours (business days).
+3. *(optional)* Once the PR has been reviewed, you may have additional fixes to make before it's validated.
+
+Congratulations, and thank you for your contribution!
+Once your PR is validated, the Strapi team takes over and make sure your new content will soon be deployed!
+
+---
 ## Miscellaneous
 
 ### Repository Organization
@@ -64,11 +118,11 @@ We have various types of documentation that are maintained on their own:
 We have a few primary branches that are used for different purposes:
 
 - **main**
-  - This branch is used by the Strapi to push documentation on new features before they are released, it should not be used for PRs by the community unless instructed to do so by a Strapi team member
-- **documentation**
-  - This branch is for the current released version of Strapi, all documentation requests, updates, and removals should be pointed here
-- **docs/***
+  - This branch is used to store the current version of the documentation, all PRs should target this branch
+- **docs/\***
   - This collection of branches is for current work in progress changes, Strapi team members push our changes here to make PRs against the documentation branch
+- **feature/\***
+  - This is a collection of branches used as documentation for features currently in development in the main [strapi/strapi](https://github.com/strapi/strapi) repo
 
 ### Reporting an issue