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

Modifying the outreach section of the website #1005

Closed
wants to merge 2 commits into from

Conversation

martamaja10
Copy link
Contributor

Our outreach/learning section of the website is a bit outdated and not well organised. The idea is to, first of all, update the links to the most recent student-course and remove link duplications so if we are to share a link to a person who's only starting with ROOT we have it all nicely described and organised (and up to date).

Questions to be addressed later (maybe here or with separate PRs):

  • Do we leave the section as "Get Started" or do we rename it to, for example "Learn" (get started could be confusing as we also have a section "Install")
  • We keep adding links to the same things in many places (I started by deleting it from the Manual section), I think we should clean the ROOT Reference Documentation: https://root.cern/doc/master/index.html entry page?
  • It would be a great time to also sort out our Tutorials and make sure what we have is really relevant and not outdated
  • Shall we add a "Teachers' corner" somewhere where we point external instructors to the newest and best material they should teach as well? And our recommendation what they should teach about?

@dpiparo
Copy link
Member

dpiparo commented Jun 25, 2024

Good proposal. Preliminary comment: could you submit the pr from a branch of root-project/web so that the preview of the changes is available? Once this is there, I think we can converge quickly on the approval.

Then, more in details about your very relevant bullet points:

Do we leave the section as "Get Started" or do we rename it to, for example "Learn" (get started could be confusing as we also have a section "Install")

My personal opinion is that "Learn" would be clearer.

We keep adding links to the same things in many places (I started by deleting it from the Manual section), I think we should clean the ROOT Reference Documentation: https://root.cern/doc/master/index.html entry page?

My personal opinion is that all duplications should be eliminated.

It would be a great time to also sort out our Tutorials and make sure what we have is really relevant and not outdated

I believe you are right. Periodically this work is more than welcome: this is relative to the main root repository though, and I would move the discussion there if you agree. We have a legacy category there to collect old tutorials. New tutorials could be written if any important feature is not properly illustrated. Moreover, legacy usage of classes/C++ could be corrected, for example using modern (yet simple) C++. It's not a lot of work, but with a great impact: tutorials are our code examples, from which people can start copying or being inspired.

Shall we add a "Teachers' corner" somewhere where we point external instructors to the newest and best material they should teach as well? And our recommendation what they should teach about?

My personal opinion is that kind of information would be very welcome. The name should come out by consensus of the team, but I think a name like "For teachers" could be clearer.

Copy link
Contributor

@enirolf enirolf 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 great, thanks! I've added a few suggestions (some are personal grammar/structure preferences, feel free to ignore). My two cents regarding your questions:

Do we leave the section as "Get Started" or do we rename it to, for example "Learn" (get started could be confusing as we also have a section "Install")

I would be partial to "Learn"!

We keep adding links to the same things in many places (I started by deleting it from the Manual section), I think we should clean the ROOT Reference Documentation: https://root.cern/doc/master/index.html entry page?

I think we should remove all these (back)links from the reference. Ideally the index page for the docs should have links to the most relevant interfaces instead (but we can and should tackle this in a seperate PR).

It would be a great time to also sort out our Tutorials and make sure what we have is really relevant and not outdated

💯 👍 💯 👍 💯 👍

Shall we add a "Teachers' corner" somewhere where we point external instructors to the newest and best material they should teach as well? And our recommendation what they should teach about?

💯 👍 💯 👍 💯 👍

get_started/index.md Show resolved Hide resolved
get_started/index.md Show resolved Hide resolved
get_started/index.md Show resolved Hide resolved
get_started/index.md Show resolved Hide resolved
get_started/index.md Show resolved Hide resolved
@dpiparo
Copy link
Member

dpiparo commented Jun 27, 2024

Hi marta. Can you submit this very PR but after pushing your branch to this repo and not your fork? This would allow the CI to build a test version of the site we can vision
What do you think?

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.

3 participants