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

Change home page UI #1875

Merged
merged 35 commits into from
Mar 16, 2025
Merged

Change home page UI #1875

merged 35 commits into from
Mar 16, 2025

Conversation

Manas-Kenge
Copy link
Contributor

@Manas-Kenge Manas-Kenge commented Feb 28, 2025

Issue number

Description

This is the first draft of the UI. Any suggestions are welcome.

Add screenshots or links to a preview of the changes

image


📚 Documentation preview 📚: https://plone6--1875.org.readthedocs.build/

Copy link

boring-cyborg bot commented Feb 28, 2025

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, read Plone's Code of Conduct and Contribute to documentation, as this will greatly help the review process.

Welcome to the Plone community! 🎉

@Manas-Kenge
Copy link
Contributor Author

@stevepiercy could you review this?

@Manas-Kenge
Copy link
Contributor Author

As per #1787 (comment) added a reference guide page, not much in it but it's a start

@stevepiercy
Copy link
Contributor

@Manas-Kenge I'm super pleased with the result of your work. Thank you!

Would you please delete the text "This documentation is for:" and its bullet points? I think it's just visual noise and not particularly helpful.

Since this is a Big Freaking Deal™, I've requested feedback from the broader community. There may be a lot of discussion and opinions. I'll respond to feedback from other people, and provide further direction, if needed.

I'll do a more thorough review when I have more time.

sneridagh
sneridagh previously approved these changes Mar 2, 2025
Copy link
Member

@sneridagh sneridagh left a comment

Choose a reason for hiding this comment

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

LGTM!

@Manas-Kenge
Copy link
Contributor Author

Thanks for the feedback, @stevepiercy ! I've removed that section. Let me know if there's anything else.

Copy link
Contributor

@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.

@Manas-Kenge thank you so much for taking this on! I'm seeing the future unfold before my eyes, as I envisioned in plone/Products.CMFPlone#4097.

Copy link

@rohnsha0 rohnsha0 left a comment

Choose a reason for hiding this comment

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

LGTM

@Manas-Kenge
Copy link
Contributor Author

@stevepiercy I made changes as per your request but user guide's description needs your attention.

# 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.

@Manas-Kenge Manas-Kenge requested a review from stevepiercy March 5, 2025 05:20
@stevepiercy
Copy link
Contributor

@Manas-Kenge I move at the speed of unpaid open source software volunteers. Thanks for your work and patience. I will give this a thorough review soon.

Copy link
Contributor

@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.

This is looking great. I have a few suggestions, and I want to try to build it locally and test out my assumptions about the toctree and sphinx-reredirects usage before merging.

@jensens
Copy link
Member

jensens commented Mar 6, 2025

I love it, good work!

Copy link
Contributor

@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.

Everything looks good, except the submodule.

I need to work on the two indices before merging.

@jensens

This comment was marked as off-topic.

@stevepiercy

This comment was marked as resolved.

@stevepiercy

This comment was marked as resolved.

@Manas-Kenge Manas-Kenge requested a review from stevepiercy March 11, 2025 19:09
- Add a hidden toctree to keep the same list hidden on the page, but appear in the navigation
- Configure the navigation items to redirect to their sources
@stevepiercy
Copy link
Contributor

This is ready for a final review. I polished up a few minor things. The major changes are with these two sections.

For both sections:

  • Each of the items in the definition list links directly to its authoritative reference documentation.
  • Each of these items is in a hidden toctree element, so that they don't display in the main content of the page, but they do appear in the navigation tree.
  • Each of the items in the navigation tree redirects to the authoritative reference documentation.

@stevepiercy stevepiercy requested a review from a team March 15, 2025 06:43
@stevepiercy
Copy link
Contributor

Last chance to review this PR. I'll merge this weekend, if there are no objections or suggestions for improvement.

@stevepiercy stevepiercy merged commit b4462a8 into plone:6.0 Mar 16, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Make the home page pretty
6 participants