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 redundant, out of sync table of contents #3433

Merged
merged 1 commit into from
May 1, 2017
Merged

Remove redundant, out of sync table of contents #3433

merged 1 commit into from
May 1, 2017

Conversation

olalonde
Copy link
Contributor

@olalonde olalonde commented Apr 16, 2017 •
edited by k8s-reviewable

This table of contents is redundant (it's also available from the side nav) and confusing (not clear if it's a copy of the side nav or contains additional information). Plus, it was out of sync with the actual table of contents (last section on GPU was missing). So, I think it's best to just remove it.

NOTE: Please check the “Allow edits from maintainers” box below to allow
reviewers fix problems on your patch and speed up the review process.
Please delete this note before submitting the pull request.

This change is Reviewable

@olalonde
Remove redundant, out of sync table of contents
bb6cf30 
This table of contents is redundant (it's also available from the side nav) and confusing (not clear if it's a copy of the side nav or contains additional information). Plus, it was out of sync with the actual table of contents (last section on GPU was missing). So, I think it's best to just remove it.
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://github.com/kubernetes/kubernetes/wiki/CLA-FAQ to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Apr 16, 2017
@chenopis chenopis self-assigned this Apr 17, 2017
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Apr 17, 2017
@chenopis
Copy link
Contributor

@olalonde IMHO, it would be best if it were updated, not just removed. Otherwise, there's not much content on the Tasks landing page, which might be confusing.

@chenopis
Copy link
Contributor

@steveperry-53 Do you want to chime in?

@olalonde
Copy link
Contributor Author

olalonde commented Apr 17, 2017 •
edited

I can't talk for everyone but I personally feel keeping the page empty (or with a clear "Next step" link) is a better UX. Here's what I did:

  1. Scanned intro page and realized it looked just like the nav to the left...
  2. Skipped reading it and navigate to next page in side navigation.
  3. Few minutes later... Read about a term and can't tell whether it was explained previously. Start getting paranoid about having skipped important information.
  4. Remember I skipped intro page.
  5. Go back to read intro page.
  6. Realize it's like the side navigation but slightly different.
  7. Click every links and read them one by one to be sure.

Ok.. it wasn't that dramatic but you get the idea 👍

@techtonik
Copy link
Contributor

Empty page is ok, but speaking of UX side:

  1. I would place the menu on the right side
  2. Place "----> Use the menu on the right to get more details"
  3. "Next" item is a good idea

@techtonik
Copy link
Contributor

Ouch. Missed the critical part - the empty page doesn't explain what "Kubernetes Tasks" really are.

@techtonik
Copy link
Contributor

It looks like the "Tasks" section of documentation is a "Cookbook" with recipes. Not really something embedded in Kubernetes.

@chenopis
Copy link
Contributor

I'll work on rewriting the copy for the explanation of what Tasks are and maybe a high-level description of each grouping in the ToC.

@steveperry-53 steveperry-53 removed their assignment Apr 25, 2017
@steveperry-53
Copy link
Contributor

@chenopis, I'm fine with whatever solution you and @techtonik work out.

@chenopis chenopis merged commit 69c6591 into kubernetes:master May 1, 2017
chenopis added a commit that referenced this pull request May 1, 2017
@chenopis
Address #3433 - update Tasks landing page
2a23b58
chenopis added a commit that referenced this pull request May 1, 2017
@chenopis
Address #3433 - update Tasks landing page
804a24d
chenopis added a commit that referenced this pull request May 1, 2017
@chenopis
Merge pull request #3593 from kubernetes/chenopis-tasks-patch
f127f53 
Address #3433 - update Tasks landing page
@chenopis
Copy link
Contributor

chenopis commented May 1, 2017

@olalonde @techtonik I merged this PR and added some copy in #3593. Let me know if that works for you.

@olalonde
Copy link
Contributor Author

olalonde commented May 1, 2017

@chenopis yes, that's better I think.

chenopis added a commit that referenced this pull request May 2, 2017
@chenopis
Merge branch 'master' of https://github.com/kubernetes/kubernetes.git…
f6d590a 
…hub.io into chenopis-weaveworks-tabs

* 'master' of https://github.com/kubernetes/kubernetes.github.io:
  Fixes broken links
  Removed deleted links regarding minikube CLI
  Add missing volumetype to pv doc (#3600)
  Fix broken link in HA doc with minikube (#3599)
  rolling-update: remove link to the doc itself
  Link to 'why containers' in kubernetes-basics
  Updating Ubuntu based instructions and upgrades
  Address Issue #3577
  Added more explanation for nodeAffinity.
  Update and fix travis tests (short-term)
  Address #3433 - update Tasks landing page
  Remove redundant, out of sync table of contents
chenopis added a commit that referenced this pull request May 2, 2017
@chenopis
Merge branch 'master' of https://github.com/kubernetes/kubernetes.git…
a9cafbc 
…hub.io into chenopis-weaveworks-tabs

* 'master' of https://github.com/kubernetes/kubernetes.github.io: (258 commits)
  Fixes broken links
  Removed deleted links regarding minikube CLI
  Add missing volumetype to pv doc (#3600)
  Fix broken link in HA doc with minikube (#3599)
  rolling-update: remove link to the doc itself
  Link to 'why containers' in kubernetes-basics
  Updating Ubuntu based instructions and upgrades
  Address Issue #3577
  Added more explanation for nodeAffinity.
  Update and fix travis tests (short-term)
  Address #3433 - update Tasks landing page
  Remove redundant, out of sync table of contents
  Update Init Container link
  Update service.md
  Link to appropriate docs for Automatic Mounting of Manually Created Secrets (#3571)
  update kubectl apply doc for required resource name
  jlx426
  Updating Canal URL (#3583)
  Grammar patch to #3572
  Remove swagger-ui from search index
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@chenopis chenopis

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@olalonde @k8s-ci-robot @chenopis @techtonik @steveperry-53