-
Notifications
You must be signed in to change notification settings - Fork 363
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
site: Advanced website navigation #517
Conversation
- added responsive collapsible navbar (+requires bootstrap.js, jquery) - added a homepage (previously was docs ToC) - added ToC pages for sub-sections (e.g. /docs/user-guide) - add 404 page - limit the content to 840px to avoid long lines on large screens Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
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.
Looks pretty good.
Two nits:
- navigation is a bit surprising, because the back button does not go back to the user docs overview page, but the full documentation overview. Maybe nothing that need immediate attention but would be good to solve this at some point.
- the nav bar is not rendered. Is that intentional?
YEAHHHH about that. So normally I was planing to do this:
Then I pivoted my thinking:
Some options we have here:
|
I think smaller Toc pages are really helpful, so let's try to retain that. Maybe your option 3 creates the least confusion, even though not all of these intermetidate ToC make a lot of sense? |
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
Codecov Report
@@ Coverage Diff @@
## master #517 +/- ##
==========================================
- Coverage 59.12% 58.85% -0.28%
==========================================
Files 23 23
Lines 1003 1011 +8
==========================================
+ Hits 593 595 +2
- Misses 350 358 +8
+ Partials 60 58 -2
Continue to review full report at Codecov.
|
<script src="https://code.jquery.com/jquery-3.4.1.slim.min.js" integrity="sha384-J6qa4849blE2+poT4WnyKhv5vZF5SrPo0iEjwBvKU7imGFAV0wwj1yYfoRSJoZ+n" crossorigin="anonymous"></script> | ||
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/js/bootstrap.min.js" integrity="sha384-wfSDF2E50Y2D1uUdj0O3uMBJnjuUD4Ih7YwaYd1iqfktj0Uod8GCExl3Og8ifwB6" crossorigin="anonymous"></script> |
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.
What are those two good for? I cant see where it's used.
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.
Collapsible navbar (first sentence in the PR description) :)
We can use for more stuff in the future.
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.
ah.. I should have resized my window 😄
Oh no, there's a broken link: https://staging.krew.dev/docs/developer-guide/release/new-plugin/ -> list item 3 Nice test for the 404 page though 😉 |
fixed. |
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ahmetb, corneliusweig The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Signed-off-by: Ahmet Alp Balkan ahmetb@google.com
Related issue: #509 #514