You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
First discuss whether you should perform any work.
70
71
Any method below is acceptable, but are listed in order of most likely to get a response.
71
72
72
-
- Search for open issues in [`documentation`](https://github.com/plone/documentation/issues), [`plone.restapi`](https://github.com/plone/plone.restapi/issues), or [`volto`](https://github.com/plone/volto/issues) and comment on them.
73
-
- Create a new issue in [`documentation`](https://github.com/plone/documentation/issues), [`plone.restapi`](https://github.com/plone/plone.restapi/issues), or [`volto`](https://github.com/plone/volto/issues).
73
+
- Search for open issues in [`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), or [`volto`](https://github.com/plone/volto/issues) and comment on them.
74
+
- Create a new issue in [`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), or [`volto`](https://github.com/plone/volto/issues).
74
75
- Discuss during conferences, trainings, and other Plone events.
75
76
- Ask on the [Plone Community Forum, Documentation topic](https://community.plone.org/c/documentation/13).
76
77
- Ask in the [Plone chat on Discord](https://discord.com/invite/zFY3EBbjaj).
@@ -111,14 +112,14 @@ Quick edits for minor issues, such as typographical errors, misspellings, and En
111
112
For large edits, first follow the instructions in {doc}`setup-build`.
112
113
113
114
Once you have your environment set up, then you can follow the standard practice for making a pull request.
114
-
This practice differs depending on whether you are making contributions to only the core `documentation` files, or `plone.restapi` and `volto` files as well.
115
+
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.
115
116
116
117
117
118
(contributing-documentation-only-label)=
118
119
119
120
### Working with only the `plone/documentation` repository
120
121
121
-
This section describes how to make contributions to files in the `plone/documentation` repository only, and excludes files in `submodules/plone.restapi/docs` and `submodules/volto/docs`.
122
+
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`.
122
123
123
124
1. From the project root directory, sync your local `6-dev` branch with its remote.
124
125
You might need to resolve conflicts.
@@ -176,11 +177,11 @@ This section describes how to make contributions to files in the `plone/document
176
177
### Editing external package documentation
177
178
178
179
If you want to edit documentation of imported external packages, the process is slightly different.
179
-
We use git submodules to manage multiple repositories.
180
+
We use `git submodules` to manage multiple repositories.
180
181
We imported the external repositories the `plone/documentation` repository as described in {doc}`setup-build`.
181
182
182
183
```{important}
183
-
We currently use the branches `plone/documentation@6-dev`, `plone/plone.restapi@master`, and `plone/volto@master` as the main branches for developing Plone 6 Documentation.
184
+
We currently use the branches `plone/documentation@6-dev`, `plone/plone.api@integration-in-plone-docs-6`, `plone/plone.restapi@master`, and `plone/volto@master` as the main branches for developing Plone 6 Documentation.
184
185
These branches may change as we get closer to a production release.
185
186
```
186
187
@@ -195,10 +196,10 @@ These branches may change as we get closer to a production release.
195
196
1. Change your working directory to the imported package's directory under `submodules/`.
196
197
197
198
```shell
198
-
# choose one
199
-
cd submodules/volto
200
-
cd submodules/plone.restapi
199
+
# Choose one.
201
200
cd submodules/plone.api
201
+
cd submodules/plone.restapi
202
+
cd submodules/volto
202
203
```
203
204
204
205
1. Update the submodule, and sync your local development branch with its remote.
@@ -207,14 +208,14 @@ These branches may change as we get closer to a production release.
207
208
```shell
208
209
git submodule update
209
210
210
-
# For volto
211
-
git checkout master
211
+
# for plone.api
212
+
git checkout integration-in-plone-docs-6
212
213
213
-
# For plone.restapi
214
+
# for plone.restapi
214
215
git checkout master
215
216
216
-
# For plone.api
217
-
git checkout integration-in-plone-docs-6
217
+
# for volto
218
+
git checkout master
218
219
219
220
git pull
220
221
```
@@ -250,17 +251,17 @@ These branches may change as we get closer to a production release.
0 commit comments