Skip to content

Change home page UI #1875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 35 commits into from
Mar 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
ad934cb
change UI
Manas-Kenge Feb 28, 2025
9a06b52
add icons
Manas-Kenge Mar 1, 2025
78c62ec
add reference guide
Manas-Kenge Mar 2, 2025
2294a64
Remove bullet points
Manas-Kenge Mar 2, 2025
b088e5e
Merge branch '6.0' into home-page-UI
stevepiercy Mar 3, 2025
1cffd28
add additional cards
Manas-Kenge Mar 3, 2025
f7fe81f
Merge branch '6.0' into home-page-UI
Manas-Kenge Mar 4, 2025
ac3efc1
use internal links for cards
Manas-Kenge Mar 5, 2025
0fd234d
modify descriptions
Manas-Kenge Mar 6, 2025
d8eac2e
restore submodules
Manas-Kenge Mar 7, 2025
49c9950
Merge branch '6.0' into home-page-UI
Manas-Kenge Mar 7, 2025
2bdf87e
Merge branch '6.0' into home-page-UI
stevepiercy Mar 7, 2025
8bbef95
Merge branch '6.0' into home-page-UI
stevepiercy Mar 7, 2025
984c646
Merge branch '6.0' into home-page-UI
stevepiercy Mar 7, 2025
ba25739
Merge branch '6.0' into home-page-UI
Manas-Kenge Mar 9, 2025
d842506
Merge branch '6.0' into home-page-UI
stevepiercy Mar 9, 2025
171dd09
Merge branch '6.0' into home-page-UI
stevepiercy Mar 10, 2025
5ff36ce
Fix button-ref link syntax and use backtricks instead of colons
stevepiercy Mar 10, 2025
314c923
Remove HTML from metadata
stevepiercy Mar 10, 2025
f832bac
Now that we have cards on the index page, remove redundant sections f…
stevepiercy Mar 10, 2025
feb3fd5
Align Get Started card with its content
stevepiercy Mar 10, 2025
6beb0ab
Exclude files from plone.restapi to avoid errors
stevepiercy Mar 10, 2025
a37493c
Shorten text in user guide card
stevepiercy Mar 10, 2025
3727e56
Fix broken references
stevepiercy Mar 10, 2025
256ac2b
Create bogus editor.md page and add sphinx-reredirect entry to send i…
stevepiercy Mar 10, 2025
21456be
Merge branch '6.0' into home-page-UI
Manas-Kenge Mar 11, 2025
98d2989
Fix typo
stevepiercy Mar 12, 2025
dcbdf3d
- Set up a collection of reference guides as a definition list
stevepiercy Mar 12, 2025
c068205
Update the name of the navigation item
stevepiercy Mar 12, 2025
9e959ae
Update the user guide index to use a definition list
stevepiercy Mar 12, 2025
b98e823
Merge branch '6.0' into home-page-UI
stevepiercy Mar 13, 2025
777f253
Merge branch '6.0' into home-page-UI
stevepiercy Mar 14, 2025
fb27598
Merge branch '6.0' into home-page-UI
stevepiercy Mar 14, 2025
e5b1174
Merge branch '6.0' into home-page-UI
stevepiercy Mar 14, 2025
646f628
Merge branch '6.0' into home-page-UI
stevepiercy Mar 15, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,13 @@
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
"spelling_wordlist.txt",
"**/CHANGES.md",
"**/CHANGES.rst",
"**/LICENSE.rst",
"**/CONTRIBUTORS.md",
"**/CONTRIBUTORS.rst",
"**/LICENSE.rst",
"**/README.md",
"**/README.rst",
"**/eggs",
"_inc/.*",
Expand All @@ -151,6 +155,7 @@
"plone.restapi/parts",
"plone.restapi/performance",
"plone.restapi/src",
"plone.restapi/styles",
"plone.restapi/var",
"volto/_inc/*",
]
Expand Down Expand Up @@ -394,6 +399,12 @@
"install/install-from-packages": "/install/create-project.html",
"manage/frontend": "/volto/addons/index.html",
"install/create-project": "/install/create-project-cookieplone.html",
"user-guide/editor": "/volto/user-manual/index.html",
"reference-guide/volto-configuration-settings.html": "/volto/configuration/settings-reference.html",
"reference-guide/volto-javascript-client.html": "/volto/client/index.html",
"reference-guide/plone.restapi-usage.html": "/plone.restapi/docs/source/usage/index.html",
"reference-guide/plone.restapi-endpoints.html": "/plone.restapi/docs/source/endpoints/index.html",
"reference-guide/plone.api-methods.html": "/plone.api/api/index.html",
}


Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/volto.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ myst:

# Contributing to Volto

See {doc}`/volto/contributing/index` under {guilabel}`Frontend`.
See {doc}`/volto/contributing/index` under {guilabel}`Volto UI`.
111 changes: 103 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
myst:
html_meta:
"description": "This website is the HTML documentation of Plone, an open source, enterprise-level content management system."
"property=og:description": "This website is the HTML documentation of Plone, an open source, enterprise-level content management system."
"description": "This website is the documentation of Plone, an open source, enterprise-level content management system."
"property=og:description": "This website is the documentation of Plone, an open source, enterprise-level content management system."
"property=og:title": "Plone 6 Documentation"
"keywords": "Plone 6, content management system, CMS, open source, Documentation, Volto, Classic UI, frontend, backend, plone.restapi, plone.api"
---
Expand All @@ -13,13 +13,106 @@ myst:

This is the community-maintained documentation for the Plone content management system.

This documentation is for:
`````{grid} 1 1 2 2
:gutter: 3 3 4 5

- Editors who write and update content on a site
- Site administrators who install Plone and add-ons, and set up a site
- Designers who create site themes
- Deployers who configure servers for site hosting
- Developers who customize a site’s capabilities, create add-ons, and contribute to Plone itself
````{grid-item-card}
:link: install/index
:link-type: doc
{octicon}`zap;1.5em;sd-text-info`
Get started
^^^
This part of the documentation describes how to get started with Plone.
Choose from a trying a demo of Plone or installing Plone.
+++
```{button-ref} install/index
:color: primary
:expand:
Go to Get started
```
````

````{grid-item-card}
:link: user-guide/index
:link-type: doc
{octicon}`person;1.5em;sd-text-info`
User guide
^^^
This part of the documentation describes how to use Plone effectively, covering tasks for site editors and administrators.
+++
```{button-ref} user-guide/index
:ref-type: doc
:color: primary
:expand:
Go to User guide
```
````

````{grid-item-card}
:link: developer-guide/index
:link-type: doc
{octicon}`person-add;1.5em;sd-text-info`
Developer guide
^^^
This part of the documentation describes how to develop a Plone project.
+++
```{button-ref} developer-guide/index
:ref-type: doc
:color: primary
:expand:
Go to Developer guide
```
````

````{grid-item-card}
:link: reference-guide/index
:link-type: doc
{octicon}`bookmark;1.5em;sd-text-info`
Reference guide
^^^
This part of the documentation describes the APIs, functions, modules, and objects included in Plone.
+++
```{button-ref} reference-guide/index
:ref-type: doc
:color: primary
:expand:
Go to Reference guide
```
````

````{grid-item-card}
:link: conceptual-guides/index
:link-type: doc
{octicon}`light-bulb;1.5em;sd-text-info`
Conceptual guides
^^^
This part of the documentation provides explanation of concepts to deepen and broaden your understanding of Plone.
+++
```{button-ref} conceptual-guides/index
:ref-type: doc
:color: primary
:expand:
Go to Conceptual guides
```
````

````{grid-item-card}
:link: contributing/index
:link-type: doc
{octicon}`git-pull-request;1.5em;sd-text-info`
Contributor guide
^^^
This part of the documentation describes how to contribute to Plone, including all its projects and repositories under the Plone GitHub organization.
+++
```{button-ref} contributing/index
:ref-type: doc
:color: primary
:expand:
Go to Contributor guide
```
````

`````

```{seealso}
Read the [documentation for the previous version, Plone 5](https://5.docs.plone.org/).
Expand All @@ -42,6 +135,8 @@ backend/index
i18n-l10n/index
conceptual-guides/index
contributing/index
reference-guide/index
user-guide/index
```

```{toctree}
Expand Down
17 changes: 0 additions & 17 deletions docs/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,20 +60,3 @@ If you are following a [Plone training](https://training.plone.org/), it should

{doc}`Install Plone as a contributor </contributing/index>`
: This option is for developers who want to contribute to Plone and its packages.


(get-started-learn-more-label)=

## Learn more about Plone

The {doc}`/conceptual-guides/index` explain concepts to help you understand Plone.

The community has created a set of [Plone trainings](https://training.plone.org/) which are hosted separately from the documentation.
Plone trainings take place at every annual Plone Conference.


(get-started-contribute-label)=

## Contribute to Plone

See the {doc}`Contributor Guide </contributing/index>` to learn how to participate in the Plone community and contribute to our open source software.
38 changes: 38 additions & 0 deletions docs/reference-guide/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
myst:
html_meta:
"description": "Plone reference guide"
"property=og:description": "Plone reference guide"
"property=og:title": "Plone reference guide"
"keywords": "Plone, reference, guide"
---

# Reference guide

This reference guide details application programming interfaces (APIs), functions, modules, and objects included in Plone, describing what they are and what they do.
Its audience is primarily developers of Plone and its projects and add-ons.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stevepiercy I'm not sure this structure is right. Just because a section of docs covers an API doesn't mean that it's all reference. The lists of endpoints / functions are reference but there's also conceptual and how-to material in there.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a way to solve this by ignoring plone.restapi's and plone.api's index.md files and using custom ones in plone/documentation. It's hard to describe without an example, but it works.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK this is now ready for review. Please take a look at the pull request preview.


{doc}`Volto configuration settings </volto/configuration/settings-reference>`
: This reference contains a summary of the configuration options and what they control.

{doc}`Plone REST API JavaScript client endpoints </volto/client/index>`
: Plone REST API JavaScript client is a framework agnostic library based on TanStack Query.

{doc}`Plone REST API usage </plone.restapi/docs/source/usage/index>`
: This reference describes how to authenticate, batch records, manipulate content, and other common usage of the Plone REST API.

{doc}`Plone REST API endpoints </plone.restapi/docs/source/endpoints/index>`
: This reference describes each of the endpoints in the Plone REST API.
It includes usage and examples of HTTP requests and expected responses.

{doc}`Plone API methods </plone.api/api/index>`
: The list of Plone API methods and their descriptions for Plone backend functionality.

```{toctree}
:hidden:
volto-configuration-settings
volto-javascript-client
plone.restapi-usage
plone.restapi-endpoints
plone.api-methods
```
12 changes: 12 additions & 0 deletions docs/reference-guide/plone.api-methods.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
myst:
html_meta:
"description": "Plone API methods"
"property=og:description": "Plone API methods"
"property=og:title": "Plone API methods"
"keywords": "Plone, API, methods"
---

# Plone API methods

See {doc}`/plone.api/api/index`.
12 changes: 12 additions & 0 deletions docs/reference-guide/plone.restapi-endpoints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
myst:
html_meta:
"description": "Plone REST API endpoints"
"property=og:description": "Plone REST API endpoints"
"property=og:title": "Plone REST API endpoints"
"keywords": "Plone, REST, API, endpoints"
---

# Plone REST API endpoints

See {doc}`/plone.restapi/docs/source/endpoints/index`.
12 changes: 12 additions & 0 deletions docs/reference-guide/plone.restapi-usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
myst:
html_meta:
"description": "Plone REST API usage"
"property=og:description": "Plone REST API usage"
"property=og:title": "Plone REST API usage"
"keywords": "Plone, REST, API, usage"
---

# Plone REST API usage

See {doc}`/plone.restapi/docs/source/usage/index`.
12 changes: 12 additions & 0 deletions docs/reference-guide/volto-configuration-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
myst:
html_meta:
"description": "Volto configuration settings"
"property=og:description": "Volto configuration settings"
"property=og:title": "Volto configuration settings"
"keywords": "Plone, Volto, configuration, registry, settings"
---

# Volto configuration settings

See {doc}`/volto/configuration/settings-reference`.
12 changes: 12 additions & 0 deletions docs/reference-guide/volto-javascript-client.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
myst:
html_meta:
"description": "Plone REST API JavaScript client endpoints"
"property=og:description": "Plone REST API JavaScript client endpoints"
"property=og:title": "Plone REST API JavaScript client endpoints"
"keywords": "Plone, Volto, REST, API, JavaScript, client, endpoints"
---

# Plone REST API JavaScript client endpoints

See {doc}`/volto/client/index`.
12 changes: 12 additions & 0 deletions docs/user-guide/editor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
myst:
html_meta:
"description": "How to edit content in Plone"
"property=og:description": "How to edit content in Plone"
"property=og:title": "How to edit content in Plone"
"keywords": "Plone, edit, content"
---

# Editor guide

See {doc}`/volto/user-manual/index` under {guilabel}`Volto UI`.
23 changes: 23 additions & 0 deletions docs/user-guide/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
myst:
html_meta:
"description": "Plone user guide"
"property=og:description": "Plone user guide"
"property=og:title": "Plone user guide"
"keywords": "Plone, user, guide, editor, administrator"
---

# User guide

This part of the documentation describes how to use Plone effectively, covering tasks for site editors and administrators.

{doc}`/volto/user-manual/index`
: This guide describes how to work with blocks in Volto, the Plone 6 frontend.

{doc}`training:content-editing/index`
: This training describes how to create and manage content using Plone.

```{toctree}
:hidden:
editor
```