Skip to content

Latest commit

 

History

History
153 lines (102 loc) · 6.85 KB

CONTRIBUTING.md

File metadata and controls

153 lines (102 loc) · 6.85 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 efforts to contribute are highly appreciated, we recommend you talk to a maintainer prior to spending a lot of time making a pull request that may not align with the project roadmap.

Open Development & Community Driven

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

The core team and the contributors send pull requests which go through the same validation process.

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.

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 this code. Please read the full text so that you can read which actions may or may not be tolerated.

Documentation

Pull requests relating to fixing documentation for the latest release should be directed towards the main branch.

Bugs

We are using GitHub 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.

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

  • You installed the following softwares:
    • Node at v12 only (Node v13+ are not supported)
    • Yarn 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

Setting up

  1. Fork the documentation repository.

  2. Clone your forked documentation repository.

    # 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.

    git checkout main
git pull

  4. Create your own branch. Make sure the name of your branch indicates both the type of documentation and the topic.

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

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

  5. Enter in the folder which contains the whole VuePress documentation project.

    cd docs

  6. Make sure all dependencies are installed

    yarn

  7. Start the documentation server

    # Launch the full documentation
yarn dev

# Launch only the developer docs
yarn dev:developer

# Launch only the user docs
yarn dev:user

Writing

We can't provide you specific procedures with step-by-step instructions to write technical documentation. But our "12 Rules of Technical Writing" and style guide should help you get started. If you have any question or need help, do feel free to reach us through our forum.

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

We have various types of documentation that are maintained on their own:

  • developer-docs
    • This documentation is tailored for developers and administrators and provide documentation on the technical aspects of Strapi
  • user-docs
    • This documentation is tailored for users and content-creators of Strapi and outline the user interface and usage of Strapi

We have a few primary branches that are used for different purposes:

  • main
    • 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 repo

Reporting an issue

Before submitting an issue you need to make sure:

  • 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 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
  • Rude or impolite comments on issues that violate our Code of Conduct will be deleted and issues that violate the COC will be closed