An open API service indexing awesome lists of open source software.

https://github.com/plone/documentation

Plone Documentation
https://github.com/plone/documentation

documentation myst plone sphinx volto

Last synced: 2 months ago
JSON representation

Plone Documentation

Awesome Lists containing this project

README

          

[![Testing Status](https://github.com/plone/documentation/actions/workflows/test.yml/badge.svg?branch=6.0 "Testing Status")](https://github.com/plone/documentation/actions/workflows/test.yml)

# Plone Documentation

This is the repository for Plone Documentation.

## Plone 6

Browse the Plone 6 Documentation at https://6.docs.plone.org/.

Active development on the Plone 6 Documentation takes place on the branch [`6.0`](https://github.com/plone/documentation/tree/6.0).

## Plone 5.2

Browse the Plone 5.2 Documentation at https://5.docs.plone.org/.

Development on the Plone 5.2 Documentation takes place on the branch [`5.2`](https://github.com/plone/documentation/tree/5.2).

## Contribute

- [Contributing to Plone 6 Documentation](https://6.docs.plone.org/contributing/index.html)
- [Release Plone 6 docs Project Board](https://github.com/orgs/plone/projects/12)
- [Issue Tracker](https://github.com/plone/documentation/issues)
- [Source Code](https://github.com/plone/documentation/tree/6.0)

### Contributing to frontend (Volto), `plone.api`, and `plone.restapi` documentation

Plone documentation consists of this repository, `plone/documentation`, and it includes external packages' documentation through git submodules.
Those packages include:

- [`volto`](https://github.com/plone/volto)
- [`plone.api`](https://github.com/plone/plone.api)
- [`plone.restapi`](https://github.com/plone/plone.restapi)

To contribute documentation, please open a pull request in the appropriate repository.
For details, see [Editing external package documentation](https://6.docs.plone.org/contributing/index.html#contributing-editing-external-package-documentation-label).

## Support

For technical support for **Plone documentation only**, please ask a question on our [Community Forum, Documentation category](https://community.plone.org/c/documentation/13).

For technical support for **Plone in general**, please ask a question on our [Community Forum](https://community.plone.org/) in the appropriate category.

## Training

[Training](https://github.com/plone/training) is a collection of different trainings, developed and created by the Plone Community.

For an HTML version, please browse to our [Training Website](https://training.plone.org/).

## License

The project is licensed under the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/) by the [Plone Foundation](https://plone.org).