Release: 4.1.12 documentation + community contributions

CONTRIBUTING.md

@@ -18,132 +18,122 @@ Requests for new documentation are highly encouraged, this is not limited to new
 
 This project and everyone participating in it are governed by the [Strapi Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please read the [full text](CODE_OF_CONDUCT.md) so that you can read which actions may or may not be tolerated.
 
-## Documentation
+## Bugs
 
-Pull requests relating to fixing documentation for the latest release should be directed towards the `main` branch.
+We are using [GitHub Issues](https://github.com/strapi/documentation/issues) to manage our public bugs. Before submitting an issue you need to make sure:
 
-## Bugs
+- Checked for any existing pull requests that may address the same issue
+- Checked for any open issues related to your issue, if so, please provide context on that issue
+- Follow the issue template and try to fill out as much information as you can
+  - Issues not following the templates **will be closed**
+  - You may update the closed issue with the required information and it will be reopened
+- The issue is with the Strapi **documentation only**, code issues should be directed at the main [strapi/strapi](https://github.com/strapi/strapi) repo issues
+- If you are requesting documentation, please do feel free to make a pull request
+  - Documentation requests will be handled when we have free room within our roadmap
+  - Open requests **are not handled** in a "first come, first serve" basis, they are handled on a "best-effort" depending on the time required to produce
+- Do not ask technical questions about how to do something
+  - Questions should be directed at the following resources
+    - Open a Q&A thread on our [Official Forum](https://forum.strapi.io)
+    - Talk with other community members on our [Community Discord](https://discord.strapi.io)
 
-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.
+Please note that rude or impolite comments on issues that violate our [Code of Conduct](./CODE_OF_CONDUCT.md) will be deleted and issues that violate the COC will be closed.
 
 ---
 
 ## Submitting a Pull Request
 
 The core team will review your pull request and will either merge it, request changes to it, or close it.
 
-### Contribution Prerequisites
-
-<!-- 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 v14 only (Node v15+ 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.
-
-### Contribution Workflow
+### Setup and pull request creation
 
-#### Setting up
+Follow the procedure below to contribute to the Strapi documentation.
 
 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. From the `main` branch, retrieve the latest modifications to work on an up-to-date branch.
-
+    
+3. Enter the `developer-docs` folder to contribute to the [Developer Documentation](https://strapi.io/documentation/developer-docs/latest/getting-started/introduction.html), or the `user-docs` folder to contribute to the [User Guide](https://strapi.io/documentation/user-docs/latest/getting-started/introduction.html).
+    
     ```bash
-    git checkout main
-    git pull
+    # developer documentation
+    cd documentation/docs/developer-docs
+
+    # user documentation
+    cd documentation/docs/user-docs
     ```
-
-4. Create your own branch. Make sure the name of your branch indicates both the type of documentation and the topic.
-
+    
+4. Choose the branch from which to work: either `main` for a contribution on the latest, current version or Strapi ; or `v[x]` for a contribution on a previous version of Strapi.
+    
     ```bash
-    #user documentation
-    git checkout -b <user/branch-name>
-
-    #developer documentation
-    git checkout -b <dev/branch-name>
+    #current version of Strapi (i.e. v4)
+    git checkout main
+    
+    #previous version of Strapi (e.g. v3)
+    git checkout v3
     ```
-
-5. Enter in the folder which contains the whole VuePress documentation project.
-
+
+    <aside>
+    ✋ Previous, non-current versions of the Strapi documentation are only maintained for 6 months after the release of the latest, current version.
+
+    </aside>
+
+5. From your chosen branch, retrieve the latest modifications to work on an up-to-date branch.
+
     ```bash
-    cd docs
+    git pull
     ```
-
-6. Make sure all dependencies are installed
-
+    
+6. Create your own branch, based on either `main` or `v[x]` , 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
-    yarn 
+    # developer documentation
+    git checkout -b <dev/branch-name>
+
+    # user documentation
+    git checkout -b <user/branch-name>
+
     ```
 
-7. Start the documentation server
 
-    ```bash
-    # Launch the full documentation
-    yarn dev
+You are now ready to contribute to the Strapi documentation! 🚀
 
-    # Launch only the developer docs
-    yarn dev:dev
+🤗 Make sure to follow the [12 Rules of Technical Writing](https://handbook.strapi.io/user-success-manual/12-rules-of-technical-writing) and the [Strapi Documentation Style Guide](https://handbook.strapi.io/user-success-manual/strapi-documentation-style-guide) when writing your documentation contribution. These documents are meant to help you write a contribution that fits the whole Strapi documentation and make the reviewing process easier and quicker.
 
-    # Launch only the user docs
-    yarn dev:user
-    ```
+When you are finished writing, create a pull request from your forked repository to the original `documentation` repository (see [the GitHub docs](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) for more information).
 
+✋ To be able to submit your contribution, you must sign the CLA (Contributor License Agreement), directly via GitHub (see [our dedicated blog post](https://strapi.io/blog/switching-from-dco-to-cla) for more information).
 
+### Pull request review and management
 
-#### Writing
-We can't provide you specific procedures with step-by-step instructions to write technical documentation. But our ["12 Rules of Technical Writing"](https://handbook.strapi.io/user-success-manual/12-rules-of-technical-writing) and [style guide](https://handbook.strapi.io/user-success-manual/strapi-documentation-style-guide) should help you get started. If you have any question or need help, do feel free to reach us through [our forum](https://forum.strapi.io/).
+Read the information below to know how your contribution will be handled by the Strapi Documentation team until it is merged and deployed.
 
-#### Sharing & reviewing
+#### Handling
 
-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.
+When a new pull request is submitted in the Strapi `documentation` repository, it is handled in the following week, meaning that the Strapi team:
 
-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!
+- acknowledges the new pull request, leaving a 👀 reaction on the description
+- tags the pull request, to indicate the type of documentation that is being updated, and optionally the level of priority for the contribution
+- assigns the pull request to a member of the Strapi Documentation team, who will be in charge of the reviewing and merging
 
----
-## Miscellaneous
+#### Review
 
-### Repository Organization
+Once all of the handling steps are done by the Strapi team, you can expect your pull request to be reviewed in the next week or so.
 
-We have various types of documentation that are maintained on their own:
+Here is what the Strapi Documentation team will review in your pull request:
 
-- `developer-docs`
-  is tailored for developers and administrators and provide documentation on the technical aspects of Strapi
-- `user-docs`
-  is tailored for users and content-creators of Strapi and outline the user interface and usage of Strapi
+- The accuracy and coherence of the contribution, by testing any new piece of code or action for example,
+- The quality of the technical writing, to make sure it is proper technical documentation that is easy to understand (see [12 Rules of Technical Writing](https://www.notion.so/12-Rules-of-Technical-Writing-c75e080e6b19432287b3dd61c2c9fa04))
+- The fit of the contribution among the rest of the Strapi documentation (see [Strapi Documentation Style Guide](https://www.notion.so/Strapi-Documentation-Style-Guide-b9c21387732741ed8b0a3f9701612577))
 
-All v4 PRs should target the `main` branch.
-If you wish to update Strapi v3 documentation, target the `v3`.
+The pull request will be validated once the contribution ticks all the boxes. At least the validation of the Strapi Documentation team member in charge of the pull request is necessary for it to be merged.
 
+#### Deployment
 
-### Reporting an issue
+Once your pull request is validated and merged, it will be deployed with the next batch of merged pull requests. The Strapi Documentation team only deploys the documentation on Wednesdays, but not every week.
 
-Before submitting an issue you need to make sure:
+Every documentation deployment is communicated through a message in [the "News" section of the Strapi forum](https://forum.strapi.io/c/news/5).
 
-- Checked for any existing pull requests that may address the same issue
-- Checked for any open issues related to your issue, if so, please provide context on that issue
-- Follow the issue template and try to fill out as much information as you can
-  - Issues not following the templates **will be closed**
-  - You may update the closed issue with the required information and it will be reopened
-- The issue is with the Strapi **documentation only**, code issues should be directed at the main [strapi/strapi](https://github.com/strapi/strapi) repo issues
-- If you are requesting documentation, please do feel free to make a pull request
-  - Documentation requests will be handled when we have free room within our roadmap
-  - Open requests **are not handled** in a "first come, first serve" basis, they are handled on a "best-effort" depending on the time required to produce
-- Do not ask technical questions about how to do something
-  - Questions should be directed at the following resources
-    - Open a Q&A thread on our [Official Forum](https://forum.strapi.io)
-    - Talk with other community members on our [Community Slack](https://slack.strapi.io)
 
-Please note that rude or impolite comments on issues that violate our [Code of Conduct](./CODE_OF_CONDUCT.md) will be deleted and issues that violate the COC will be closed.

docs/.vuepress/config/plugins.js

@@ -21,6 +21,15 @@ const checklinksIgnoredFiles = [
 
 const plugins = [
   ['vuepress-plugin-element-tabs', {}],
+  ['@vuepress/last-updated',
+    {
+      transformer: (timestamp, lang) => {
+        const date = new Date(timestamp);
+        const options = { weekday: 'long', year: 'numeric', month: 'long', day: 'numeric' };
+        return date.toLocaleDateString('en-US', options)
+      }
+    }
+  ],
   [
     'check-md',
     {

docs/.vuepress/config/theme-config.js

@@ -1,5 +1,5 @@
 const themeConfig = {
-  logo: '/assets/logo.png',
+  logo: '/assets/logo.svg',
   nav: [
     {
       text: 'Resource Center',