Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move developer guidelines to contributing #4665 #4666

Merged
merged 7 commits into from
Apr 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

- Deleted duplicate import and fixed training URLs. @yahya-cloud [#4523](https://github.com/plone/volto/issues/4523)
- Fix grammar in PR #4542. @stevepiercy [#4555](https://github.com/plone/volto/issues/4555)
- Fix broken links at ReactJS.org. @stevepiercy [#4569](https://github.com/plone/volto/issues/4569)
- Fix broken links at `ReactJS.org`. @stevepiercy [#4569](https://github.com/plone/volto/issues/4569)
- Fix video warnings and link errors. @stevepiercy [#4578](https://github.com/plone/volto/issues/4578)


Expand Down
2 changes: 1 addition & 1 deletion docs/source/cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ myst:
# Cheatsheet

```{seealso}
{doc}`plone:contributing/myst-reference`
{doc}`plone:contributing/documentation/myst-reference`
```


Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@
"spelling_wordlist.txt",
"**/CHANGES.rst",
"**/LICENSE.rst",
"developer-guidelines/branch-policy.md",
"contributing/branch-policy.md",
]

html_extra_path = [
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
myst:
html_meta:
"description": "A guide on how to contribute to Volto, the frontend for Plone."
"property=og:description": "A guide on how to contribute to Volto, the frontend for Plone."
"property=og:title": "Contributing to Volto"
"keywords": "Volto, Plone, frontend, React, guidelines"
"description": "How to contribute to Volto, the frontend for Plone."
"property=og:description": "How to contribute to Volto, the frontend for Plone."
"property=og:title": "How to contribute to Volto, the frontend for Plone."
"keywords": "Plone, Volto, contributing, developer, guidelines"
---

(contributing-to-volto-label)=
Expand Down Expand Up @@ -33,11 +33,11 @@ In your report, please specify a few things:
- Include relevant screenshots, error messages, and stack traces.


(contributing-sign-and-return-the-plone-contributor-agreement-label)=
(contributing-volto-sign-and-return-the-plone-contributor-agreement-label)=

## Sign and return the Plone Contributor Agreement

The Volto Team reviews pull requests only from people with a GitHub account who have signed and returned the {ref}`Plone Contributor Agreement <contributing-sign-and-return-the-plone-contributor-agreement-label>`, and subsequently been assigned to a Plone Team in GitHub.
The Volto Team reviews pull requests only from people with a GitHub account who have signed and returned the {ref}`Plone Contributor Agreement <plone:contributing-sign-and-return-the-plone-contributor-agreement-label>`, and subsequently been assigned to a Plone Team in GitHub.


(contributing-branch-policy-label)=
Expand Down Expand Up @@ -89,6 +89,38 @@ Specifically:
- {doc}`./acceptance-tests`


(contributing-developer-guidelines-label)=

## Developer guidelines

Development and configuration of Volto is managed through your {ref}`choice of Plone installation method <install-index-choose-installation-method-label>`.
You may choose to install Plone via {ref}`containers <install-containers-label>` or from its {ref}`packages <install-packages-1-label>`.

```{todo}
When referring to installation and configuration of Plone's backend, this part of the Volto documentation may have obsolete content.
The most current information for installing and configuring Plone is in {ref}`install-index-label`.
Please report any issues in the [Volto issue tracker](https://github.com/plone/volto/issues/).
```

```{toctree}
:maxdepth: 1

design-principles
style-guide
language-features
linting
react
redux
routing
icons
testing
acceptance-tests
accessibility-guidelines
typescript
volto-core-addons
```


(contributing-final-advice-label)=

## Final advice
Expand Down
38 changes: 0 additions & 38 deletions docs/source/developer-guidelines/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ addons/index
backend/index
deploying/index
upgrade-guide/index
developer-guidelines/index
user-manual/index
contributing/index
release-notes/index
```
1 change: 1 addition & 0 deletions news/4666.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Rename "Developer Guidelines" to "Contributing". @stevepiercy