-
Notifications
You must be signed in to change notification settings - Fork 68
Add navigation structure for learn section #83
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
Conversation
Setup a data structure and layouts for navigating pages in the learn section.
#build_preview |
This PR has been built with Jekyll and can be previewed at: https://fortran-lang.org/pr/83/ |
I think this is great and a step forward. I approve. I anticipate that our structure of content will be more unordered than ordered, so we may drop the numbering, but we can figure this out later as we go. |
Restructures the previous monolithic structure into one supporting many independent mini-book tutorials.
This makes for easier navigation.
Okay, I've restructured this PR so that it's less like a single monolithic book with chapters and The name and contents of each mini-book is defined in a yaml data file which is used to: populate the Learn landing page with a list of books, grouped by category; and populate a table-of-contents for each mini-book. To demonstrate this, the Quickstart tutorial has been broken out into multiple pages so it's easier to navigate. The 'Learn' landing page has been updated to also include an initial selection of third-party resources as well. The Learn page is a little bare at the moment, but with the structure now in place it should be quite easy to start adding more mini-book tutorials (starting with #90). #build_preview |
This PR has been built with Jekyll and can be previewed at: https://fortran-lang.org/pr/83/ |
This simplifies the jekyll headers in the mini-books.
@LKedward this looks really great. Lots of work done here thank you! We should put there a link to https://github.com/j3-fortran/fortran_proposals also I think. I think it looks great, +1 from me. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great, thank you Laurence!
I added a few fixes to books information, and also added Arjen's book to the list.
An issue that comes up here is how to sort the books? Currently they don't seem sorted in any particular way. Books at the top of the list will be implicitly given higher priority or sense of importance. So we need to decide how to sort them:
- Alphabetically by title?
- Alphabetically by author last name?
- Chronologically from newest to oldest?
Co-authored-by: Milan Curcic <[email protected]>
Co-authored-by: Milan Curcic <[email protected]>
Co-authored-by: Milan Curcic <[email protected]>
As yes, good point, I hadn't considered this. |
…g.github.io into tutorial-navigation
Print books are now sorted by year descending - this can be changed to alphabetical if desired. |
This PR has been built with Jekyll and can be previewed at: https://fortran-lang.org/pr/83/ |
This looks really great. Easy to navigate and read! Really good job! |
Thanks all for the feedback and suggestions. I will now merge and work on updating the contributor guide with instructions in a new PR. |
#delete_preview |
The preview build for this PR has now been deleted. |
As we expand the Quickstart tutorial and others start contributing tutorial content, we need a central structure for organising the learning pages on the site.
I've drafted a possible solution in this PR:
This approach:
To add a page, contributors need only write a markdown file and add an entry under the appropriate chapter in the yaml data file. (I will update CONTRIBUTING.md)
For this draft PR I've just included the existing quickstart tutorial to demonstrate; eventually the landing page will be updated to include useful links etc.
@milancurcic , @certik what are your thoughts?
#build_preview