Skip to content

reorder pages in sidebar #458

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

namiroues
Copy link
Contributor

Pages on sidebar are in this order now:

Home
Getting Started
Learning MDAnalysis
Documentation
MDAKits and MDA-based tools
Contribute
Community
Events
Citations
About MDAnalysis
MDAnalysis team
Blog
Privacy Policy

Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

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

Fine with me.

(Eventually it would be good to condense even more or use foldable submenus.)

@namiroues namiroues added the SDG23 work on Small Development Grant 2023 label Apr 5, 2025
Copy link
Contributor

@micaela-matta micaela-matta left a comment

Choose a reason for hiding this comment

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

Thanks @namiroues for implementing the changes we discussed in our meeting 🙏

@github-project-automation github-project-automation bot moved this from Todo to In Progress in Streamlining Documentation (SDG23) Apr 5, 2025
@namiroues
Copy link
Contributor Author

Following up on the meeting suggestions by @micaela-matta and @jennaswa the new order is now:

Home
About MDAnalysis
News (renamed from Blog for clarity - waiting feedback from @orbeckst on this before changing all files)
Getting Started
Learning MDAnalysis
Documentation
Events
Community
Contribute
MDAnalysis Team
MDAKits (shortened name for clarity - other possible options "MDAKits and extensions", or "MDAKits and dependencies")
Citations
Privacy Policy

Also, the core pages have been moved to the top level.

@namiroues namiroues requested a review from orbeckst April 5, 2025 09:01
Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

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

Changes look fine to me. I like the lifting of core pages to top level. It just has the potential to break a lot of links. Some of these will be external links into our site and we'll just have to deal with this as we go along but if there's a way to check the whole site for broken links after the change then we should do that – can you raise an issue for doing that, please?

Could you please also check the wiki pages that deal with GSOC and update links there, in case they break?

@jennaswa
Copy link
Contributor

jennaswa commented Apr 7, 2025

Thanks, @namiroues ! Looking at it all together (and sorry to get so nitpicky on these things), Events seems like a sub-category to Community to me, and would make slightly more sense to me just below Community, but I don't feel too strongly here. If we do ultimately get around to doing a collapsable sidebar, this could be an example of where pages could potentially be condensed/combined further.

@namiroues
Copy link
Contributor Author

I resolved the conflicts @micaela-matta. Could you please check and merge? Thank you.

Copy link
Contributor

@jennaswa jennaswa left a comment

Choose a reason for hiding this comment

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

Thank you so much for the hard work on this @namiroues! I think it looks great and am happy with the main goal of this PR (i.e., the sidebar order). However, I've left a couple of suggestions/comments for resolution before I would say this is ready to merge.

- **Join the Community:** Connect with other users, report issues, and contribute through multiple channels. Learn more on our [Community]({{ site.baseurl }}/pages/community/) page.
- **Contribute:** Whether through coding, documentation, community support, or event organization, you can help shape the MDAnalysis ecosystem. Get started with our [Contributing Guide]({{ site.baseurl }}/pages/contribute/) or [join a team]({{ site.baseurl }}/pages/team/) to support specific initiatives.
- **Join the Community:** Connect with other users, report issues, and contribute through multiple channels. Learn more on our [Community]({{ site.baseurl }}/community/) page.
- **Contribute:** Whether through coding, documentation, community support, or event organization, you can help shape the MDAnalysis ecosystem. Get started with our [Contributing Guide]({{ site.baseurl }}contribute/) or [join a team]({{ site.baseurl }}team/) to support specific initiatives.
Copy link
Contributor

Choose a reason for hiding this comment

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

@namiroues - Have you built the page locally to see that the {{ site.baseurl }}blahblahblah/ pages render (as opposed to {{ site.baseurl }}/blahblahblah/ with a leading slash)? Just curious as I've always used the leading slash, and Oliver's comment from an old issue indicates there may have been a point that things broke without the leading slash.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, links break without the leading slash. I am going through all links to update. Apologies for missing this.

@@ -46,7 +46,7 @@ MDAnalysis is:
- **Openly developed** — The [source code]({{ site.github.repo }}) is hosted on GitHub.
- **Regularly updated** — Official releases are distributed via [PyPI][].
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- **Regularly updated** — Official releases are distributed via [PyPI][].
- **Regularly updated** — Official releases are distributed via [PyPI]({{ site.pypi.package }}).

There are several cases like this where we can (and should) pull from the _config file. I'll admit I haven't been diligent about this, and it may be worth just opening an issue (if we don't have one already) to update these links throughout the entire repo to be consistent.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks Jenna, sounds like a good idea. I will open a new issue about this and slowly update all links for consistency.

@@ -1,7 +1,7 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there an advantage to having this as its own page, rather than putting it all together on the Getting Started page? As is, the getting started page feels very sparse to me and links rather quickly to the learning page; it seems there is a good opportunity to merge these two pages for simplicity rather than circular links to each other.

@@ -1,7 +1,7 @@
---
layout: page
title: About MDAnalysis
order: 10
order: 1
---

<img src="{{ site.baseurl }}/public/mdanalysis-logo_square.png"
Copy link
Contributor

Choose a reason for hiding this comment

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

The Mission page feels like it goes missing to me being linked here. Thoughts on adding it back in as it's own section here on the About page (instead of as a separate Mission page)?

Comment on lines +34 to +36
- [Community]({{ site.baseurl }}/community/) &mdash; Get involved, ask questions, and collaborate.
- [News]({{ site.baseurl }}/blog) &mdash; Stay updated with development news and community highlights.
- [Events]({{ site.baseurl }}/events/) &mdash; Join workshops, conferences, and mentoring programs.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- [Community]({{ site.baseurl }}/community/) &mdash; Get involved, ask questions, and collaborate.
- [News]({{ site.baseurl }}/blog) &mdash; Stay updated with development news and community highlights.
- [Events]({{ site.baseurl }}/events/) &mdash; Join workshops, conferences, and mentoring programs.
- [News]({{ site.baseurl }}/blog) &mdash; Stay updated with development news and community highlights.
- [Community]({{ site.baseurl }}/community/) &mdash; Get involved, ask questions, and collaborate.
- [Events]({{ site.baseurl }}/events/) &mdash; Join workshops, conferences, and mentoring programs.

Sorry to be nit-picky, but this would keep things in the order that they appear in the sidebar. As an aside, if mentoring programs moves (see my comment above), the description for Events should change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
SDG23 work on Small Development Grant 2023
Projects
Development

Successfully merging this pull request may close these issues.

4 participants