From 3bb6191e6fab282dbcca82bbc63bb6ffcd2a07ac Mon Sep 17 00:00:00 2001 From: Victor Fernandez de Alba Date: Mon, 16 Dec 2024 13:07:46 +0100 Subject: [PATCH] Use an inc for the SemanticUI notice, move under titles --- docs/source/_inc/_install-browser-reqs-volto.md | 10 ---------- docs/source/_inc/_semanticui-deprecation.md | 6 ++++++ docs/source/contributing/version-policy.md | 2 +- docs/source/theming/about-semantic.md | 6 +----- docs/source/theming/custom-styling.md | 8 +++----- docs/source/theming/index.md | 4 +--- docs/source/theming/semanticui-theming.md | 8 +++----- docs/source/theming/theming-a-base-theme.md | 5 ----- docs/source/theming/theming-engine.md | 8 +++----- docs/source/theming/theming-strategy.md | 8 +++----- 10 files changed, 21 insertions(+), 44 deletions(-) delete mode 100644 docs/source/_inc/_install-browser-reqs-volto.md create mode 100644 docs/source/_inc/_semanticui-deprecation.md diff --git a/docs/source/_inc/_install-browser-reqs-volto.md b/docs/source/_inc/_install-browser-reqs-volto.md deleted file mode 100644 index b5db8d42ac..0000000000 --- a/docs/source/_inc/_install-browser-reqs-volto.md +++ /dev/null @@ -1,10 +0,0 @@ -You can view the list of supported browsers for Volto at [Browserslist](https://browsersl.ist/#q=%3E1%25%0Alast+4+versions%0AFirefox+ESR%0Anot+dead). - -These browsers are set according to the `browserslist` key in Volto's [`package.json`](https://github.com/plone/volto/blob/1aff8d0451f5cb375ca9f5afe9b2b72a0555afd8/packages/volto/package.json#L170-L176) file, whose content is below. - -```shell ->1% -last 4 versions -Firefox ESR -not dead -``` diff --git a/docs/source/_inc/_semanticui-deprecation.md b/docs/source/_inc/_semanticui-deprecation.md new file mode 100644 index 0000000000..cc8f3869f1 --- /dev/null +++ b/docs/source/_inc/_semanticui-deprecation.md @@ -0,0 +1,6 @@ +```{deprecated} Volto 18 +Semantic UI development and maintenance has sputtered since 2018. +The Volto Team made the decision to move forward in a sustainable direction. +Plone 7 will use a different theming approach, based on the [`@plone/components`](https://www.npmjs.com/package/@plone/components)—which in turn is based on [React Aria Components](https://react-spectrum.adobe.com/react-aria/components.html)—and [`@plone/theming`](https://github.com/plone/volto/tree/main/packages/theming) packages. +Using Semantic UI theming for your project or add-on is deprecated from Volto 18 onward, and will be removed in Plone 7. +``` diff --git a/docs/source/contributing/version-policy.md b/docs/source/contributing/version-policy.md index 2e43a9d4c8..47e62963e8 100644 --- a/docs/source/contributing/version-policy.md +++ b/docs/source/contributing/version-policy.md @@ -96,7 +96,7 @@ We recommend using the current LTS version. ## Supported web browsers -```{include} /_inc/_install-browser-reqs-volto.md +```{include} ../../_inc/_install-browser-reqs-volto.md ``` diff --git a/docs/source/theming/about-semantic.md b/docs/source/theming/about-semantic.md index 258464a2d2..340dc2e6a6 100644 --- a/docs/source/theming/about-semantic.md +++ b/docs/source/theming/about-semantic.md @@ -9,11 +9,7 @@ myst: # About Semantic UI -```{deprecated} Volto 18 -Semantic UI development and maintenance has sputtered since 2018. -The Volto Team made the decision to move forward in a sustainable direction. -Plone 7 will use a different theming approach, based on the [`@plone/components`](https://www.npmjs.com/package/@plone/components)—which in turn is based on [React Aria Components](https://react-spectrum.adobe.com/react-aria/components.html)—and [`@plone/theming`](https://github.com/plone/volto/tree/main/packages/theming) packages. -Using Semantic UI theming for your project or add-on is deprecated from Volto 18 onward, and will be removed in Plone 7. +```{include} /_inc/_semanticui-deprecation.md ``` Volto uses [Semantic UI](https://semantic-ui.com/) and diff --git a/docs/source/theming/custom-styling.md b/docs/source/theming/custom-styling.md index c9976f44ec..ae8d0d8ba0 100644 --- a/docs/source/theming/custom-styling.md +++ b/docs/source/theming/custom-styling.md @@ -7,15 +7,13 @@ myst: "keywords": "Volto, Plone, frontend, React, Custom, Styling, Semantic UI, LESS, Pastanaga" --- -```{deprecated} Volto 18 -Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. -Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. -``` - # Custom Styling ## Semantic UI +```{include} /_inc/_semanticui-deprecation.md +``` + For styling our website in Volto we use Semantic UI. It uses LESS as the underlying technology. By default Volto uses the Pastanaga theme but any theme can be used. A theme has the following folder structure: diff --git a/docs/source/theming/index.md b/docs/source/theming/index.md index 39e1e93c3c..d5d77ed936 100644 --- a/docs/source/theming/index.md +++ b/docs/source/theming/index.md @@ -11,9 +11,7 @@ myst: This section of the documentation describes theming in Volto. -```{deprecated} Volto 18 -Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. -Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. +```{include} /_inc/_semanticui-deprecation.md ``` ## Conceptual guides diff --git a/docs/source/theming/semanticui-theming.md b/docs/source/theming/semanticui-theming.md index cfad6a013c..5a4ed80914 100644 --- a/docs/source/theming/semanticui-theming.md +++ b/docs/source/theming/semanticui-theming.md @@ -7,13 +7,11 @@ myst: "keywords": "Volto, Plone, frontend, React, Semantic UI, Theming" --- -```{deprecated} Volto 18 -Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. -Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. -``` - # Semantic UI Theming +```{include} /_inc/_semanticui-deprecation.md +``` + As we hinted previously, Semantic UI theming happens in several stages using several layers of inheritance. Let's discover each of these layers. diff --git a/docs/source/theming/theming-a-base-theme.md b/docs/source/theming/theming-a-base-theme.md index 0db2ab93fe..f3730dead1 100644 --- a/docs/source/theming/theming-a-base-theme.md +++ b/docs/source/theming/theming-a-base-theme.md @@ -7,11 +7,6 @@ myst: "keywords": "Volto, Plone, frontend, React, themes, Volto Light Theme" --- -```{deprecated} Volto 18 -Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. -Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. -``` - # Customize a base theme You can customize a base theme for your add-on. diff --git a/docs/source/theming/theming-engine.md b/docs/source/theming/theming-engine.md index 7dcff5a611..e7c993f22d 100644 --- a/docs/source/theming/theming-engine.md +++ b/docs/source/theming/theming-engine.md @@ -7,13 +7,11 @@ myst: "keywords": "Volto, Plone, frontend, React, theming, engine, LESS" --- -```{deprecated} Volto 18 -Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. -Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. -``` - # How does the theming engine work? +```{include} /_inc/_semanticui-deprecation.md +``` + It basically uses heavily the LESS precompiler language features. No code is involved (which is good). ## `theme.config` diff --git a/docs/source/theming/theming-strategy.md b/docs/source/theming/theming-strategy.md index 27a8d29899..d8a6bbcf47 100644 --- a/docs/source/theming/theming-strategy.md +++ b/docs/source/theming/theming-strategy.md @@ -7,13 +7,11 @@ myst: "keywords": "Volto, Plone, frontend, React, Theming, Strategy" --- -```{deprecated} Volto 18 -Using SemanticUI theming for your project or add-on is deprecated from Volto 18 on and will be removed from Plone 7. -Plone 7 will use another theming approach, based on `@plone/components` and `@plone/theming` packages. -``` - # Theming Strategy +```{include} /_inc/_semanticui-deprecation.md +``` + One approaches the theming of a Volto site usually with a predefined mockup or design from a design agency or an UX/UI designer in the form of Sketch files (a common design and prototyping tool), a series of photoshop or PDFs with the