Skip to content

Commit 977c0b8

Browse files
authored
Merge branch '6.0' into 1430-update-issue-template
2 parents d8cceab + 4aa0893 commit 977c0b8

File tree

4 files changed

+101
-6
lines changed

4 files changed

+101
-6
lines changed

docs/backend/relations.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,9 @@ relationlist_field = RelationList(
149149
directives.widget(
150150
"relationlist_field",
151151
RelatedItemsFieldWidget,
152-
pattern_options=make_relation_root_path,
152+
pattern_options={
153+
"basePath": make_relation_root_path,
154+
}
153155
)
154156
```
155157

@@ -333,11 +335,6 @@ When you click on {guilabel}`Edit XML field model`, you will see the fields in t
333335

334336
## Using different widgets for relations
335337

336-
```{todo}
337-
Support for `StaticCatalogVocabulary` in Volto is currently missing.
338-
See issues https://github.com/plone/volto/issues/3355 and https://github.com/plone/volto/issues/3439.
339-
```
340-
341338
Often the standard widget for relations is not what you want.
342339
It can be hard to navigate to the content to which you want to relate, and the search mode of the default widget is not suitable for all use cases.
343340

docs/contributing/documentation/admins.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,51 @@ To make it easier for other contributors to work with your project, update the f
8282
- Optionally set a branch to work on in `.gitmodules`.
8383

8484
Commit and push your changes to a remote, and submit a pull request against [`plone/[email protected]`](https://github.com/plone/documentation/compare).
85+
86+
87+
## Add a project to Netlify
88+
89+
To add a new site to Netlify to preview built documentation or storybooks, you need to add a new site to Netlify.
90+
91+
1. Visit [Team Overview](https://app.netlify.com/teams/plone/overview).
92+
1. Click {guilabel}`Add a new site` and select {guilabel}`Import an existing project`.
93+
1. Click {guilabel}`Deploy with GitHub`.
94+
1. Select {guilabel}`plone` for the GitHub organization.
95+
1. Click {guilabel}`Configure Netlify on GitHub`.
96+
1. Select the organization to where you want to install Netlify.
97+
1. Click {guilabel}`Select repositories` and select the repository that you want to add.
98+
1. Click {guilabel}`Update access`.
99+
1. Netlify sends an email to members of the email group `admins` at `plone.org`, who need to review and approve the request.
100+
However the email doesn't specify the repository, and admins will not know what to do.
101+
You must send email to that group, including in your request the organization and repository, such as `plone/volto`.
102+
1. The admin must login to GitHub as an organization owner, then navigate to the requested repository's {guilabel}`Settings`. [What else Admin person?]
103+
1. The admin replies to the requestor, letting them know the request was approved.
104+
105+
From here you need to update your repository to work with Netlify.
106+
For an example, see the following files.
107+
108+
- [Volto `Makefile`](https://github.com/plone/volto/blob/main/Makefile), specifically the `netlify` section.
109+
This will become the command used to build docs on Netlify.
110+
- [Volto `requirements-docs.txt`](https://github.com/plone/volto/blob/main/requirements-docs.txt) specifies the requirements to build the docs.
111+
- [Volto `netlify.toml`](https://github.com/plone/volto/blob/main/netlify.toml) specifies when to build the docs, specifically only when there are changes to documentation files.
112+
113+
Finally you need to configure your site in Netlify.
114+
You may have done some of these steps earlier, but you might need to refine them.
115+
The critical pieces are the following.
116+
117+
1. From the dashboard, select the site to edit it.
118+
1. Click {guilabel}`Site configuration`.
119+
1. One time only, under {guilabel}`General > Site details` click {guilabel}`Change site name`.
120+
A modal dialog appears.
121+
Enter the site name using the pattern `ORGANIZATION_NAME-REPOSITORY_NAME`.
122+
For example, `plone-components`.
123+
Click {guilabel}`Save`.
124+
1. Under {guilabel}`Build & deploy > Continuous deployment`, scroll to {guilabel}`Build settings`, and click {guilabel}`Configure`, then enter the following values.
125+
- {guilabel}`Base directory`: `/`
126+
- {guilabel}`Package directory`: `/`
127+
- {guilabel}`Build command`: `make netlify`.
128+
This is the command you would define in your `Makefile`.
129+
- {guilabel}`Publish directory`: `_build/html`.
130+
This is where the `make` command will output files.
131+
- Finally click {guilabel}`Save`.
132+
1. Under {guilabel}`Build & deploy > Continuous deployment`, scroll to {guilabel}`Branches and deploy contexts`, and click {guilabel}`Configure`, then enter appropriate values.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description": "GitHub administration for Plone"
5+
"property=og:description": "GitHub administration for Plone"
6+
"property=og:title": GitHub administration for Plone"
7+
"keywords": "Plone, GitHub, administration"
8+
---
9+
10+
(contributing-github-administration-label)=
11+
12+
# GitHub administration
13+
14+
This chapter describes how repositories under the Plone GitHub organization are managed.
15+
16+
17+
(contributing-github-repository-tagging-label)=
18+
19+
## Repository tagging
20+
21+
To find repositories and their purpose within the Plone organization, a set of tags are used for repositories within the Plone GitHub organization.
22+
The following tags are in use.
23+
24+
`core`
25+
: repositories that are required by both Volto and Classic UI projects
26+
27+
`volto`
28+
: specific repositories that are required by Volto, but not Classic UI, projects
29+
30+
`volto add-ons`
31+
: repositories that are not part of the default Volto installation, but extend its functionality
32+
33+
`classic ui`
34+
: counterpart to `volto` tag
35+
36+
`classic ui add-ons`
37+
: counterpart to `volto add-ons` tag
38+
39+
`documentation`
40+
: repositories that have documentation
41+
42+
`training`
43+
: repositories related to the training documentation
44+
45+
`infrastructure`
46+
: repositories used for maintaining Plone servers
47+
48+
`tooling`
49+
: tools and applications needed to orchestrate Plone

docs/contributing/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,4 +151,5 @@ documentation/index
151151
../plone.api/contribute/index
152152
../plone.restapi/docs/source/contributing/index
153153
../volto/contributing/index
154+
github-administration
154155
```

0 commit comments

Comments
 (0)