Revamp navigation bar

[rgaiacs]

This implements carpentries/lesson-infrastructure#18.

[fmichonneau]

I really like this change.

1. Is there an easy way to show the episode numbers in the dropdown menu. If we include setup and all in one there, I think it's important to make the episodes stand out even more by including their numbers.
2. If we move forward on this, I agree with Christina that the instructor notes should be at the top. Maybe after "improve this page"?

[fmichonneau]

did you intend to include mathjax here?

[rgaiacs]

No. Sorry about it.

[rgaiacs]

Is there an easy way to show the episode numbers in the dropdown menu.

I think so.

[maxim-belkin]

I looooove this one

[rgaiacs]

aaa1919 implements the suggestion at carpentries/lesson-infrastructure#18 (comment).

Screenshots

Changes to File System

The template now has the following directories

• _extras4learners

  Any extra material targeting learners goes here. At the moment it includes setup.md, reference.md and discuss.md.

• _extras4instructors

  Any extra material targeting instructors goes here. At the moment it includes notes.md (previous called guide.md), aio.md (all episodes in one page) and figures.md (all figures in one page). In the future we can add exercises.md (all exercises in one page).

• _extras

  Any extra material that doesn't fit into _extras4learners and _extras4instructors. At the moment it includes about.md (information about The Carpentries).

TODO

• @fmichonneau to review aaa1919
• @maxim-belkin to review aaa1919
• @ChristinaLK to review the screenshots
• @brownsarahm to review the screenshots
• @rgaiacs to update 03-organization.md (include the description of the new folders and update image)

[ChristinaLK]

LGTM!

[fmichonneau]

This looks great Raniere!

My comments:

• replace _extras4instructors with _extras_instructors
• replace _extras4lerners with _extras_learners

Unless there is a good technical reason for it, I would suggest the navigation bar reflects the organization of the files in the repository. Therefore, I think it would be best if about.md was at the root instead of being in _extras by itself. If in the future we need to create an _extras directory we can revisit this.

The bar seems a little crowded to me. I think we could move "License" to the footer next to the copyright information to make more room.

I also worry about the unintended consequences and extra work renaming the instructor guide file will have.

[maxim-belkin]

Awesome work!

My comments:

1. I concur with @fmichonneau regarding folder names: _extras_instructors and _extras_learners seem better to me. However, my suggestion is to keep _extras folder and simply create 2 subfolders: _instructors and _learners. In such a case, about.md can stay where it is, or see p.3

2. Again, I agree with @fmichonneau regarding the crowdedness of the navigation bar and think that his suggestion to move LICENSE to the footer is reasonable. I think Code of Conduct can go to the footer as well.
   Related: We don't, actually, need Improve this page menu item in the navigation bar because there is Edit on GitHub link at the bottom.

3. How about an about folder in _extras where we could add about_cp.md and about_lesson.md. In that case, we could add an About menu item to the navigation bar. Moreover, COC and LICENSE could also be moved to that About menu item (but stay where they are "physically"). And/or we could add a link to that not-yet-created "Get involved" page mentioned in Add new "pathway to contribute/get involved" page styles#322.

4. I'm fine with renaming guide.md to notes.md. I think we just have to provide thorough instructions on how to handle this change well in advance in a form of Heads up from upstream issues.

I'll have a look at the actual diff later

[rgaiacs]

simply create 2 subfolders: _instructors and _learners

I will need to check how Jekyll behave when collections is one subfolder.

think that his suggestion to move LICENSE to the footer is reasonable. I think Code of Conduct can go to the footer as well.

Related: We don't, actually, need Improve this page menu item in the navigation bar because there is Edit on GitHub link at the bottom.

I think that is important to have License and Code of Conduct at the navigation bar. One option is to have under "About"/_extras. The reason to have "Improve this page" at the menu and "Edit on GitHub" at the bottom is for improve user experience. If you are one instructor and know what episode you want to edit, you can get the link from the navigation bar. If you are one learner and reach the end of the episode and want to submit some change, you can use the link at the end. Because I don't have access to Google Analytics I can't make any decision based on data.

[fmichonneau]

I'm going to close this as the next iteration of the lesson infrastructure will have a new structure for the top navigation bar.