Skip to content

Commit

Permalink
Release: 4.1.12 documentation + community contributions (#918)
Browse files Browse the repository at this point in the history
* Use beta logo

* [beta] Add TS command (#800)

* Add TS command

Signed-off-by: soupette <[email protected]>

* Use shorter instead of quicker :-)

Co-authored-by: Pierre Wizla <[email protected]>

* [beta] Dark mode: Updates user guide + dev docs (#795)

* Document dark mode in user guide

* Add note in dev docs about custom theme extension and dark mode

* Improve instructions for Interface mode setting in User guide

* Add precisions in Dev docs callout for Dark mode

* Update admin profile screenshot

Co-authored-by: Mégane Lacheny <[email protected]>

* Slightly update wording for TS flag

* Update core store migration

* Added APP_KEYS to environmental variables table + fixed spelling error

* added link to middlewares documentation

* (WIP) Add permissions mapping tables

* Fix typo

* Added caution call out

* Updated the telemetry opt-out method

* Update amazon-aws.md: Wrong package mentioned (#830)

Line 333 mentioned to run "npm install strapi-provider-upload-aws-s3".
Above package is not working.
New working package is "@strapi/provider-upload-aws-s3"

* Missing information for plugin creation #834

As asked in the bug report here is a PR, unfortunately I am neither sure of where this information is best placed (as it might apply to other part of the framework configuration file as well) nor how to word it properly.

* Include APP_KEYS in Heroku Deployment Guide

Under title 5. Create your Strapi server config for production
Update env/production/server.js to include app -> keys object
Include bash command to set APP_KEYS environment variable on Heroku

* Added caution callout and small text + formatting revisions

* Apply suggestions from code review

Co-authored-by: Shaun Brown  <[email protected]>

* docs: improve the Laravel Documentation

* docs: fix typo in code section

* Update azure.md

* Finish adding permission mapping tables

* Remove typescript from production release

* Added migration guide

* Added link to 4.1.8 migration guide

* add comments for Shaun

* updated with Derrick's suggestions

* fixed spelling and phrasing

* add JWT_SECRET code snippet

* Fixed code for config/plugins

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.0.x-to-4.1.8.md

Co-authored-by: DMehaffy <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.0.x-to-4.1.8.md

Co-authored-by: DMehaffy <[email protected]>

* docs: fix typo (#853)

* make render.com hosting guide work with strapi version >= v4.0.6 (#832)

* make guide work with strapi v4

- set node version to 12.22.0 because install/build failed with 12.18.4 for i18n plugin.
- add APP_KEYS env variable because its required since v4.0.6

* Update render.md

Also add API_TOKEN_SALT variable to render.yaml blueprint file. It is needed since 4.1.8 See strapi/strapi#13126

* Add additional commands for Heroku environment variables config (#850)

* Add additional commands for Heroku environment variables config

* fix typo

* add random generation

* Fixed phrasing

Co-authored-by: Shaun Brown <[email protected]>

* Fixed config object example code

There was one } that wasn't needed

* remove API_TOKEN_SALT and APP_KEYS from env table

* Update routes.md

Fix missing comma

* update link style

* updated migration guide to match template.

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.0.x-to-4.1.8.md

Co-authored-by: Pierre Wizla <[email protected]>

* [v4 migration] MongoDB additions to data migration guide (#818)

* Add first draft of MongoDB migration instructions (w/o cheatsheet)

* Add raw, unedited cheatsheet for MongoDB vs. SQL differences

* Add new MongoDB related files to TOC

* Update data migration guide introduction

* Enhance MongoDB main guide

* Add MongoDB vs. SQL cheatsheet

* minor cleanup

Co-authored-by: derrickmehaffy <[email protected]>

* Lack one s in the file name middleware.js

* Changed time based fields from snake case to camel case

* docs: fixed command to start strapi (#870)

* Update plugins-extension.md (#876)

Correct way to push new routes while extending a plugin

* fix: use correct key parameter for azure deploy (#874)

Azure CLI uses `--account-key` rather than `--access-key` now

* Upload: improve code examples (#806)

* Upload: improve code examples

* Remove heading inside tab

* Merge 2 lines

* Format examples as code-group

Co-authored-by: Pierre Wizla <[email protected]>
Co-authored-by: Pierre Wizla <[email protected]>

* Update services.md (#880)

The service name is changed from `api::restaurant.restaurant` to `api::email.email` to avoid confusion.

* Remove useless callout (#888)

* Force node 14 (#890)

* Update latest supported versions & expand docs (#883)

* Update amazon-aws.md

Update versions to latest supported. Expanded comments on some code blocks

* Clarify instruction

* Update CONTRIBUTING.md

According to the `package.json` from the official Strapi repo, Node 16.x.x is now supported. [Reference](https://github.com/strapi/strapi/blob/e8215ffcd7aefae42a524670923c1cc34837400f/package.json#L124)

* Update Node's latest supported version

* Update Node's oldest supported version

* Remove useless callout (#888)

* Force node 14 (#890)

* Update CONTRIBUTING.md

* Update README.md

* Update amazon-aws.md

* Update amazon-aws.md

* Update amazon-aws.md

* Update amazon-aws.md

Update versions to latest supported. Expanded comments on some code blocks

* Clarify instruction

* Update CONTRIBUTING.md

According to the `package.json` from the official Strapi repo, Node 16.x.x is now supported. [Reference](https://github.com/strapi/strapi/blob/e8215ffcd7aefae42a524670923c1cc34837400f/package.json#L124)

* Update Node's latest supported version

* Update Node's oldest supported version

* Update CONTRIBUTING.md

* Update README.md

* Update amazon-aws.md

* Update amazon-aws.md

* Update amazon-aws.md

* Update leftover GraphQL plugin config structure

* Update docs/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/amazon-aws.md

Co-authored-by: Pierre Wizla <[email protected]>
Co-authored-by: DMehaffy <[email protected]>

* Fix wrong wording in model information (#887)

* Add migration guide to 4.1.10 (#885)

* add migration guide to 4.1.10

* Update file name

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.1.8+-to-4.1.10.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.1.8+-to-4.1.10.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.1.8+-to-4.1.10.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.1.8+-to-4.1.10.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.1.8+-to-4.1.10.md

Co-authored-by: Pierre Wizla <[email protected]>

* Add redirects plugin and rename v4 migration guides to match new std

Co-authored-by: Pierre Wizla <[email protected]>
Co-authored-by: derrickmehaffy <[email protected]>

* Fix predefined hook's name. (#884)

* Strapi-maintained plugins descriptions (#833)

* Added content

* Added content about plugins

* added png files for plugins

* added more logo png files

* fixed missing file extension

* Revised and added content

* Revised text and table cleanup

* Revised Gatsby preview plugin content

* revised intro section

* fixed spelling and formatting

* Revised Email plugin

* Added comment for U&P default deprecation

* Added content for Sentry plugin

* removed empty line

* GraphQL description improvement & Market reference cleanup

* added sidebarDepth

* Edit introduction

* fixed punctuation etc + Mégane's suggestions

* Revised the SEO plugin description

* Update docs/user-docs/latest/plugins/strapi-plugins.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/user-docs/latest/plugins/strapi-plugins.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/user-docs/latest/plugins/strapi-plugins.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/user-docs/latest/plugins/strapi-plugins.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/user-docs/latest/plugins/strapi-plugins.md

Co-authored-by: Pierre Wizla <[email protected]>

* fixed various issues

* Add dark reader-friendly logos

* Update docs/user-docs/latest/plugins/strapi-plugins.md

Co-authored-by: meganelacheny <[email protected]>

* Update docs/user-docs/latest/plugins/strapi-plugins.md

Co-authored-by: meganelacheny <[email protected]>

* fixed spelling

* Update docs/user-docs/latest/plugins/strapi-plugins.md

Co-authored-by: meganelacheny <[email protected]>

* Delint and small wording fixes

* fixed typos and formatting

* updated the Gatsby preview plugin details

Co-authored-by: Pierre Wizla <[email protected]>
Co-authored-by: meganelacheny <[email protected]>

* Remove populateCreatorFields from models (#881)

* Add NodeJS link to NODE_ENV=production (#879)

* changed env example

* add NODE_ENV callout

* added Nodejs link to explain NODE_ENV=production

* Update table "note" format

Co-authored-by: Pierre Wizla <[email protected]>

* Fix the example code for registering hooks (#877)

Code was broken several places:
- you need to return an object with the original arguments, not an array
- you cannot always write JSX directly in a .js file (according to your configuration)

Co-authored-by: Pierre Wizla <[email protected]>

* Update update-version.md

* typo

* Update services.md (#896)

Just add a missing parentheses in the example code.

* Removed the getPlugin part for content-manager 

Hi,

I have updated the docs because it contains an issue on line 122 in the bootstrap function.
According to the previous docs the following code was needed:

```
  app
        .getPlugin('content-manager')
        .injectContentManagerComponent('editView', 'right-links', { name: 'my-compo', Component: () => 'my-compo' })
```

Instead the right way of doing it and results in working code below. Since there is already a build in function to inject components in the content manager section by calling "injectContentManagerComponent":

```
  app.injectContentManagerComponent('editView', 'right-links', { name: 'my-compo', Component: () => 'my-compo' })
```

* Add caution call out to documentation plugin

* Update docs/developer-docs/latest/plugins/documentation.md

Great suggestion!

Co-authored-by: meganelacheny <[email protected]>

* Add caution callout above custom routes config (#901)

* Add caution callout above custom routes config

* Simplify callout wording and make example more explicit

Co-authored-by: Pierre Wizla <[email protected]>

* docs typo (#871)

* Configure last-updated plugin output (#905)

* Replace logo with SVG version

To fix resolution issues pointed out by Aurélien :-)
Thanks Daniele Brusca!

* Add 2x PNG logo

Just in case

* Add a tip to content type schema migration page and link to Codemods (#902)

* Update content-type-schema.md

* Update content-type-schema.md

* Update for brevity

Co-authored-by: Pierre Wizla <[email protected]>

* Fix missing closing tip markup + improve wording

* Improve wording further for codemods tip

* Update populating-fields.md (#913)

correct the operator name

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Bump version number

Co-authored-by: derrickmehaffy <[email protected]>
Co-authored-by: cyril lopez <[email protected]>
Co-authored-by: Mégane Lacheny <[email protected]>
Co-authored-by: Shaun Brown <[email protected]>
Co-authored-by: Dan Siddoway <[email protected]>
Co-authored-by: Shaun Brown <[email protected]>
Co-authored-by: spreadcharm <[email protected]>
Co-authored-by: Dimitri Gilbert <[email protected]>
Co-authored-by: David <[email protected]>
Co-authored-by: Daniel Sum <[email protected]>
Co-authored-by: Mohammed Muqtadir Ahad <[email protected]>
Co-authored-by: Alisan Stoll <[email protected]>
Co-authored-by: Nico Hofmair <[email protected]>
Co-authored-by: Adria Lopez <[email protected]>
Co-authored-by: Elías Leyton <[email protected]>
Co-authored-by: Thomas PEDOT <[email protected]>
Co-authored-by: Richard <[email protected]>
Co-authored-by: NiWA <[email protected]>
Co-authored-by: Rajat <[email protected]>
Co-authored-by: Thomas F. K. Jorna <[email protected]>
Co-authored-by: Gustav Hansen <[email protected]>
Co-authored-by: Rajat <[email protected]>
Co-authored-by: André Vital <[email protected]>
Co-authored-by: Pierre Noël <[email protected]>
Co-authored-by: horiken <[email protected]>
Co-authored-by: Pascal Vaccaro <[email protected]>
Co-authored-by: Grim <[email protected]>
Co-authored-by: Jean-Baptiste Crestot <[email protected]>
Co-authored-by: Alejandro Llanes <[email protected]>
Co-authored-by: Kevin Vugts <[email protected]>
Co-authored-by: Fabien del Carmen <[email protected]>
Co-authored-by: alex <[email protected]>
Co-authored-by: Ignacio Tonoli de Maussion <[email protected]>
Co-authored-by: Ben <[email protected]>
  • Loading branch information
Show file tree
Hide file tree
Showing 15 changed files with 154 additions and 129 deletions.
158 changes: 74 additions & 84 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]: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.
9 changes: 9 additions & 0 deletions docs/.vuepress/config/plugins.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
{
Expand Down
2 changes: 1 addition & 1 deletion docs/.vuepress/config/theme-config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const themeConfig = {
logo: '/assets/logo.png',
logo: '/assets/logo.svg',
nav: [
{
text: 'Resource Center',
Expand Down
Binary file added docs/.vuepress/public/assets/logo-2x.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

1 comment on commit db75053

@vercel
Copy link

@vercel vercel bot commented on db75053 Jun 1, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

documentation – ./

documentation-strapijs.vercel.app
docs-vercel-v4.strapi.io
documentation-git-production-strapijs.vercel.app

Please sign in to comment.