site: Advanced website navigation

[ahmetb]

Temporary staging at http://staging.krew.dev/

• 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
• move logo to /static/img

Signed-off-by: Ahmet Alp Balkan ahmetb@google.com

Related issue: #509 #514

[corneliusweig]

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?

[ahmetb]

• 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.

YEAHHHH about that.

So normally I was planing to do this:

• Have a single /docs/ page that shows the Table of Contents
• ToC only links to leaf pages, sections are unlinked.
• If user goes to an intermediate docs page by deleting some portion of the URL, e.g. /docs/user-guide/ → 404 Not Found.

Then I pivoted my thinking:

• Retain the /docs/ home.
• From / home page have links to User Guide and Developer Guide, by creating ToC pages for those (this actually means /docs/user-guide/setup/ also will have a ToC page, but unless user types it manually, it's unreachable).
• Problem: User Guide → $SOME_PAGE → Back takes you to /docs/ home; not User Guide.

Some options we have here:

1. Don't render sub-section pages e.g. /docs/user-guide/ and just have a huge ToC. (we lose the nice & short User Guide page).

2. Retain existing (confusing)

3. Make <-- Back go to "parent" page: Sadly, makes no sense for intermediate pages like Docs > User Guide > SubSection > SubSection2 > Page :(

[corneliusweig]

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?

[codecov-io]

Codecov Report

Merging #517 into master will decrease coverage by 0.27%.
The diff coverage is n/a.

@@            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

Impacted Files	Coverage Δ
internal/index/indexscanner/scanner.go	66.1% <0%> (-6.45%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c3b34c1...a311da8. Read the comment docs.

[corneliusweig]

What are those two good for? I cant see where it's used.

[ahmetb]

Collapsible navbar (first sentence in the PR description) :)
We can use for more stuff in the future.

[corneliusweig]

ah.. I should have resized my window 😄

[corneliusweig]

Oh no, there's a broken link: https://staging.krew.dev/docs/developer-guide/release/new-plugin/ -> list item 3 plugin manifest

Nice test for the 404 page though 😉

[ahmetb]

Oh no, there's a broken link: staging.krew.dev/docs/developer-guide/release/new-plugin -> list item 3 plugin manifest

fixed.

[corneliusweig]

/lgtm
/approve
Nice work! Now we only need to deploy to netlify and we're good :)

[k8s-ci-robot]

[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:

• OWNERS [ahmetb,corneliusweig]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment