First batch of the overhaul of the add-ons section #6397

sneridagh · 2024-10-11T16:19:09Z

Ok, this is the beginning only. I plan to continue tomorrow.
I cleaned up the big bucket that the main index.md was.
Not sure of its current shape yet but organizing this is daunting.
I merged some things that were already reordered in the training, merged all together in here.
I have the feeling that we will need a brother section in development section only for developing add-ons with all the workflow explained in there (testing, linting, etc).

Disclaimer: I haven't double check things yet!

I signed and returned the Plone Contributor Agreement, and received and accepted an invitation to join a team in the Plone GitHub organization.
I verified there aren't other open pull requests for the same change.
I followed the guidelines in Contributing to Volto.
I succesfully ran code linting checks on my changes locally.
I succesfully ran unit tests on my changes locally.
I succesfully ran acceptance tests on my changes locally.
If needed, I added new tests for my changes.
If needed, I added documentation for my changes, either in the Storybook or narrative documentation.
I included a change log entry in my commits.

If your pull request closes an open issue, include the exact text below, immediately followed by the issue number. When your pull request gets merged, then that issue will close automatically.

Closes #

Pull request preview:

https://volto--6397.org.readthedocs.build/

netlify · 2024-10-11T16:19:26Z

✅ Deploy Preview for plone-components canceled.

Name	Link
🔨 Latest commit	`c3e4066`
🔍 Latest deploy log	https://app.netlify.com/sites/plone-components/deploys/6729ec6f5679840008fbe361

- Fix references

* main: (23 commits) Aliases control panel: Improve layout and add CSV upload (#6421) Fix site setup access at toolbar by using @actions endpoint. (#6413) Remove last CI tests still in 18 (#6418) Node 22 as LTS, main and recommended Volto version (#6371) Refactor Aliases control panel and support new filters (#6414) Remove the Plone app from apps folder (#6415) Release generate-volto 9.0.0-alpha.19 Release @plone/providers 1.0.0-alpha.3 Release @plone/components 2.0.0-alpha.16 Release @plone/client 1.0.0-alpha.19 Release @plone/types 1.0.0-alpha.21 Some types improvements/fixes (#6412) [providers] Improve and group providers (#6069) Adjust the path to perform a proper `git diff` between the cached and… (#6410) Test whether commenting out the `ignore` command has any affect on the Netlify build. support depth in getNavigationQuery (#6400) Update caniuse Oct24 (#6408) Upgraded nextjs deps and configuration (#6388) Update `typescript` and `vitest` everywhere (#6407) Remove all traces of Jest 24 in core (#6406) ...

sneridagh · 2024-10-22T20:46:05Z

@stevepiercy I moved things around, and sync with the other PR. Now it's starting to get in shape.

stevepiercy · 2024-10-22T22:15:20Z

@sneridagh is this ready for review now, or should I hold off?

sneridagh · 2024-10-23T06:52:43Z

@stevepiercy I will take another round today, and side by side with the other PR, to see if I can make both even in terms on how we explain things.

stevepiercy · 2024-10-26T10:07:10Z

Hold off, I found a bug, commit incoming.

stevepiercy · 2024-10-26T10:10:09Z

OK, that should fix readme-linkcheck

stevepiercy · 2024-10-26T10:11:06Z

@sneridagh needs change log

sneridagh · 2024-10-26T10:25:38Z

@stevepiercy done.

stevepiercy · 2024-10-26T12:00:54Z

@sneridagh can you resolve the conflicts? Then I will review.

* main: [Next.js] Better Vercel deployment (#6441) Replace all `yarn` appearences with `pnpm` (#6433) Add deprecation notices to the Upgrade guide (#6426) Clean up #6422 (#6443)

Clean up some grammar. Let's avoid "frontend", and instead use "user interface", as this has come to bite us in the backend.

…s a How-to guide. Add to Development index so it shows up in the main navigation.

Specify Volto 17 as stable release. Include mention of npm Registry with link. Fix grammar and syntax. Apply style guide.

…d use Sphinx Design with synched tabs to show relevant commands for each version of Volto

Grammar. MyST markup enhancements.

sneridagh · 2024-11-03T23:43:26Z

@stevepiercy I gave it a read and I'm crying. Amazing job, thanks for your careful review and curation.
It's GTG for me.

stevepiercy

Let's wait at least one more day before merging to give the rest of the @plone/volto-team a chance to review this massive change to documentation of Volto add-ons.

However, I want to merge this no later than Tue, Nov 5, AOE, because Volto 18.0.0 is now released, PloneConf 2024 is near, and we have massive changes to the main Plone 6 documentation and Trainings in the pipeline that depend on these docs.

docs/source/development/add-ons/install-an-add-on-dev-18.md

docs/source/development/add-ons/test-add-ons-18.md

docs/source/development/add-ons/best-practices.md

docs/source/development/add-ons/install-an-add-on-dev-18.md

nileshgulia1

lgtm apart from a comment.

Co-authored-by: Katja Süss <k.suess@rohberg.ch>

…-ons

stevepiercy

Minor grammar fixes. Good stuff!

docs/source/development/add-ons/install-an-add-on-dev-18.md

docs/source/development/add-ons/test-add-ons-18.md

davisagli

@sneridagh @stevepiercy Amazing work! I haven't read every line, but the overall restructuring is a great improvement. Let's not hold this back.

davisagli · 2024-11-05T00:25:08Z

docs/source/development/add-ons/theme.md

Should this also be linked from https://6.docs.plone.org/volto/theming/index.html?

Addressed in c80eb56. The enter Theming section would be good to tackle, but not further in this PR.

davisagli · 2024-11-05T00:29:11Z

docs/source/development/add-ons/extend-webpack-add-on.md

+
+# Extend webpack setup from an add-on
+
+Just like you can extend Razzle's configuration from the project, you can do the same with an add-on.


This sentence seems outdated...it assumes the reader is familiar with projects, but that's a concept we're trying to get rid of.

Nice catch. There may be this and other artifacts that should be removed or updated, perhaps with a {deprecated} admonition.

In fact, reading this page, I don't think anything in it still applies. @sneridagh can you take a look at this one?

Addressed in 4b9f837. @davisagli @sneridagh please have a look.

stevepiercy

Let's ask at today's @plone/volto-team meeting for final review, then merge by the end of the day.

davisagli · 2024-11-05T22:38:29Z

@sneridagh @stevepiercy Can we merge?

* main: (27 commits) React Router 7 experimental PoC (#6472) First batch of the overhaul of the add-ons section (#6397) URL Management control panel: show errors from CSV upload (#6473) Release 18.0.3 Release @plone/registry 2.1.2 Preparing for 18.0.3 Fix weird issue in images build with typings (#6471) Release 18.0.2 Release @plone/providers 1.0.0-alpha.5 Release @plone/scripts 3.8.1 Release @plone/components 2.1.1 Fix packaging and plone/components src export (#6470) Release @plone/registry 2.1.1 Repackage registry Release 18.0.1 Release @plone/providers 1.0.0-alpha.4 Release @plone/components 2.1.0 Release @plone/client 1.0.0-alpha.20 Release @plone/scripts 3.8.0 Release @plone/registry 2.1.0 ...

First batch of the overhaul of the add-ons section

a16c9ce

sneridagh requested a review from stevepiercy October 11, 2024 16:19

stevepiercy and others added 3 commits October 13, 2024 21:13

- Hyphenate add-on almost everywhere

d1b2019

- Fix references

Move things around, polish main addons section

c672ec8

sneridagh mentioned this pull request Oct 26, 2024

@plone/registry as ESM module, move to TS, complete documentation #6399

Merged

9 tasks

stevepiercy added 2 commits October 26, 2024 03:09

Update readme-link-check.yml

7d75d60

Merge branch 'main' into overhauladdonssection

8f6864d

Changelog

a016e79

sneridagh and others added 12 commits October 26, 2024 15:18

Merge branch 'main' into overhauladdonssection

6e467a3

* main: [Next.js] Better Vercel deployment (#6441) Replace all `yarn` appearences with `pnpm` (#6433) Add deprecation notices to the Upgrade guide (#6426) Clean up #6422 (#6443)

Merge branch 'main' into overhauladdonssection

08d69c5

Add fundamental reorganization comments for @sneridagh to consider.

f980258

Add more reorganization comments.

fb40a69

Clean up some grammar. Let's avoid "frontend", and instead use "user interface", as this has come to bite us in the backend.

More comments about reorganization

42cf9cf

Remove how-to- from the filename, as everything in this directory i…

724c35c

…s a How-to guide. Add to Development index so it shows up in the main navigation.

Add html_meta info to index

fe27180

Move explanation into correct file.

b0c32eb

Specify Volto 17 as stable release. Include mention of npm Registry with link. Fix grammar and syntax. Apply style guide.

Merge stable and pre-release install an add-on into a single file, an…

7c3437b

…d use Sphinx Design with synched tabs to show relevant commands for each version of Volto

Tidy

224ac7a

Move credit for mrs-developer to explanation.

4a5b4e0

Grammar. MyST markup enhancements.

Shorten sentence with a seealso

afaa94d

stevepiercy approved these changes Nov 4, 2024

View reviewed changes

ksuess requested changes Nov 4, 2024

View reviewed changes

docs/source/development/add-ons/install-an-add-on-dev-18.md Outdated Show resolved Hide resolved

docs/source/development/add-ons/install-an-add-on-dev-18.md Show resolved Hide resolved

ksuess requested changes Nov 4, 2024

View reviewed changes

docs/source/development/add-ons/test-add-ons-18.md Outdated Show resolved Hide resolved

docs/source/development/add-ons/best-practices.md Outdated Show resolved Hide resolved

nileshgulia1 reviewed Nov 4, 2024

View reviewed changes

docs/source/development/add-ons/install-an-add-on-dev-18.md Show resolved Hide resolved

nileshgulia1 approved these changes Nov 4, 2024

View reviewed changes

stevepiercy and others added 5 commits November 4, 2024 03:05

Update docs/source/development/add-ons/install-an-add-on-dev-18.md

da3f8de

Co-authored-by: Katja Süss <k.suess@rohberg.ch>

Add missing declare the addon as Volto addon

0ff5bc1

Complete the test in Volto 18 document

9ce6498

Fix best practices pointing to the right document

790427b

Clarification of nested packages folders in Cookieplone generated add…

e2745ce

…-ons

stevepiercy requested changes Nov 4, 2024

View reviewed changes

Apply suggestions from code review

5fc5d2e

davisagli approved these changes Nov 5, 2024

View reviewed changes

stevepiercy added 99 tag: docs-reorg Reorganization of docs following Diátaxis Framework 99 tag: has docs This pull request has documentation labels Nov 5, 2024

stevepiercy added 4 commits November 4, 2024 23:47

Add deprecation notice of project based configuration.

4b9f837

Fix ref link

26c8d3d

Add a link to "Create a Volto theme add-on".

c80eb56

Merge branch 'main' into overhauladdonssection

f8eaa59

stevepiercy requested review from ksuess and stevepiercy November 5, 2024 08:06

stevepiercy approved these changes Nov 5, 2024

View reviewed changes

stevepiercy mentioned this pull request Nov 5, 2024

Update link in Admin Guide plone/documentation#1752

Closed

Merge branch 'main' into overhauladdonssection

c3e4066

ksuess approved these changes Nov 5, 2024

View reviewed changes

stevepiercy merged commit 5d08348 into main Nov 5, 2024
69 checks passed

stevepiercy deleted the overhauladdonssection branch November 5, 2024 23:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

First batch of the overhaul of the add-ons section #6397

First batch of the overhaul of the add-ons section #6397

sneridagh commented Oct 11, 2024 •

edited by stevepiercy

Loading

netlify bot commented Oct 11, 2024 •

edited

Loading

sneridagh commented Oct 22, 2024

stevepiercy commented Oct 22, 2024

sneridagh commented Oct 23, 2024

stevepiercy commented Oct 26, 2024

stevepiercy commented Oct 26, 2024

stevepiercy commented Oct 26, 2024

sneridagh commented Oct 26, 2024

stevepiercy commented Oct 26, 2024

sneridagh commented Nov 3, 2024

stevepiercy left a comment

nileshgulia1 left a comment

stevepiercy left a comment

davisagli left a comment

davisagli Nov 5, 2024

stevepiercy Nov 5, 2024

davisagli Nov 5, 2024

stevepiercy Nov 5, 2024

stevepiercy Nov 5, 2024

stevepiercy Nov 5, 2024

stevepiercy left a comment

davisagli commented Nov 5, 2024


		# Extend webpack setup from an add-on

		Just like you can extend Razzle's configuration from the project, you can do the same with an add-on.

First batch of the overhaul of the add-ons section #6397

First batch of the overhaul of the add-ons section #6397

Conversation

sneridagh commented Oct 11, 2024 • edited by stevepiercy Loading

netlify bot commented Oct 11, 2024 • edited Loading

✅ Deploy Preview for plone-components canceled.

sneridagh commented Oct 22, 2024

stevepiercy commented Oct 22, 2024

sneridagh commented Oct 23, 2024

stevepiercy commented Oct 26, 2024

stevepiercy commented Oct 26, 2024

stevepiercy commented Oct 26, 2024

sneridagh commented Oct 26, 2024

stevepiercy commented Oct 26, 2024

sneridagh commented Nov 3, 2024

stevepiercy left a comment

Choose a reason for hiding this comment

nileshgulia1 left a comment

Choose a reason for hiding this comment

stevepiercy left a comment

Choose a reason for hiding this comment

davisagli left a comment

Choose a reason for hiding this comment

davisagli Nov 5, 2024

Choose a reason for hiding this comment

stevepiercy Nov 5, 2024

Choose a reason for hiding this comment

davisagli Nov 5, 2024

Choose a reason for hiding this comment

stevepiercy Nov 5, 2024

Choose a reason for hiding this comment

stevepiercy Nov 5, 2024

Choose a reason for hiding this comment

stevepiercy Nov 5, 2024

Choose a reason for hiding this comment

stevepiercy left a comment

Choose a reason for hiding this comment

davisagli commented Nov 5, 2024

sneridagh commented Oct 11, 2024 •

edited by stevepiercy

Loading

netlify bot commented Oct 11, 2024 •

edited

Loading