Skip to content

Commit

Permalink
Update README introduction to mention issues vs. requests + various w…
Browse files Browse the repository at this point in the history
…ebsites (#1885)

* Update introduction to mention issues vs. requests + various websites

* Clarify timeline for docs-next and v5
  • Loading branch information
pwizla authored Oct 25, 2023
1 parent 4c8122d commit 6f4e5ec
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,16 @@ Strapi is a free and open-source headless CMS that delivers your content anywher
- **Database agnostic**. You can choose the database you prefer. Strapi works with SQL databases: PostgreSQL, MySQL, MariaDB, and SQLite.
- **Customizable**. You can quickly build your logic by fully customizing APIs, routes, or plugins to fit your needs perfectly.

## Documentation websites

The main official Strapi documentation website is hosted at [docs.strapi.io](https://docs.strapi.io).

Additional official Strapi documentation websites cover different content:

- Documentation for the older, unsupported version 3 of Strapi is hosted at [docs-v3.strapi.io](https://docs-v3.strapi.io).
- Upcoming and/or experimental documentation is hosted at [docs-next.strapi.io](https://docs-next.strapi.io). Starting autumn/winter 2023, this website will include in-progress documentation for Strapi v5.
- Documentation for contributors, which include more in-depth and experimental content for developers who actively maintain and contribute to Strapi, is hosted at [contributor.strapi.io](https://contributor.strapi.io). This experimental documentation is maintained by Strapi engineers and any issue should be reported to the [`strapi/strapi`](https://github.com/strapi/strapi/issues/new/choose) repository.

## Contribution requirements

The following are required if you are submitting pull requests to the documentation:
Expand All @@ -30,22 +40,22 @@ The following are required if you are submitting pull requests to the documentat

👉 For more information on how to contribute, please read our [contribution guide](./CONTRIBUTING.md).

## 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](https://github.com/strapi/documentation/issues/new?template=DOC_REQUEST.md&title%5B%5D=REQUEST) issue template.

## Bugs
## Issues

Bug reports help to improve the documentation. Please use our [documentation bug report](https://github.com/strapi/documentation/issues/new?template=BUG_REPORT.yml) template to report documentation bugs. To submit an issue:
Submitting issues help to improve the documentation. If you find incorrect screenshot(s), instructions, or code examples, or if you discover UX/UI bugs on the website, please use our [documentation issue](https://github.com/strapi/documentation/issues/new?template=BUG_REPORT.yml) template to report them. To submit an issue:

1. Verify the issue is only with the Strapi documentation, code issues should be directed at the main [strapi/strapi](https://github.com/strapi/strapi) repository.
1. Verify the issue is only with one of the Strapi documentation websites. Product-related issues, missing Strapi features, and any issues not directly related to the documentation should be directed at the main [strapi/strapi](https://github.com/strapi/strapi) repository.
2. Follow the issue template and fill out as much information as you can.

Technical questions should be asked using the following resources:

- Open a Q&A thread on our [official forum](https://forum.strapi.io).
- Engage with other community members on our [community Discord server](https://discord.strapi.io).

## 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](https://github.com/strapi/documentation/issues/new?template=DOC_REQUEST.md&title%5B%5D=REQUEST) issue template. These requests will be checked by the Strapi Documentation team then transferred to another internal tool outside GitHub for priorization and subsequent actions.

## Releases

Thanks to a continuous integration/continuous delivery workflow, the Strapi documentation can be updated up to several times a day, depending on the number and frequency of contributions. Weekly snapshot [releases](https://github.com/strapi/documentation/releases) happen on Wednesdays and include a list of changes since the latest release.
Expand Down

1 comment on commit 6f4e5ec

@vercel
Copy link

@vercel vercel bot commented on 6f4e5ec Oct 25, 2023

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 – ./

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

Please sign in to comment.