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

Restructure website #37

Merged
merged 11 commits into from
Jun 26, 2023
Merged

Restructure website #37

merged 11 commits into from
Jun 26, 2023

Conversation

niksirbi
Copy link
Member

Close issue #33

This PR reorganises the website as discussed under issue #33 .

Summary of main changes

  • The 3 main sections are "Data Analysis", "Programming", "Open Science"
  • Each section may contain several markdown files, each corresponding to a specific long-form how to guide
  • Small tips/tricks that don't warrant a long guide can go into a "Troubleshooting,md" file under the appropriate section.
  • We no longer have sub-sections for specific data types. If we have have the luxury of having too many data analysis guides, we can reintroduce them.
  • I've reorganised the existing content according to the above principles
  • I updated the homepage, README and CONTRIBUTING accordingly
  • The homepage now has cards

@niksirbi niksirbi marked this pull request as ready for review June 23, 2023 15:52
@niksirbi niksirbi requested a review from adamltyson June 23, 2023 15:52
@adamltyson
Copy link
Member

Looks good @niksirbi. I have a few suggestions. I know these mostly aren't part of this PR, but if we're restructuring the whole site, now seems a good time to make some decisions.

  • I would remove the TOC on the main page. Eventually this will get very long and hard to navigate
  • I would remove any "Coming soon" sections. These should just be added when they're ready.
  • I'd reduce the toc depth on the data analysis, programming and open science pages. I find it hard to navigate, and I can't see anyone wanting to head straight for a specific subsection of a guide.
  • Lastly, I'd remove the "show source" button.

Copy link
Member

@adamltyson adamltyson left a comment

Choose a reason for hiding this comment

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

I've approved, as this can be merged as is, and the other comments tackled separately if that's easier.

@niksirbi
Copy link
Member Author

Looks good @niksirbi. I have a few suggestions. I know these mostly aren't part of this PR, but if we're restructuring the whole site, now seems a good time to make some decisions.

  • I would remove the TOC on the main page. Eventually this will get very long and hard to navigate
  • I would remove any "Coming soon" sections. These should just be added when they're ready.
  • I'd reduce the toc depth on the data analysis, programming and open science pages. I find it hard to navigate, and I can't see anyone wanting to head straight for a specific subsection of a guide.
  • Lastly, I'd remove the "show source" button.

Thanks for the feedback @adamltyson! I've implemented all the above suggestions in this PR.
Merging now.

@niksirbi niksirbi merged commit 6266b5a into main Jun 26, 2023
@niksirbi niksirbi deleted the restructure-website branch June 26, 2023 08:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants