Skip to content
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

[seven] - Rearrange docs #6856

Open
wants to merge 9 commits into
base: seven
Choose a base branch
from
Open

[seven] - Rearrange docs #6856

wants to merge 9 commits into from

Conversation

sneridagh
Copy link
Member

@stevepiercy moved the docs to the root, amend a bit index.md.

Take a look maybe I overlooked something.

Again, why don't we do this in main?

@sneridagh sneridagh requested a review from stevepiercy March 23, 2025 10:20
@stevepiercy
Copy link
Collaborator

Do what exactly to main? You did two major things:

  • Promoted documentation from docs/source to docs
  • Started writing docs for Seven

plone/documentation pulls in plone/volto:main and publishes it at 6.docs.plone.org as official docs.

I'm fine with moving the docs up a directory. That's not a big deal. We'll need to fiddle with submodules, symlinks, and paths.

I don't understand pulling in Seven modifications for publishing at 6.docs.plone.org at this time, unless you want to thoroughly confuse active Volto users.

@sneridagh
Copy link
Member Author

@stevepiercy I was refering to remove the "source" directory in main :)
Obviously, the changes in the index are only for this branch. Did you realise this is targeted to the 7 branch, right?

@stevepiercy
Copy link
Collaborator

Yes, but your question was ambiguous.

@stevepiercy
Copy link
Collaborator

And as far as changing the location of volto docs on its main branch, it's merely scratching an itch for no benefit from busy work in documentation. I've got too many higher priorities to take this on.

Copy link
Collaborator

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

I have a couple of questions.

I wordsmithed the Rationale section, removing tones of exasperation and frustration, while adding deliberate and sensible direction.

After merging this, can you please rename this branch to seven? I'm sorry, but this really messes with me, because numerical branches are usually reserved for version number tags. It also is hard to search for, as RTD demonstrated.

docs/news Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this a symlink? GitHub's UI doesn't indicate what this is.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think it's a mistake or a leftover? It shoud have been inside my sources folder for some reason...

Copy link
Member Author

Choose a reason for hiding this comment

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

ok, there was an ignore for that, probably it's something done by some sync script.

@sneridagh sneridagh changed the title [7] - Rearrange docs [seven] - Rearrange docs Mar 25, 2025
sneridagh and others added 5 commits March 25, 2025 15:52
@sneridagh
Copy link
Member Author

@stevepiercy ready.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Delete docs/_build and everthing else within. Make sure it is in .gitignore correctly.

@@ -67,9 +67,9 @@ public/critical.css
packages/volto/data

# Sphinx and MyST
docs/_build/
Copy link
Collaborator

Choose a reason for hiding this comment

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

You committed this directory, but should not have done so.

The Seven user interface (UI) is a React-based frontend for [Plone](https://plone.org).

Seven is the codename for the successor of Volto.
The codename is _temporary_, the final name of the product has to be decided in the future, by the community when the release happens.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we really want to say "by the community"? I might remove it.

Suggested change
The codename is _temporary_, the final name of the product has to be decided in the future, by the community when the release happens.
The codename is _temporary_, the final name of the product will be chosen by the community when the release happens.


Seven is the codename for the successor of Volto.
The codename is _temporary_, the final name of the product has to be decided in the future, by the community when the release happens.
It is under active development [in its own branch `seven`](https://github.com/plone/volto/tree/seven) in parallel with Volto in the `main` branch and current stable branch `18.x.x`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
It is under active development [in its own branch `seven`](https://github.com/plone/volto/tree/seven) in parallel with Volto in the `main` branch and current stable branch `18.x.x`.
It is under active development [in its own branch `seven`](https://github.com/plone/volto/tree/seven) in parallel with both Volto 19 in the branch `main` and the current stable version Volto 18 in the branch `18.x.x`.

A contributor is someone who writes code or documentation for the Volto core packages.

- {doc}`plone:contributing/first-time` is for people who have not yet made a contribution to Plone, Volto, or open source software.
- {doc}`plone:contributing/index` is for people who have not yet signed the Plone Contributor Agreement or contributed to any other project under the GitHub Plone organization, including Volto.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- {doc}`plone:contributing/index` is for people who have not yet signed the Plone Contributor Agreement or contributed to any other project under the GitHub Plone organization, including Volto.
- {doc}`plone:contributing/index` is for all people who want to contribute code to any projects under the Plone GitHub organization, including Volto.

Copy link
Collaborator

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

Almost forgot this one.


# Seven

The Seven user interface (UI) is a React-based frontend for [Plone](https://plone.org).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The Seven user interface (UI) is a React-based frontend for [Plone](https://plone.org).
The Seven user interface (UI) is a fast, elegant, and intuitive React-based frontend for [Plone](https://plone.org).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

2 participants