Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Remove top and side bars for API docs #38

Closed
erictune opened this issue Mar 2, 2016 · 0 comments
Closed

Remove top and side bars for API docs #38

erictune opened this issue Mar 2, 2016 · 0 comments
Milestone
post-launch

Comments

@erictune
Copy link
Member

erictune commented Mar 2, 2016

By API documentation, I mean http://kubernetes.io/v1.1/docs/api-reference/v1/operations.html and the corresponding pages for 1.2, once that is branched, and also http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html.

Don't have the k8s.io nav sidebar when viewing docs. The docs need their own nav sidebar, since docs are so long. If possible, extract all the h3's from the html and generate a sidebar with a list of those topics. If that isn't practical, then just get rid of the sidebar as it isn't helping.

Also, don't have the k8s.io top nav bar when viewing docs. If the person has found the API docs, they probably already are comfortable navigating other K8s.io documentation and don't need the top nav bar.

Copied from kubernetes/kubernetes#22389
@johndmulhausen johndmulhausen added this to the post-launch milestone Mar 3, 2016
xingzhou pushed a commit to xingzhou/official.kubernetes.github.io that referenced this issue Aug 8, 2017
Merge pull request kubernetes#38 from yangtxiang/master
f5c6f99 
getting-started-guides-ubuntu-monitoring-pr-2017-07-15
@vetbijaya vetbijaya mentioned this issue Apr 19, 2020
Closed
imjasonh pushed a commit to imjasonh/website that referenced this issue Sep 2, 2020
@bobcatfish @tekton-robot
Update DEVELOPMENT.md to describe netlify workflow
8d4855f 
The DEVELOPMENT.md was very out of date! Also uncovered some difficult
to work with things along the way such as tektoncd/website#38
which made it so that you need credentials to access the GCP bucket with
the background image in order to be able to run the sync script. I've
added a very hacky env var which lets one skip this until we tackle kubernetes#38
serathius pushed a commit to serathius/website that referenced this issue Mar 16, 2022
@lucperkins
Merge pull request kubernetes#38 from snowjunkie/patch-1
67fb02e 
Minor typo correction
Okabe-Junya pushed a commit to Okabe-Junya/website that referenced this issue Dec 4, 2023
@IdealUsrname @CathPag
First pass for the style guide (kubernetes#38)
773dd3a 
* First pass for the style guide

Solving for kubernetes#6 

I added some extra categories. Would love feedback on formatting.

* Update style-guide.md

Fixed two typos and a spacing issue

* Removed multiple categories.

A discussion should be created around how categories will be used.

Co-authored-by: CathPag <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
post-launch
Development

No branches or pull requests
3 participants
@johndmulhausen @jaredbhatti @erictune