Merge pull request plone#1478 from plone/contributing-plone-core-code

Create Plone Core Code contributing documentation

Author: stevepiercy

docs/conf.py

@@ -80,7 +80,7 @@
     r"http://yoursite",
     r"https://www.linode.com",
     r"https://vhs-ehrenamtsportal.de", # SSLError(SSLCertVerificationError
-    r"https://github.com/orgs/plone/teams/developers",  # requires auth
+    r"https://github.com/orgs/plone/teams/",  # requires auth
     r"https://github.com/plone/documentation/issues/new/choose",  # requires auth
     # Ignore specific anchors
     r"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors#Identifying_the_issue",

docs/contributing/admins.md docs/contributing/documentation/admins.mddocs/contributing/admins.md renamed to docs/contributing/documentation/admins.md

@@ -0,0 +1,321 @@
+---
+myst:
+  html_meta:
+    "description": "Contributing to Plone 6 Documentation"
+    "property=og:description": "Contributing to Plone 6 Documentation"
+    "property=og:title": "Contributing to Plone 6 Documentation"
+    "keywords": "Plone, Plone Contributor Agreement, License, Code of Conduct"
+---
+
+(contributing-documentation-index-label)=
+
+# Contributing to documentation
+
+This document describes how to contribute to Plone Documentation.
+
+Contributions to the Plone Documentation are welcome.
+
+
+(contributing-permission-to-publish-label)=
+
+## Granting permission to publish
+
+Before you contribute, you must give permission to publish your contribution according to the license we use.
+You may give that permission in two ways.
+
+- Sign the [Plone Contributor Agreement](https://plone.org/foundation/contributors-agreement).
+  This method also covers contributions to Plone code.
+  It is a one-time only process.
+- In every pull request or commit message, include the following statement.
+
+  > I, [full name], agree to have this contribution published under Creative Commons 4.0 International License (CC BY 4.0), with attribution to the Plone Foundation.
+
+The Plone Documentation is licensed under the [Creative Commons Attribution 4.0 International License (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/).
+A copy of the license is included in the root of this repository.
+
+
+(contributing-roles-label)=
+
+## Contributor roles
+
+Contributors to the Plone Documentation may perform one or many roles.
+
+- **Plone users and developers** use this documentation because it is accurate and actively maintained.
+  People in these roles typically contribute minor corrections.
+  They should read {doc}`setup-build` and {doc}`myst-reference`.
+- **Authors** create Plone Documentation.
+  They should read {doc}`setup-build` and {doc}`myst-reference`.
+  They should also read {doc}`authors` for guidance and tips for writing good technical documentation.
+
+
+(contributing-quality-requirements-label)=
+
+## Documentation quality requirements
+
+We use GitHub Actions with every pull request to enforce Plone Documentation quality.
+We recommend that you build the documentation locally to catch errors and warnings early on.
+See {doc}`setup-build` for instructions for how to set up and build the documentation and to run quality checks.
+
+
+(contributing-manage-on-github-label)=
+
+## Making contributions on GitHub
+
+Contributions are managed through git repositories on GitHub.
+
+-   [`documentation`](https://github.com/plone/documentation)
+-   [`plone.api`](https://github.com/plone/plone.api)
+-   [`plone.restapi`](https://github.com/plone/plone.restapi)
+-   [`volto`](https://github.com/plone/volto)
+
+In the Plone organization, it is strongly recommended that you read {ref}`contributing-permission-to-publish-label` and take appropriate action.
+
+After your Plone Contributor Agreement has been approved, and you have been added to the Plone GitHub organization as a member of the [Developers](https://github.com/orgs/plone/teams/developers) team, we recommend that you follow our guidelines.
+
+1.  Discuss whether you should perform any work.
+    Any method below is acceptable, but are listed in order of most likely to get a response.
+
+    -   Search for open issues in the issue trackers of documented projects, and comment on them.
+        If an issue does not already exist for what you want to work on, then create a new issue in its issue tracker.
+
+        As a convenience, at the top right of every page, there is a GitHub navigation menu.
+        Tap, click, or hover over the GitHub Octocat icon for options.
+
+        ```{image} /_static/github-navigation.png
+        :alt: GitHub navigation menu 
+        ```
+
+        You can use this menu to quickly navigate to the `documentation` source repository or open an issue.
+        Note that this navigation convenience is provided only for the `documentation` repository.
+
+        -   [`documentation`](https://github.com/plone/documentation/issues)
+        -   [`plone.api`](https://github.com/plone/plone.api/issues)
+        -   [`plone.restapi`](https://github.com/plone/plone.restapi/issues)
+        -   [`volto`](https://github.com/plone/volto/issues)
+
+    -   Discuss during sprints, conferences, trainings, and other Plone events.
+    -   Ask on the [Plone Community Forum, Documentation topic](https://community.plone.org/c/documentation/13).
+    -   Ask in the [Plone chat on Discord](https://discord.com/invite/zFY3EBbjaj).
+
+1.  For first-time contributors especially, **you do not need to ask to be assigned to, or to work on, an open issue**.
+    As in any open source project, you can start work on open issues at your convenience.
+
+    ```{tip}
+    Working on documentation or on issues labeled with either `33 needs: docs` or `41 lvl: easy` are the two best ways for first-timers to contribute.
+    This is because first-timers have a fresh perspective that might be overlooked by old-timers.
+    ```
+
+1.  Clarify the scope of work that needs to be done.
+    Check for previous work, assignment to another developer, or whether the requirements have changed.
+1.  [Assign yourself to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users).
+    This signals to other developers that you are working on the issue.
+
+From here, you can either make {ref}`contributing-quick-edits-label` or {ref}`contributing-large-edits-label`.
+
+
+(contributing-quick-edits-label)=
+
+### Quick edits
+
+Quick edits for minor issues, such as typographical errors, misspellings, and English grammar and syntax, can be made through the GitHub user interface.
+
+1.  Navigate to the repository as noted in {ref}`contributing-manage-on-github-label`.
+1.  Navigate with the `docs` directory to find the source file to edit.
+1.  Click the {guilabel}`pencil icon` to edit the file in the browser.
+
+    ```{image} /_static/edit-pencil-icon.png
+    :alt: GitHub Edit this file
+    ```
+1.  Make edits, add a commit message, select {guilabel}`Create a new branch for this commit and start a pull request`, then click {guilabel}`Propose changes`.
+1.  Make your pull request against the branch `6-dev`.
+1.  Members who subscribe to the repository will receive a notification and review your request.
+1.  Request a review from other team members.
+
+
+(contributing-large-edits-label)=
+
+### Large edits
+
+For large edits, first follow the instructions in {doc}`setup-build`.
+
+Once you have your environment set up, then you can follow the standard practice for making a pull request.
+This practice differs depending on whether you are making contributions to only the core `documentation` files, or `plone.api`, `plone.restapi` and `volto` files as well.
+
+
+(contributing-documentation-only-label)=
+
+### Working with only the `plone/documentation` repository
+
+This section describes how to make contributions to files in the `plone/documentation` repository only, and excludes files in `submodules/plone.api/docs`, `submodules/plone.restapi/docs` and `submodules/volto/docs`.
+
+1.  From the project root directory, sync your local `6-dev` branch with its remote.
+    You might need to resolve conflicts.
+
+    ```shell
+    git checkout 6-dev
+    git pull
+    ```
+
+1.  Create a new branch from `6-dev`.
+
+    ```shell
+    git checkout -b <new_branch>
+    ```
+
+1.  Edit files, save, preview, and test.
+    You must run and pass the builds `html` and `linkcheck` without causing new errors.
+
+    ```shell
+    # Optionally clean the builds to avoid cache issues
+    make clean
+    make html
+    make linkcheck
+    ```
+
+    ```{note}
+    Currently there are some errors on the `html` build, mostly due to empty `meta` HTML tags.
+    You are welcome to fix as many errors as you like.
+    You are only responsible to fix errors that you create.
+    ```
+
+    ```{note}
+    Eventually the `vale` build will be required, but not at this time.
+    We welcome improvements to the dictionary.
+    ```
+
+    ```{seealso}
+    {ref}`setup-build-available-documentation-builds-label`.
+    ```
+
+1.  After the builds pass, commit changes to your branch, and push it to the remote repository on GitHub.
+    The remote repository may be either a branch in your fork of the project or a branch in the `plone/documentation` upstream repository.
+
+    ```shell
+    git commit -m "My descriptive commit message"
+    git push
+    ```
+
+1.  Visit the GitHub `documentation` repository, and [create a pull request](https://github.com/plone/documentation/compare) against the branch `6-dev`.
+1.  Members who subscribe to the repository will receive a notification and review your request.
+1.  Request a review from other team members.
+
+
+(contributing-editing-external-package-documentation-label)=
+
+### Editing external package documentation
+
+If you want to edit documentation of imported external packages, the process is slightly different.
+We use `git submodules` to manage multiple repositories.
+We imported the external repositories the `plone/documentation` repository as described in {doc}`setup-build`.
+
+```{important}
+We currently use the branches `plone/documentation@6-dev`, `plone/plone.api@master`, `plone/plone.restapi@master`, and `plone/volto@master` as the main branches for developing Plone 6 Documentation.
+These branches may change as we get closer to a production release.
+```
+
+1.  From the project root directory, sync your local `6-dev` branch with its remote.
+    You might need to resolve conflicts.
+
+    ```shell
+    git checkout 6-dev
+    git pull
+    ```
+
+1.  Change your working directory to the imported package's directory under `submodules/`.
+
+    ```shell
+    # Choose one.
+    cd submodules/plone.api
+    cd submodules/plone.restapi
+    cd submodules/volto
+    ```
+
+1.  Update the submodule, and sync your local development branch with its remote.
+    You might need to resolve conflicts.
+
+    ```shell
+    git submodule update
+
+    # for plone.api
+    git checkout master
+
+    # for plone.restapi
+    git checkout master
+
+    # for volto
+    git checkout master
+
+    git pull
+    ```
+
+1.  Create a new branch from the development branch.
+
+    ```shell
+    git checkout -b <new_branch>
+    ```
+
+1.  Make edits to files in `docs/<external_package>` using your favorite editor, and save, preview, and test.
+    You must run and pass the builds `html` and `linkcheck` without causing new errors.
+
+    ```shell
+    # Optionally clean the builds to avoid cache issues.
+    # Note that for the external packages' documentation only,
+    # we use "docs-" as a prefix for make targets to avoid a conflicts.
+    make docs-clean
+    make docs-html
+    make docs-linkcheck
+    ```
+
+1.  Back in `submodules/<external_package>`, commit and push your changes to the remote.
+
+    ```shell
+    git add <files>
+    git commit -m "My commit message"
+    git push
+    ```
+
+1.  Now return to the project root directory, and update the submodule to point to the commit you just made, and push your changes to the remote repository.
+
+    ```shell
+    cd ../..
+
+    # for plone.api
+    git add submodules/plone.api
+    git commit -m "Update submodules/plone.api tip"
+
+    # for plone.restapi
+    git add submodules/plone.restapi
+    git commit -m "Update submodules/plone.restapi tip"
+
+    # for Volto
+    git add submodules/volto
+    git commit -m "Update submodules/volto tip"
+
+    git push
+    ```
+
+1.  Visit the GitHub `plone/<external_package>` repository, and create a pull request against the development branch.
+1.  Members who subscribe to the `plone/<external_package>` repository will receive a notification and review your request.
+1.  Request a review from other team members.
+
+
+(contributing-documentation-code-of-conduct-label)=
+
+## Code of Conduct
+
+See {ref}`contributing-code-of-conduct-label`.
+
+
+```{toctree}
+---
+caption: Contributing to Documentation
+maxdepth: 2
+hidden: true
+---
+
+setup-build
+authors
+myst-reference
+sphinx-extensions
+admins
+```

docs/contributing/authors.md …cs/contributing/documentation/authors.mddocs/contributing/authors.md renamed to docs/contributing/documentation/authors.md docs/contributing/authors.md renamed to docs/contributing/documentation/authors.md

@@ -48,10 +48,10 @@ Official MyST documentation
 #### Link to a chapter or page
 
 ```md
-Here is how to set up and build the documentation locally {doc}`/contributing/setup-build`.
+Here is how to set up and build the documentation locally {doc}`/contributing/documentation/setup-build`.
 ```
 
-Here is how to set up and build the documentation locally {doc}`/contributing/setup-build`.
+Here is how to set up and build the documentation locally {doc}`/contributing/documentation/setup-build`.
 
 
 (myst-reference-link-heading-label)=