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.

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

Overall cleanup for kubeadm setup guide. #8981

Merged
merged 7 commits into from Jun 13, 2018
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 1 addition & 6 deletions OWNERS_ALIASES
Expand Up @@ -62,15 +62,10 @@ aliases:
- soltysh
- sttts
sig-cluster-lifecycle: #GH: sig-cluster-lifecycle-pr-reviews
- jbeda
- timothysc
- lukemarsden
- pipejakob
- dmmcquay
- mattmoyer
- luxas
- roberthbailey
- medinatiger
- bradamant3
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine to remove a reviewer, but please don't add me. We use this list to specify tech reviewers, and I don't think I should be in that list ;)

sig-cluster-ops:
- zehicle
- jdumars
Expand Down
241 changes: 69 additions & 172 deletions content/en/docs/setup/independent/create-cluster-kubeadm.md

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions content/en/docs/tasks/administer-cluster/kubeadm/_index.md
@@ -0,0 +1,5 @@
---
title: "Kubeadm"
weight: 10
---

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see what you're doing here, and with moving (or removing, for which thank you!) the upgrade-downgrade files. But it looks to me like too much nesting to be useful. The "Kubeadm" subsection hides the fact that its children are about upgrading/downgrading until you expand it. Are you planning to move more kubeadm files into the Kubadm subsection? If so, it might be OK. But I'm still thinking this isn't the greatest UX. How many users are likely to think "upgrade/downgrade" if they see Kubeadm in the TOC? (Yeah, most of them are unlikely to get there by navigating the TOC also. But that's not a good argument for rearranging, either ;) )

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes there will be more content, this was chosen for both clarity and mgmt.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also think it's a pretty deep TOC structure and I'm not sure this will help with discoverability.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zacharysarah - This is the single point in question. I don't have that strong of an opinion on the matter other then grouping admin content associated with kubeadm is cleaner. I could happily remove the substructure below this one if that works for others too.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@timothysc I'm fine with deepening the TOC to a third tier. Right now, the second tier (Tasks > Administer a Cluster) is both densely populated and unhelpfully organized.

In fairness to my colleagues, I'm not sure that a deeper TOC is the best solution, either--but it beats what we've got right now. I'd rather iterate successively than remain paralyzed.

I'd like to see a different name for the proposed section, though. To build on @Bradamant3's suggestion, "Administration with kubeadm" as a section title works better than just "Kubeadm" (line 2).

This file was deleted.

This file was deleted.