Update Docs: Pastanaga UI and Quanta #5903

jensens · 2024-03-21T11:24:48Z

After a chat with @sneridagh about Quanta, I took the information and updated the outdated page .

netlify · 2024-03-21T11:25:04Z

✅ Deploy Preview for plone-components canceled.

Name	Link
🔨 Latest commit	`627810d`
🔍 Latest deploy log	https://app.netlify.com/sites/plone-components/deploys/65fc400939f824000842ab90

netlify · 2024-03-21T11:25:04Z

✅ Deploy Preview for volto ready!

Name	Link
🔨 Latest commit	`627810d`
🔍 Latest deploy log	https://app.netlify.com/sites/volto/deploys/65fc400a5807da0008ad6c1d
😎 Deploy Preview	https://deploy-preview-5903--volto.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

jensens · 2024-03-21T11:59:25Z

It seems we have no news folder for documentation changes. I added a check. The prerelease script should find it anyway.

stevepiercy · 2024-03-21T12:06:23Z

The news folder for Volto moved since it became a monorepo to https://github.com/plone/volto/tree/main/packages/volto/news. Docs are for all the packages in the repo, which is why docs/ remains at the repo root.

jensens · 2024-03-21T12:17:08Z

The news folder for Volto moved since it became a monorepo to https://github.com/plone/volto/tree/main/packages/volto/news. Docs are for all the packages in the repo, which is why docs/ remains at the repo root.

This is why I added an allow-check for docs and looked how prereleaser.js works, which globs'**/news/*.*(breaking|feature|bugfix|documentation|internal)', finding the docs/news then as well. This should be fine this way and then all news folders are in it's place.

stevepiercy

See comments about reverting check and where to put news items.

Otherwise, a few minor grammar and syntax suggestions.

Thank you for taking this on. It really needed some polishing from someone who knew the history.

.github/workflows/changelog.yml

stevepiercy · 2024-03-21T12:08:06Z

.github/workflows/changelog.yml

+          git fetch --no-tags origin main
+          towncrier check --compare-with origin/main --dir docs
+        env:
+          BASE_BRANCH: ${{ github.base_ref }}


Please revert.

so, where to put then the changelog for docs if not under /docs/news?

packages/volto/news

...or if you update docs for a specific package, then in its packages/package_name/news.

Done, moved and cleaned the mess up into one commit.

docs/source/contributing/style-guide.md

stevepiercy · 2024-03-21T12:23:39Z

This is why I added an allow-check for docs and looked how prereleaser.js works, which globs'**/news/*.*(breaking|feature|bugfix|documentation|internal)', finding the docs/news then as well. This should be fine this way and then all news folders are in it's place.

We already put documentation change log entries in the news items directory in packages/volto/news. We don't need another check that will not be used. It's also out of scope for this pull request, and should be discussed amongst the Volto team before making changes of this nature.

Co-authored-by: Steve Piercy <web@stevepiercy.com>

jensens · 2024-03-21T14:14:04Z

We already put documentation change log entries in the news items directory in packages/volto/news

Since the placement of the news files are very different from other parts of Plone, I would like to see an explanation at https://6.docs.plone.org/volto/contributing/index.html#change-log-entry - its not obvious.

stevepiercy · 2024-03-21T21:48:04Z

We already put documentation change log entries in the news items directory in packages/volto/news

Since the placement of the news files are very different from other parts of Plone, I would like to see an explanation at https://6.docs.plone.org/volto/contributing/index.html#change-log-entry - its not obvious.

The "see also" link goes to https://6.docs.plone.org/contributing/index.html#change-log-entry which provides sufficient detail.

For Volto, its repository is in a monorepo structure, consisting of several packages in the packages folder. Thus for Volto and its packages, change log entries should be created in packages/PACKAGE_NAME/news/, which is the root of the package.

I can add your suggestion, if you still think it would be beneficial. I would turn it into a snippet and include it, so that we don't use copy-paste. Please let me know. Thank you!

stevepiercy

This is professionally and well-written. Thank you!

stevepiercy · 2024-03-21T21:52:53Z

@sneridagh I'd like your review for accuracy, and let you take the merge honors.

jensens · 2024-03-22T09:28:22Z

We already put documentation change log entries in the news items directory in packages/volto/news

Since the placement of the news files are very different from other parts of Plone, I would like to see an explanation at https://6.docs.plone.org/volto/contributing/index.html#change-log-entry - its not obvious.

The "see also" link goes to https://6.docs.plone.org/contributing/index.html#change-log-entry which provides sufficient detail.

For Volto, its repository is in a monorepo structure, consisting of several packages in the packages folder. Thus for Volto and its packages, change log entries should be created in packages/PACKAGE_NAME/news/, which is the root of the package.

I can add your suggestion, if you still think it would be beneficial. I would turn it into a snippet and include it, so that we don't use copy-paste. Please let me know. Thank you!

Something like "in case of setup/CI/CD or documentation changes not bound to a specific package, use the PACKAGE_NAME=volto"?

sneridagh · 2024-03-24T09:41:20Z

Something like "in case of setup/CI/CD or documentation changes not bound to a specific package, use the PACKAGE_NAME=volto"?

I'd be +1 on clarifying this.

@jensens very well written, it's just awesome. Thanks a lot!

* main: (21 commits) Use fieldset `id` instead of the fieldset `title` in Form when rendering the Field component (#5921) Fix registry wrong default primitive type (#5925) Release @plone/types 1.0.0-alpha.8 Improve types for APIExpanders, export all (#5918) Missing step in storybook migration (#5913) Push missing .d.ts files Release 18.0.0-alpha.25 Release generate-volto 9.0.0-alpha.14 Update Docs: Pastanaga UI and Quanta (#5903) Upgrade to StoryBook 8 (#5912) Fix Storybook in app gen for Volto 18 (#5911) Release 18.0.0-alpha.24 Upgrade `@typescript-eslint` (#5910) Add new cypress helper for slate `getSlateEditorAndType` (#5909) Add id attributes to discussions container and individual comments (#5905) Move testing-library cypress commands import to inner commands so it can be imported (#5906) Release 18.0.0-alpha.23 Release @plone/registry 1.5.4 Improve the usage of RAZZLE_JEST_CONFIG (#5901) fix reordering of slots function (#5840) ...

jensens requested review from stevepiercy and sneridagh March 21, 2024 11:24

jensens force-pushed the docs-styleguide-quanta-update branch 2 times, most recently from c8fdc23 to 2b20e10 Compare March 21, 2024 11:43

stevepiercy requested changes Mar 21, 2024

View reviewed changes

jensens force-pushed the docs-styleguide-quanta-update branch 2 times, most recently from b07f9e9 to bc58c2d Compare March 21, 2024 14:10

Update Docs: Pastanaga UI and Quanta

627810d

Co-authored-by: Steve Piercy <web@stevepiercy.com>

jensens force-pushed the docs-styleguide-quanta-update branch from bc58c2d to 627810d Compare March 21, 2024 14:11

stevepiercy approved these changes Mar 21, 2024

View reviewed changes

sneridagh approved these changes Mar 24, 2024

View reviewed changes

sneridagh merged commit 40526aa into main Mar 24, 2024
74 checks passed

sneridagh deleted the docs-styleguide-quanta-update branch March 24, 2024 09:41

stevepiercy mentioned this pull request Mar 24, 2024

Clarify where to place Volto news items plone/documentation#1646

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Docs: Pastanaga UI and Quanta #5903

Update Docs: Pastanaga UI and Quanta #5903

jensens commented Mar 21, 2024

netlify bot commented Mar 21, 2024 •

edited

netlify bot commented Mar 21, 2024 •

edited

jensens commented Mar 21, 2024

stevepiercy commented Mar 21, 2024

jensens commented Mar 21, 2024

stevepiercy left a comment

stevepiercy Mar 21, 2024

jensens Mar 21, 2024

stevepiercy Mar 21, 2024

stevepiercy Mar 21, 2024

jensens Mar 21, 2024

stevepiercy commented Mar 21, 2024

jensens commented Mar 21, 2024 •

edited

stevepiercy commented Mar 21, 2024

stevepiercy left a comment

stevepiercy commented Mar 21, 2024

jensens commented Mar 22, 2024

sneridagh commented Mar 24, 2024

Update Docs: Pastanaga UI and Quanta #5903

Update Docs: Pastanaga UI and Quanta #5903

Conversation

jensens commented Mar 21, 2024

netlify bot commented Mar 21, 2024 • edited

✅ Deploy Preview for plone-components canceled.

netlify bot commented Mar 21, 2024 • edited

✅ Deploy Preview for volto ready!

jensens commented Mar 21, 2024

stevepiercy commented Mar 21, 2024

jensens commented Mar 21, 2024

stevepiercy left a comment

Choose a reason for hiding this comment

stevepiercy Mar 21, 2024

Choose a reason for hiding this comment

jensens Mar 21, 2024

Choose a reason for hiding this comment

stevepiercy Mar 21, 2024

Choose a reason for hiding this comment

stevepiercy Mar 21, 2024

Choose a reason for hiding this comment

jensens Mar 21, 2024

Choose a reason for hiding this comment

stevepiercy commented Mar 21, 2024

jensens commented Mar 21, 2024 • edited

stevepiercy commented Mar 21, 2024

stevepiercy left a comment

Choose a reason for hiding this comment

stevepiercy commented Mar 21, 2024

jensens commented Mar 22, 2024

sneridagh commented Mar 24, 2024

netlify bot commented Mar 21, 2024 •

edited

netlify bot commented Mar 21, 2024 •

edited

jensens commented Mar 21, 2024 •

edited