Skip to content

Latest commit

 

History

History
142 lines (86 loc) · 6.49 KB

CONTRIBUTING.md

File metadata and controls

142 lines (86 loc) · 6.49 KB
Raw

Contribute to the Strapi documentation

Strapi is an open-source project administered by the Strapi team. We appreciate your interest and efforts to contribute to Strapi.

All contributions are highly appreciated, we recommend you talk to a maintainer prior to investing a lot of time in a pull request that may not align with the project roadmap. Please note that contributions, pull requests, and issues should be written in English.

Open Development & Community Driven

Strapi is an open-source project. See the LICENSE file for licensing information. All of the work is available on GitHub.

The core team and contributors submit pull requests that go through the same validation process.

Code of Conduct

This project and everyone participating in it are governed by the Strapi Code of Conduct. By participating, you are expected to uphold the code.

Documentation Requests

Requests for new documentation are highly encouraged, this is not limited to new additions but also changes or more information requested on existing documentation. Please use our request documentation issue template.

Bugs

Bug reports help to improve the documentation. Please use our Documentation Bug Report template to report documentation bugs. To submit an issue:

  • Follow the issue template and fill out as much information as you can.
  • Verify the issue is only with the Strapi documentation, code issues should be directed at the main strapi/strapi repository.

Technical questions should be asked using the following resources:

Pull Requests

The core team reviews community pull requests and either merges, requests changes, or comments and closes the pull request. You can open a documentation pull request by:

  • clicking the Improve this page link at the bottom of any documentation page to directly edit in GitHub,
  • forking the documentation repository and working locally.

Setup and write locally

The following procedure allows you to work locally on the Strapi documentation.

  1. Fork the documentation repository.

  2. Clone your forked documentation repository.

    git clone git@github.com:yourgithubname/documentation.git

  3. Enter the developer-docs folder to contribute to the Developer Documentation, or the user-docs folder to contribute to the User Guide.

    # developer documentation
cd documentation/docs/developer-docs

# user documentation
cd documentation/docs/user-docs

  4. Choose the branch from which to work: either main for a contribution on the current version of Strapi or v[x] for a contribution on a previous version of Strapi.

    #current version of Strapi (i.e. v4)
git checkout main

#previous version of Strapi (e.g. v3)
git checkout v3
    ✋ Previous, non-current versions of the Strapi documentation are only maintained for 6 months after the release of the latest, current version.

  5. From your chosen branch, retrieve the latest modifications to work on an up-to-date branch.

    git pull

  6. Create your branch, based on either main or v[x], to work on your documentation contribution. Make sure your branch name indicates both the type of documentation and the topic.

    # developer documentation
git checkout -b <dev/branch-name>

# user documentation
git checkout -b <user/branch-name>

  7. Run the docs on your computer

  cd docs

  # Install dependencies
  yarn

  # Run user and developer-docs
  yarn dev

  # Run developer-docs only
  yarn dev:dev

  # Run user-docs only
  yarn dev:user

The project is now up and running at http://localhost:8080 and you should be able to access it in your browser.

You are now ready to contribute to the Strapi documentation! 🚀

Write technical documentation

The Strapi documentation follows the Google Style Guide. The Highlights section provides information on tone, structure, and formatting.

The Strapi Formatting Style Guide has formatting guidelines and how to implement formatting in markdown files.

When you are finished writing, create a pull request from your forked repository to the original documentation repository (see the GitHub docs for more information) or use the Create a new branch for this commit and start a pull request option if you are using the GitHub web browser interface (see the GitHub docs).

✋ Sign the CLA (Contributor License Agreement), directly via GitHub (see our dedicated blog post for more information).

Review and management of pull requests

The pull request review process and timeline are based on the availability of Strapi's Documentation team to handle community contributions. The workflow is:

  1. The pull request is assigned to a member of the Documentation team.
  2. At least 1 member of the Documentation team will review the pull request for:
  • accuracy,
  • quality,
  • alignment with the documentation scope and roadmap.
  1. Reviewers will either approve, ask for changes, or reject the pull request.
  2. Accepted pull requests will be merged and deployed as part of the regular documentation deployments on Wednesdays every 2 weeks.

Every documentation deployment is communicated through a message in the "News" section of the Strapi forum.