-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add a "Learn" page #2053
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
base: gh-pages
Are you sure you want to change the base?
Add a "Learn" page #2053
Conversation
Amazing! |
@jvns The big orange button to "Read the book" is a bit distracting. It pulls in too much attention making you think you need to click it before you can continue to the next step (next box) in the "Learn" process. |
I wonder if GUIs also belong under Learn? I think they are too far hidden under Download. |
Can you say what it is about the Font Awesome icons? I'm wondering if there are some easy tweaks to make it feel better. For me I think "book" icon and the "download" icons are my least favourites, I liked how the original book icon had pages. The squircles were actually an accident -- what happened was that the circles were cutting off part of the image, so I made it a squircle instead to fix that. I'm glad you think it works! |
Removed the "Read the book!" button, I don't think it's necessary since that div is already highlighted. I tried adding "GUI Clients" under "Learn" but it didn't feel right to me. Maybe a separate Tools section, kind of like https://www.rust-lang.org/tools? There are other great Git tools out there other than GUI clients that could be featured, like https://pre-commit.com/ or git-absorb |
@jvns I'm purely talking from a personal taste. But I think they are too roundish. As far as I know they are designed to work at smaller size, and upsizing them makes them also a little too bold for my taste (compare the speech bubbles for example, line width is too thick now). And the corners are too round for my liking.
💜
Sounds good. But can happen separately. Shall I file and issue?
And I think TUI tools (like lazygit) and editor extensions are better separated too. |
#2070 done! |
Also use flexbox instead of `float: left` to lay out everything in a grid; it looks like this CSS was written before flexbox existed and flexbox is simpler.
Move videos, Pro Git book, and external links to Learn section. Will require the book CI to rerun to update the section of the site the book is in.
- Add a new videos summary shortcode to make the videos more compact - Add a new `.callout.icon` class to give the page a more unified look - Add font awesome icons
This makes the reference docs immediately available for the sidebar. Make /doc an alias for /docs (the reference landing page), to avoid broken links.
There was no "Learn" or "Videos" icon, and I wanted the icons to match, so we need new icons! There are GPL compatible according to their website. Integrated these icons as SVGs (just copied and pasted from their site) to keep file sizes down, the main Font Awesome CSS file is pretty big. This should make it easier to update the icons in the future. Switch from using `float:` to `display: grid` to display the icons.
Updated via the `update-git-version-and-manual-pages.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
Updated via the `update-book.yml` GitHub workflow.
I've rebased this and fixed the issues I saw. I tried to look for icon packs briefly but didn't find anything, but hopefully it's easy to change the icons later if we find something better. Need to wait for CI to make sure that no links are broken. |
Yeah, don't worry about them right now. I've opened #2077 |
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.
I like the new structure!
We talked about making a "Learn" page in #2046 and folks seemed enthusiastic, so I took a stab at making a basic page. You can see it here: https://jvns.github.io/git-scm.com/learn. The idea is now that "Reference" links directly to the reference documentation, and that the old
/doc/
page will redirect to the reference documentation.I used Font Awesome icons (GPL compatible) because there was no "Learn" or "Videos" icon, and I wanted the icons to match. I also moved a couple of things to use flexbox/grid honestly because I have never learned how
float: left
works and so it was much easier for me to make the changes I needed to make by using flexbox or grid. Happy to come up with a different approach if folks are concerned about grid availability in browsers.I removed links to a couple of cheat sheets on the "Docs" page. Potentially worth adding those back later if/when "External Links" gets revisited. (I'm collecting some resources here)
Problems I still need to resolve:
/doc => /docs/
redirect actually works.I haven't thought too hard about the page's copy yet. I think it would be nice to describe the videos and the book a tiny bit more.(I think I'm out of ideas here right now)This closes #2055