Skip to content

Commit 234e15c

Browse files
stevepiercystevepiercy
authored
Merge branch '6.0' into 6-dev--module-federation
2 parents 5033333 + b2d770b commit 234e15c

File tree

244 files changed

+28291
-2867
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

244 files changed

+28291
-2867
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
See our [contributing guidelines](https://6.dev-docs.plone.org/contributing/index.html).
1+
See our [contributing guidelines](https://6.docs.plone.org/contributing/index.html).

‎.github/ISSUE_TEMPLATE/new-issue-form.yml‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,18 @@ body:
55
attributes:
66
value: |
77
Thanks for taking the time to fill out this issue report!
8-
- type: checkboxes
9-
id: plone-versions
8+
- type: textarea
9+
id: documentation-url
1010
attributes:
11-
label: Plone Documentation versions affected
12-
options:
13-
- label: 5.x
14-
- label: 6.x
11+
label: Links of affected pages in Plone Documentation, if any.
12+
value: |
13+
- Link_1
14+
- Link_2
15+
- ...
1516
- type: textarea
1617
id: description
1718
attributes:
1819
label: Description
19-
description: If relevant, please include links to the affected resources, screenshots, and any other helpful information.
20+
description: Include screenshots and any other helpful information.
2021
validations:
2122
required: true

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md‎

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎.github/pull_request_template.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## First-time contributors
2+
3+
You **must** read and follow our [First-time contributors](https://6.docs.plone.org/contributing/first-time.html).
4+
5+
---
6+
7+
## Submit a pull request
8+
9+
Thank you for your contribution to the Plone Documentation.
10+
11+
Before submitting this pull request, please make sure you follow our guides:
12+
13+
- [Contributing to Plone documentation](https://6.docs.plone.org/contributing/index.html)
14+
- [Building and checking the quality of documentation](https://6.docs.plone.org/contributing/setup-build.html)
15+
- [Authors guide](https://6.docs.plone.org/contributing/authors.html)
16+
- [MyST reference](https://6.docs.plone.org/contributing/myst-reference.html)
17+
18+
## Issue number
19+
20+
- Fixes #
21+
22+
## Description
23+
24+
_Write a description of the fixes or improvements._
25+
26+
## Add screenshots or links to a preview of the changes
27+

‎.github/workflows/build_deploy.yml‎

Lines changed: 42 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,81 @@
1-
name: Build and deploy Plone 6 documentation to 6.dev-docs.plone.org
1+
name: Build and deploy Plone 6 documentation to 6.docs.plone.org
22

33
on:
44
push:
55
branches:
6-
- "6-dev"
6+
- "6.0"
7+
8+
env:
9+
node-version: 20.x
710

811
jobs:
912
build_deploy:
1013
runs-on: ubuntu-latest
14+
environment:
15+
name: docs.plone.org
16+
url: https://docs.plone.org
1117
steps:
12-
- uses: actions/checkout@v1
13-
14-
- name: Set up Python ${{ matrix.python-version }}
15-
uses: actions/setup-python@v2
18+
- uses: actions/checkout@v4
19+
- name: Setup Graphviz
20+
uses: ts-graphviz/setup-graphviz@v2
21+
- name: Set up Python 3.12
22+
uses: actions/setup-python@v5
1623
with:
17-
python-version: "3.10"
18-
24+
python-version: '3.12'
25+
cache: 'pip'
1926
- name: Install dependencies
2027
run: |
21-
python -m pip install --upgrade pip
28+
pip install -q -r requirements-initial.txt
2229
pip install -q -r requirements.txt
30+
pip freeze
2331
24-
# - name: Run spellcheck
25-
# run: make spellcheck
32+
# - name: Run Vale
33+
# run: make vale
2634

2735
# - name: Run linkcheck
2836
# run: make linkcheck
2937

3038
- name: Prepare deploy
3139
run: make deploy
3240

33-
# node setup
34-
- name: Use Node.js ${{ matrix.node-version }}
35-
uses: actions/setup-node@v1
41+
- name: Use Node.js ${{ env.node-version }}
42+
uses: actions/setup-node@v4
3643
with:
37-
node-version: ${{ matrix.node-version }}
44+
node-version: ${{ env.node-version }}
3845

39-
# node cache
40-
- name: Get yarn cache directory path
41-
id: yarn-cache-dir-path
42-
working-directory: submodules/volto
43-
run: echo "::set-output name=dir::$(yarn cache dir)"
44-
- uses: actions/cache@v1
45-
id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
46+
- uses: pnpm/action-setup@v3
47+
name: Install pnpm
4648
with:
47-
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
48-
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
49-
restore-keys: |
50-
${{ runner.os }}-yarn-
49+
version: 8
50+
run_install: false
5151

52+
- name: Get pnpm store directory
53+
shell: bash
54+
run: |
55+
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
56+
57+
- uses: actions/cache@v3
58+
name: Setup pnpm cache
59+
with:
60+
path: ${{ env.STORE_PATH }}
61+
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
62+
restore-keys: |
63+
${{ runner.os }}-pnpm-store-
5264
5365
- name: StoryBook build
54-
run: cd submodules/volto && yarn && yarn build-storybook -o ../../_build/html/storybook
66+
run: make storybook
5567

5668
- name: Deploy to server
5769
id: deploy
58-
uses: Pendect/action-rsyncer@v1.1.0
70+
uses: Pendect/action-rsyncer@v2.0.0
5971
env:
6072
DEPLOY_KEY: ${{secrets.DEPLOY_KEY_DOCS}}
6173
with:
6274
flags: '-avzr --delete'
6375
options: ''
64-
ssh_options: '-p ${{secrets.DEPLOY_PORT}}'
76+
ssh_options: '-p ${{vars.DEPLOY_PORT}}'
6577
src: '_build/html/'
66-
dest: '${{secrets.DEPLOY_USER_DOCS}}@${{secrets.DEPLOY_SERVER_DOCS}}:${{secrets.DEPLOY_PATH_DOCS}}'
78+
dest: '${{vars.DEPLOY_USER_DOCS}}@${{vars.DEPLOY_SERVER_DOCS}}:${{vars.DEPLOY_PATH_DOCS}}'
6779

6880
- name: Display status from deploy
6981
run: echo "${{ steps.deploy.outputs.status }}"

‎.github/workflows/test.yml‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,30 @@
11
name: Test Plone 6 documentation
22

3-
on:
4-
push:
5-
branches-ignore:
6-
- "master"
7-
3+
on: [push, pull_request]
84
jobs:
95
test:
6+
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
107
runs-on: ubuntu-latest
118
steps:
12-
- uses: actions/checkout@v1
9+
- uses: actions/checkout@v4
1310

1411
- name: Set up Python ${{ matrix.python-version }}
15-
uses: actions/setup-python@v2
12+
uses: actions/setup-python@v5
1613
with:
17-
python-version: "3.10"
14+
python-version: "3.12"
1815

1916
- name: Install dependencies
2017
run: |
21-
python -m pip install --upgrade pip
18+
pip install -q -r requirements-initial.txt
2219
pip install -q -r requirements.txt
20+
sudo snap install --edge vale
2321
2422
- name: Run tests with make test
2523
run: make test
24+
25+
- name: Run vale
26+
run: |
27+
git clone https://github.com/errata-ai/Microsoft.git
28+
cp -r ./Microsoft/Microsoft ./styles
29+
VALEFILES=$(find -L ./docs/ -type d \( -path "./docs/plone.restapi/lib/*" -o -path "./docs/plone.restapi/performance/*" \) -prune -false -o -type f -name "*.md" -print)
30+
vale --no-exit $VALEFILES

‎.github/workflows/update_submodule.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# See https://github.com/plone/documentation/issues/1214 for current status
2+
name: Get latest version of submodules and push back to 6.0 branch
3+
4+
on:
5+
workflow_dispatch:
6+
7+
jobs:
8+
update_submodules:
9+
runs-on: ubuntu-latest
10+
steps:
11+
# Checkout
12+
- uses: actions/checkout@v3
13+
with:
14+
ref: 6.0
15+
submodules: true
16+
17+
- name: Submodule update
18+
run: |
19+
git status
20+
git submodule update --init --recursive
21+
git submodule update --remote --recursive
22+
23+
- name: Commit updates
24+
run: |
25+
git status
26+
git add submodules/plone.api submodules/plone.restapi submodules/volto
27+
git status
28+
git config user.name github-actions
29+
git config user.email [email protected]
30+
git commit -m "Update submodules tip" || echo "No changes to commit"
31+
git push

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,13 @@
77
# Generated files
88
pyvenv.cfg
99
/_build
10+
/styles/Microsoft
11+
/share
1012

1113
# symlinked from submodule
1214
docs/volto
1315
docs/plone.restapi
1416
docs/plone.api
17+
18+
# editor files
19+
.vscode

‎.gitmodules‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[submodule "submodules/volto"]
22
path = submodules/volto
33
url = https://github.com/plone/volto.git
4-
branch = master
4+
branch = main
55
[submodule "submodules/plone.restapi"]
66
path = submodules/plone.restapi
77
url = https://github.com/plone/plone.restapi.git
8-
branch = master
8+
branch = main
99
[submodule "submodules/plone.api"]
1010
path = submodules/plone.api
1111
url = https://github.com/plone/plone.api.git

‎.vale.ini‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
StylesPath = styles
2+
3+
MinAlertLevel = suggestion
4+
5+
Vocab = Base,Plone
6+
7+
Packages = Microsoft
8+
9+
[*]
10+
BasedOnStyles = Vale, Microsoft
11+
Microsoft.Contractions = suggestion
12+
Microsoft.Units = suggestion

0 commit comments

Comments
 (0)