Skip to content

Commit

Permalink
Merge branch '6.0' into requirements-to-build-volto
Browse files Browse the repository at this point in the history
  • Loading branch information
stevepiercy committed Oct 27, 2023
2 parents d18d7e0 + 347e26f commit e3d692f
Show file tree
Hide file tree
Showing 4 changed files with 106 additions and 7 deletions.
15 changes: 8 additions & 7 deletions .github/ISSUE_TEMPLATE/new-issue-form.yml
Expand Up @@ -5,17 +5,18 @@ body:
attributes:
value: |
Thanks for taking the time to fill out this issue report!
- type: checkboxes
id: plone-versions
- type: textarea
id: documentation-url
attributes:
label: Plone Documentation versions affected
options:
- label: 5.x
- label: 6.x
label: Links of affected pages in Plone Documentation, if any.
value: |
- Link_1
- Link_2
- ...
- type: textarea
id: description
attributes:
label: Description
description: If relevant, please include links to the affected resources, screenshots, and any other helpful information.
description: Include include screenshots and any other helpful information.
validations:
required: true
48 changes: 48 additions & 0 deletions docs/contributing/documentation/admins.md
Expand Up @@ -82,3 +82,51 @@ To make it easier for other contributors to work with your project, update the f
- Optionally set a branch to work on in `.gitmodules`.

Commit and push your changes to a remote, and submit a pull request against [`plone/documentation@6.0`](https://github.com/plone/documentation/compare).


## Add a project to Netlify

To add a new site to Netlify to preview built documentation or storybooks, you need to add a new site to Netlify.

1. Visit [Team Overview](https://app.netlify.com/teams/plone/overview).
1. Click {guilabel}`Add a new site` and select {guilabel}`Import an existing project`.
1. Click {guilabel}`Deploy with GitHub`.
1. Select {guilabel}`plone` for the GitHub organization.
1. Click {guilabel}`Configure Netlify on GitHub`.
1. Select the organization to where you want to install Netlify.
1. Click {guilabel}`Select repositories` and select the repository that you want to add.
1. Click {guilabel}`Update access`.
1. Netlify sends an email to members of the email group `admins` at `plone.org`, who need to review and approve the request.
However the email doesn't specify the repository, and admins will not know what to do.
You must send email to that group, including in your request the organization and repository, such as `plone/volto`.
1. The admin must login to GitHub as an organization owner, then navigate to the requested repository's {guilabel}`Settings`. [What else Admin person?]
1. The admin replies to the requestor, letting them know the request was approved.

From here you need to update your repository to work with Netlify.
For an example, see the following files.

- [Volto `Makefile`](https://github.com/plone/volto/blob/main/Makefile), specifically the `netlify` section.
This will become the command used to build docs on Netlify.
- [Volto `requirements-docs.txt`](https://github.com/plone/volto/blob/main/requirements-docs.txt) specifies the requirements to build the docs.
- [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.

Finally you need to configure your site in Netlify.
You may have done some of these steps earlier, but you might need to refine them.
The critical pieces are the following.

1. From the dashboard, select the site to edit it.
1. Click {guilabel}`Site configuration`.
1. One time only, under {guilabel}`General > Site details` click {guilabel}`Change site name`.
A modal dialog appears.
Enter the site name using the pattern `ORGANIZATION_NAME-REPOSITORY_NAME`.
For example, `plone-components`.
Click {guilabel}`Save`.
1. Under {guilabel}`Build & deploy > Continuous deployment`, scroll to {guilabel}`Build settings`, and click {guilabel}`Configure`, then enter the following values.
- {guilabel}`Base directory`: `/`
- {guilabel}`Package directory`: `/`
- {guilabel}`Build command`: `make netlify`.
This is the command you would define in your `Makefile`.
- {guilabel}`Publish directory`: `_build/html`.
This is where the `make` command will output files.
- Finally click {guilabel}`Save`.
1. Under {guilabel}`Build & deploy > Continuous deployment`, scroll to {guilabel}`Branches and deploy contexts`, and click {guilabel}`Configure`, then enter appropriate values.
49 changes: 49 additions & 0 deletions docs/contributing/github-administration.md
@@ -0,0 +1,49 @@
---
myst:
html_meta:
"description": "GitHub administration for Plone"
"property=og:description": "GitHub administration for Plone"
"property=og:title": GitHub administration for Plone"
"keywords": "Plone, GitHub, administration"
---

(contributing-github-administration-label)=

# GitHub administration

This chapter describes how repositories under the Plone GitHub organization are managed.


(contributing-github-repository-tagging-label)=

## Repository tagging

To find repositories and their purpose within the Plone organization, a set of tags are used for repositories within the Plone GitHub organization.
The following tags are in use.

`core`
: repositories that are required by both Volto and Classic UI projects

`volto`
: specific repositories that are required by Volto, but not Classic UI, projects

`volto add-ons`
: repositories that are not part of the default Volto installation, but extend its functionality

`classic ui`
: counterpart to `volto` tag

`classic ui add-ons`
: counterpart to `volto add-ons` tag

`documentation`
: repositories that have documentation

`training`
: repositories related to the training documentation

`infrastructure`
: repositories used for maintaining Plone servers

`tooling`
: tools and applications needed to orchestrate Plone
1 change: 1 addition & 0 deletions docs/contributing/index.md
Expand Up @@ -151,4 +151,5 @@ documentation/index
../plone.api/contribute/index
../plone.restapi/docs/source/contributing/index
../volto/contributing/index
github-administration
```

0 comments on commit e3d692f

Please sign in to comment.