Skip to content

Commit e91b1c0

Browse files
authored
Rename seven->aurora docs (#100)
* Rename seven->aurora * Changelog * Further rename
1 parent f37ac65 commit e91b1c0

70 files changed

Lines changed: 461 additions & 550 deletions

File tree

Some content is hidden

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

.github/ISSUE_TEMPLATE/1_bug_report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: '🐞 Bug report'
3-
about: 'Create a report to help us improve Volto'
3+
about: 'Create a report to help us improve Plone Aurora'
44
title: ''
55
labels: ['01 type: bug', '30 needs: triage']
66
assignees: ''
@@ -27,7 +27,7 @@ If applicable, add screenshots or videos to help explain your problem.
2727

2828
- OS: [e.g. iOS]
2929
- Browser [e.g. firefox, chrome, safari]
30-
- Volto Version [e.g. 18.4.0]
30+
- Plone Aurora Version [e.g. 18.4.0]
3131
- Plone Version [e.g. 6.1.0]
3232
- Plone REST API Version [e.g. 9.1.0]
3333

.github/ISSUE_TEMPLATE/2_feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: '🦄 Feature request'
3-
about: 'Suggest an idea for Volto'
3+
about: 'Suggest an idea for Plone Aurora'
44
title: ''
55
labels: '04 type: enhancement'
66
assignees: ''

.github/workflows/docs-rtd-pr-preview-volto.yml renamed to .github/workflows/docs-rtd-pr-preview-plone-aurora.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# .github/workflows/docs-rtd-pr-preview-volto.yml
1+
# .github/workflows/docs-rtd-pr-preview-plone-aurora.yml
22
name: readthedocs/actions
33
on:
44
pull_request_target:
55
types:
66
- opened
77
# Execute this action only on PRs that touch
8-
# documentation files for Volto.
8+
# documentation files for Plone Aurora.
99
branches:
1010
- main
1111
paths:
@@ -18,7 +18,6 @@ on:
1818
- "packages/layout/**/*.stories.*"
1919
- "packages/cmsui/.storybook/**"
2020
- "packages/cmsui/**/*.stories.*"
21-
- "packages/volto/.storybook/**"
2221
- .readthedocs.yaml
2322
- requirements-docs.txt
2423

@@ -31,5 +30,5 @@ jobs:
3130
steps:
3231
- uses: readthedocs/actions/preview@v1
3332
with:
34-
project-slug: "volto"
33+
project-slug: "plone-aurora"
3534
single-version: "true"

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,34 +63,34 @@ You can find it at https://plone-storybook.readthedocs.io/?path=/docs/introducti
6363

6464
## Create a Plone Aurora frontend-only project
6565

66-
To create a project with a frontend-only scaffold using Plone Aurora, follow the [Plone installation documentation](https://volto.readthedocs.io/seven/get-started/create-package.html).
66+
To create a project with a frontend-only scaffold using Plone Aurora, follow the [Plone installation documentation](https://plone-aurora.readthedocs.io/get-started/create-package.html).
6767

6868

6969
## Documentation
7070

71-
You can find the documentation at [https://volto.readthedocs.io/seven/](https://volto.readthedocs.io/seven/).
71+
You can find the documentation at [https://plone-aurora.readthedocs.io/](https://plone-aurora.readthedocs.io/).
7272

7373

7474
## Supported Plone, Python, and Plone REST API versions
7575

76-
See [Plone, Python, and Plone REST API compatibility](https://volto.readthedocs.io/seven/contributing/version-policy.html#version-policy-plone-python-and-plone-rest-api-compatibility)
76+
See [Plone, Python, and Plone REST API compatibility](https://plone-aurora.readthedocs.io/contributing/version-policy.html#version-policy-plone-python-and-plone-rest-api-compatibility)
7777

7878
See the [Plone Release Schedule](https://plone.org/download/release-schedule) for details of maintenance and support.
7979

8080

8181
## Supported Node.js versions
8282

83-
See [Node.js version policy](https://volto.readthedocs.io/seven/contributing/version-policy.html#version-policy-plone-python-and-plone-rest-api-compatibility).
83+
See [Node.js version policy](https://plone-aurora.readthedocs.io/contributing/version-policy.html#version-policy-plone-python-and-plone-rest-api-compatibility).
8484

8585

8686
## Supported browsers
8787

88-
See [Supported browsers](https://volto.readthedocs.io/seven/contributing/version-policy.html#version-policy-supported-browsers).
88+
See [Supported browsers](https://plone-aurora.readthedocs.io/contributing/version-policy.html#version-policy-supported-browsers).
8989

9090

9191
## Contributing
9292

93-
To contribute to the Plone Aurora project by writing code, documentation, translations, and so on, please read [Contributing to Plone](https://6.docs.plone.org/contributing/index.html) and [Contributing to Volto](https://volto.readthedocs.io/seven/contributing/index.html).
93+
To contribute to the Plone Aurora project by writing code, documentation, translations, and so on, please read [Contributing to Plone](https://6.docs.plone.org/contributing/index.html) and [Contributing to Plone Aurora](https://plone-aurora.readthedocs.io/contributing/index.html).
9494

9595
For newcomers to Plone Aurora, Plone, or open source software, you must read and follow [First-time contributors](https://6.docs.plone.org/contributing/first-time.html).
9696

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Search and replace seven->aurora. @sneridagh

docs/_inc/_branch-policy.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,6 @@ legacy
2020
Legacy versions won't receive any new features.
2121
They might receive occasional bug fixes or security updates, subject to approval from the Volto Team.
2222

23-
`seven`
24-
: This is the branch for the successor of Volto.
25-
It is under active development, and it will be released when it is ready.
26-
It is not a stable version, and it should not be used in production.
27-
The Plone's modular architecture packages are released from this branch.
28-
2923
`main`
3024
: This is the bleeding edge branch in git.
3125
It is the branch upon which future development occurs, and from which future releases shall be cut.

docs/_inc/_hardware-requirements.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,18 @@ The hardware requirements below give a rough estimate of the minimum hardware se
33
A single Plone installation is able to run many Plone sites.
44

55
- Installation of the Plone backend and Classic UI frontend requires a minimum of 256 MB of RAM and 2GB of disk swap space.
6-
- Installation of the Seven frontend requires a minimum of 2GB of RAM.
6+
- Installation of the Plone Aurora frontend requires a minimum of 2GB of RAM.
77
- After installation, running Plone requires a minimum of 256 MB RAM and 512 MB of disk swap space per Plone site.
88
2 GB or more RAM per Plone site is recommended.
99
- Minimum 512 MB hard disk space is required.
1010
40 GB or more hard disk space is recommended.
1111

12+
```{disclaimer}
13+
The above hardware requirements for Plone Aurora are estimates based on the experience of the Plone community with Plone Volto.
14+
The hardware requirements for Plone Aurora should be lower than those of Plone Volto, as Plone Aurora is bundled with Vite, which is faster and more efficient than Webpack, the bundler used in Plone Volto.
15+
The hardware requirements for Plone Aurora may also change as the project evolves and new features are added.
16+
Once we have more data on the hardware requirements for Plone Aurora, we will update this section accordingly.
17+
```
1218

1319
````{warning}
1420
{term}`Add-on` products and caching solutions may also increase RAM and disk swap space requirements.

docs/_inc/_install-nodejs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1. Install or update the supported LTS versions of Node.js, then activate the version supported in Seven.
1+
1. Install or update the supported LTS versions of Node.js, then activate the version supported in Plone Aurora.
22

33
```shell
44
nvm install --lts

docs/conceptual-guides/add-on-driven-configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ myst:
44
"description": "Add-on driven configuration"
55
"property=og:description": "Add-on driven configuration"
66
"property=og:title": "Add-on driven configuration"
7-
"keywords": "Seven, add-ons, configuration"
7+
"keywords": "Plone Aurora, add-ons, configuration"
88
---
99

1010
# Add-on driven configuration
1111

12-
Seven is a frontend framework that can be extended using add-ons.
13-
Add-ons can provide configuration to customize or extend the default configuration of Seven.
12+
Plone Aurora is a frontend framework that can be extended using add-ons.
13+
Add-ons can provide configuration to customize or extend the default configuration of Plone Aurora.
1414

1515
See {ref}`what-is-an-addon` for more information about add-ons.
1616

docs/conceptual-guides/add-on-loader.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ myst:
44
"description": "An explanation of the add-ons configuration loader in @plone/registry"
55
"property=og:description": "An explanation of the add-ons configuration loader in @plone/registry"
66
"property=og:title": "Add-ons configuration loader"
7-
"keywords": "Seven, @plone/registry, registry, add-ons, loader"
7+
"keywords": "Plone Aurora, @plone/registry, registry, add-ons, loader"
88
---
99

1010
# Add-ons configuration loader
@@ -14,7 +14,7 @@ This chapter explains how the add-ons configuration loader loads configuration f
1414

1515
## Loader process
1616

17-
The add-ons configuration loader is a mechanism provided by `@plone/registry` to allow add-ons to customize or extend the default configuration of Seven.
17+
The add-ons configuration loader is a mechanism provided by `@plone/registry` to allow add-ons to customize or extend the default configuration of Plone Aurora.
1818
`@plone/registry` reads the value of the `main` key entry point in the add-on {file}`package.json`, which specifies the source of the loader.
1919
This should be a JavaScript or TypeScript file, such as {file}`index.ts` or {file}`index.js`, placed somewhere in your add-on, conventionally at its root.
2020

0 commit comments

Comments
 (0)