reorder pages in sidebar #458
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,7 +1,7 @@ | ||||||
| --- | ||||||
| layout: page | ||||||
| title: About MDAnalysis | ||||||
| order: 1 | ||||||
| --- | ||||||
|
|
||||||
| <img src="{{ site.baseurl }}/public/mdanalysis-logo_square.png" | ||||||
|
There was a problem hiding this comment. 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)? |
||||||
|
|
@@ -14,8 +14,8 @@ The MDAnalysis Project is committed to open-source, reproducible computational r | |||||
| ## Get Involved | ||||||
|
|
||||||
| - **Follow Our Code of Conduct:** We foster a welcoming, inclusive environment. Read our [Code of Conduct]({{ site.baseurl }}/conduct/) before participating. | ||||||
| - **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. | ||||||
|
There was a problem hiding this comment. @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. There was a problem hiding this comment. Yes, links break without the leading slash. I am going through all links to update. Apologies for missing this. |
||||||
| - **Support MDAnalysis:** MDAnalysis relies on grants, sponsorships, and donations to sustain development and community events. Your support helps fund maintenance, development, UGMs (User Group Meetings), workshops, and more. Learn more on our [Funding]({{ site.baseurl }}/pages/funding/) page. | ||||||
| - **Share your Feedback:** MDAnalysis welcomes feedback for improvement from its users and community. Share your thoughts on MDAnalysis, the community, or events by filling out [this feedback form][]. | ||||||
|
|
||||||
|
|
@@ -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][]. | ||||||
|
There was a problem hiding this comment.
Suggested change
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. There was a problem hiding this comment. Thanks Jenna, sounds like a good idea. I will open a new issue about this and slowly update all links for consistency. |
||||||
|
|
||||||
| For full installation instructions and setup guides, visit our [Getting Started]({{ site.baseurl }}/getting_started/) page. | ||||||
|
|
||||||
| [GNU Lesser General Public License, version 2.1 or later (LGPLv2.1+)]: https://www.gnu.org/licenses/lgpl-2.1.html | ||||||
| [PyPI]: https://pypi.org/project/MDAnalysis/ | ||||||
namiroues marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| --- | ||
| layout: page | ||
| title: News | ||
| order: 2 | ||
| --- | ||
|
|
||
| <div class="posts"> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| --- | ||
| layout: page | ||
| title: Contribute | ||
| order: 8 | ||
| --- | ||
|
|
||
| MDAnalysis is an open-source project that welcomes and encourages contributions from the community. Whether you're a developer, documentation writer, or interested in improving the website, there are many ways to get involved. | ||
|
|
@@ -10,13 +10,13 @@ You can contribute by **developing new features, fixing bugs, improving document | |
|
|
||
| Contributions also extend to our **mentoring and outreach programs**, where participants gain hands-on experience in open-source development and scientific software. You can also contribute by **mentoring new contributors**, helping them navigate MDAnalysis, review their work, and share best practices. | ||
|
|
||
| If you're new, you can start by participating in community conversations and mentoring programs. For more information on how you can participate, check out the [Community]({{ site.baseurl }}/community/) and [Events]({{ site.baseurl }}events) pages. | ||
|
|
||
| The [MDAnalysis Project][] hosts several open-source repositories beyond the main library and MDAKits. You are welcome to contribute to any of them! Each repository typically has a `CONTRIBUTING.md` file to help you get started. If you’re unsure where to begin, you can: | ||
|
|
||
| - Check the repository’s issue tracker for open tasks. | ||
| - Submit a pull request for improvements. | ||
| - Contact maintainers via [GitHub discussions][] or MDAnalysis [Community]({{ site.baseurl }}/community/) forums. | ||
|
|
||
| This page provides an overview of how you can contribute to the [Codebase](#contributing-to-the-codebase), [MDAKits](#contributing-to-mdakits), [Documentation](#contributing-to-the-documentation), or [Mentoring & Outreach Programs](#mentoring--outreach-programs). | ||
|
|
||
|
|
@@ -74,7 +74,7 @@ The [API reference]({{ site.docs.mdanalysis.url }}/stable/index.html) is **autom | |
| MDAnalysis has actively participated in various mentoring and outreach programs **to help students, researchers, and early-career contributors gain experience in open-source development and scientific software**. Through these programs, participants receive mentorship, contribute to real-world projects, and develop valuable skills in computational science and software engineering. | ||
|
There was a problem hiding this comment. Looking at this again, this feels a bit out of place to me on the Contributing page; I think it might fit better on the Community page (but please remind me if we made a decision against that for some reason). In fact, earlier on this page we even redirect to Community and Events for more info on participating in mentoring programs: |
||
|
|
||
| ### Stay informed | ||
| For the latest announcements, deadlines, and project ideas, check out our [News]({{ site.baseurl }}/blog/) where we share updates on participation and application guidelines. | ||
|
|
||
| We have been involved in several mentoring initiatives: | ||
|
|
||
|
|
@@ -110,7 +110,7 @@ MDAnalysis has participated in Google Summer of Code for several years, mentorin | |
| - [GSoC 2016]({% post_url 2016-04-26-gsoc %}) | ||
|
There was a problem hiding this comment. Rather than the announcement posts that we're participating as a host organization, I would link to the final project write-ups (where available) and/or student introductions. e.g.,
As an aside, this puts a lot of emphasis on GSoC, without linking to other projects that the team has mentored (e.g., https://github.com/MDAnalysis/MDAnalysis.github.io/blob/master/_posts/2023-08-17-sff-students.md, https://github.com/MDAnalysis/MDAnalysis.github.io/blob/master/_posts/2022-12-15-gsoc_outreachy2022-final.md, https://github.com/MDAnalysis/MDAnalysis.github.io/blob/master/_posts/2024-09-09-outreachy2024-final.md). We also track mentees on the Funding page for each mentorship program. Perhaps there's a way to combine this information so we only have to update it one place? (e.g., maybe instead of linking to GH profiles on the funding page, we link to each individual's final project write-up (when available)). |
||
|
|
||
| ## Other Contributions | ||
| If you are interested in contributing in other ways, such as writing a **blog post**, we welcome contributions that document your experience with MDAnalysis — whether it's learning the software, participating in a UGM, or working on a project. Feel free to reach out via the [Community]({{ site.baseurl }}/community/) page for guidance on submitting a post. | ||
namiroues marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| If you are interested in improving our website, you can refer to the [README file][] in the [Website Repository][]. While the website is already maintained by the MDAnalysis team, any fixes and updates are always welcome. | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,7 +1,7 @@ | ||||||
| --- | ||||||
| layout: page | ||||||
| title: Documentation | ||||||
| order: 5 | ||||||
| --- | ||||||
|
|
||||||
| The MDAnalysis library (`import MDAnalysis`) is open-source code, available under the [GNU Lesser General Public License, version 2.1 or later (LGPLv2.1+)](https://www.gnu.org/licenses/lgpl-2.1.html). MDAnalysis provides **comprehensive documentation** to help users at all levels—whether you're just getting started, developing new tools, or contributing to the project. From **step-by-step tutorials** to an in-depth **API reference**, these resources will guide you through installing, using, and extending MDAnalysis. | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. @IAlibay - Are we cleared to say this, or should we be more specific that code contributions are under LGPLv2.1+, while the package itself is still under LGPLv3+? |
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.