Skip to content

Commit 233cf6b

Browse files
committed
Add plone.api to contributors guide
1 parent eda5123 commit 233cf6b

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

docs/contributing/index.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,15 @@ See {doc}`setup-build` for instructions for how to set up and build the document
6363
Contributions are managed through git repositories on GitHub.
6464

6565
- [documentation](https://github.com/plone/documentation)
66+
- [plone.api](https://github.com/plone/plone.api)
6667
- [plone.restapi](https://github.com/plone/plone.restapi)
6768
- [volto](https://github.com/plone/volto)
6869

6970
First discuss whether you should perform any work.
7071
Any method below is acceptable, but are listed in order of most likely to get a response.
7172

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).
7475
- Discuss during conferences, trainings, and other Plone events.
7576
- Ask on the [Plone Community Forum, Documentation topic](https://community.plone.org/c/documentation/13).
7677
- 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
111112
For large edits, first follow the instructions in {doc}`setup-build`.
112113
113114
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.
115116
116117
117118
(contributing-documentation-only-label)=
118119
119120
### Working with only the `plone/documentation` repository
120121
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`.
122123
123124
1. From the project root directory, sync your local `6-dev` branch with its remote.
124125
You might need to resolve conflicts.
@@ -176,11 +177,11 @@ This section describes how to make contributions to files in the `plone/document
176177
### Editing external package documentation
177178
178179
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.
180181
We imported the external repositories the `plone/documentation` repository as described in {doc}`setup-build`.
181182
182183
```{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.
184185
These branches may change as we get closer to a production release.
185186
```
186187

@@ -195,10 +196,10 @@ These branches may change as we get closer to a production release.
195196
1. Change your working directory to the imported package's directory under `submodules/`.
196197
197198
```shell
198-
# choose one
199-
cd submodules/volto
200-
cd submodules/plone.restapi
199+
# Choose one.
201200
cd submodules/plone.api
201+
cd submodules/plone.restapi
202+
cd submodules/volto
202203
```
203204
204205
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.
207208
```shell
208209
git submodule update
209210
210-
# For volto
211-
git checkout master
211+
# for plone.api
212+
git checkout integration-in-plone-docs-6
212213
213-
# For plone.restapi
214+
# for plone.restapi
214215
git checkout master
215216
216-
# For plone.api
217-
git checkout integration-in-plone-docs-6
217+
# for volto
218+
git checkout master
218219
219220
git pull
220221
```
@@ -250,17 +251,17 @@ These branches may change as we get closer to a production release.
250251
```shell
251252
cd ../..
252253
253-
# For volto
254-
git add submodules/volto
255-
git commit -m "Update submodules/volto tip"
254+
# for plone.api
255+
git add submodules/plone.api
256+
git commit -m "Update submodules/plone.api tip"
256257
257-
# For plone.restapi
258+
# for plone.restapi
258259
git add submodules/plone.restapi
259260
git commit -m "Update submodules/plone.restapi tip"
260261
261-
# For plone.api
262-
git add submodules/plone.api
263-
git commit -m "Update submodules/plone.api tip"
262+
# for Volto
263+
git add submodules/volto
264+
git commit -m "Update submodules/volto tip"
264265
265266
git push
266267
```

0 commit comments

Comments
 (0)