WIP: Testing out an initial MD pattern for reference docs #1130
Conversation
|
|
||
| `Usage: eksctl [command] [flags]` | ||
|
|
||
| ##### common flags<a name="common-flags"></a> |
There was a problem hiding this comment.
I would not use h4 or h5 since they are small enough to look confusing in the context of our base font size.
There was a problem hiding this comment.
OK - let's connect Monday morning and figure out how to amend the tags. I want it to look good as rendered, but it should remain a structured doc like an outline format somehow.
|
Nice one! The syntax highlighting is behaving strangely here. We could also go for line-by-line code snippets? |
|
@bia Please take a look at We can substitute pre-formatted blocks with something else if that works better. The example for the top-level in the |
| - [h, help](02-flags.md#help) | ||
| - [v, verbose](02-flags.md#verbose) | ||
|
|
||
| ### completion <a name="completion"></a> |
There was a problem hiding this comment.
This is very linux centric. Do we really need to document this behaviour here?
There was a problem hiding this comment.
I think Linux users would appreciate some documentation, yes. 😄
It's also supposed to cover MacOS usage, but I think it might be inaccurate. 😐
Reference documentation is supposed to be comprehensive, so if the code supports a feature you'll want to document that feature - no matter how trivial it may seem. If it supports tab completion for a Unix/Linux shell, it should really be documented.
This is literally cut-and-paste from the help screens, so it was easy to include. I don't know why you wouldn't.
|
|
||
| Without an invoking a sub-command, the completion command simply prints the help screen. | ||
|
|
||
| #### bash <a name="completion-bash"></a> |
There was a problem hiding this comment.
bash users are people too!!! 😄
zsh is an even more obscure shell, but someone liked it enough to write completion support for it, so who am I to judge?
|
|
||
| Creates a mapping from IAM role to Kubernetes user and groups. | ||
|
|
||
| *Note:* aws-iam-authenticator only considers the last entry for any given |
|
@sbernheim are you planning to continue working on this? |
|
@sbernheim given that it seems we can't put much time on this right now I will close this but please feel free to reopen it if you have time again! |
Submitting as a WIP PR for feedback and possible testing against the docs site build pipeline tooling.
DO NOT MERGE THIS PR!