Skip to content

Commit 190bc18

Browse files
committed
Remove todo, and add missing details for the repository manager to complete setup in Netlify.
1 parent de47e8a commit 190bc18

File tree

1 file changed

+31
-4
lines changed

1 file changed

+31
-4
lines changed

docs/contributing/documentation/admins.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,6 @@ Commit and push your changes to a remote, and submit a pull request against [`pl
8686

8787
## Add a project to Netlify
8888

89-
```{todo}
90-
Some details need to be added to this section, including who to ping about the request with the repository name.
91-
```
9289
To add a new site to Netlify to preview built documentation or storybooks, you need to add a new site to Netlify.
9390

9491
1. Visit [Team Overview](https://app.netlify.com/teams/plone/overview).
@@ -102,4 +99,34 @@ To add a new site to Netlify to preview built documentation or storybooks, you n
10299
1. Netlify sends an email to members of the email group `admins` at `plone.org`, who need to review and approve the request.
103100
However the email doesn't specify the repository, and admins will not know what to do.
104101
You must send email to that group, including in your request the organization and repository, such as `plone/volto`.
105-
1. The admin must login to GitHub as an organization owner, then navigate to the requested repository's {guilabel}`Settings`.
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.

0 commit comments

Comments
 (0)