-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
Clarify dashboard documentation / help #276
Comments
Forgot to mention: this issue relates to #145 |
This looks awesome proposal Gerti! Give me and others some time to review and think about it. |
LGTM |
I'd go for the alternative, i.e., write in markdown and generate HTML for this. The reason is that markdown is really good for writing pages of text, as opposed to HTML, which burdens you about tags/styles/etc. What do you think? |
Correct. I say that this is OKay. In 1.2 or 1.3 things may change, and we want to reference the world we know. We can do quick upgrade of all links with find&replace or storing in a common constant. |
Correct. The designs here are a little bit too distant in the future :) |
For now the input will be in "More options". We don't have an easy way to test whether a repo is private or not. |
What do you think about changing our wording from "Replica Set" to "Replication Controller". The name change was supposed to happen soon in K8s core, but it is not. So, to me, it is better to use what is officially supported. @cheld @floreks |
Links you've provided LGTM. Let's resolve outstanding questions and implement it. This is a really high quality writeup. Huge thanks! |
I was thinking about that since the beginning of project. We should stick with k8s core naming convention. |
I agree that new doc should be written in markdown (also for consistency reasons with K8S documentation). Do you know the mechanism for generating HTML out of the markdowns? And can this just be taken over from the kubernetes project? |
K8s core has some custom code for handling markdown. We can potentially reuse it. See source: https://github.com/kubernetes/kubernetes/tree/4ca66d2aefa20c27b670b2fa890052daadc05294/cmd/mungedocs |
Good. |
@gertipoppel Me (or somebody from the team) can research standard markdown processors that are out there. I expect that there are lots of them. |
This would be great! Thank you! |
@bryk I would like to rename replica set into replication controller. Should this be "rc" then, or "replicationcontroller" / ReplicationController? I vote for rc / RC. |
Hmm... This is getting more complicated. Take a look at the issue: kubernetes/kubernetes#3024 Current status is that there are both, Replication Controller and Replica Sets. Ideally, I think that we should display both on our list page, because their difference is very slight. |
However I do feel that we need to do the renaming. As for the name, I'd go for full names everywhere, i.e., |
If I understand the discussion in kubernetes/kubernetes#3024 correctly, Replication Controller was renamed to ReplicaSet.
So, maybe we should postpone the renaming ;-)
I am not sure whether I understand the difference between a Replication Controller and ReplicaSet. I agree to using long names throughout the project, just thought of the rc usage of kubectl. |
By reading the bug I believe that this is no longer renaming. This is having two objects for some time and then deprecating one. This means that Replica Sets and Replication Controllers will be there for some amount of time and our UI shows Controllers, not Sets. Hence, I think we should rename. What do you? |
OK. I understand. Then I will rename replica sets to replication controllers. |
@gertipoppel Is this done? |
@bryk This is almost done. What is still missing:
|
I agree with everything you said :) Are you working on this? |
Awesome, thank you @gertipoppel :) |
I have update/extended the dashboard tour and just created a PR (kubernetes/kubernetes#22276)
|
@gertipoppel I think both mentioned issues are fixed now. Could you confirm? |
@maciaszczykm Yes, this issue can be closed. Thank's a lot. |
Documentation for the Kubernetes dashboard - Proposal
This is a proposal of how the K8S dashboard could be documented, which information should be provided, and how it should be presented to users of the dashboard. The proposal is based on the UI design (mockups).
Current situation
Proposed extensions
To be discussed
If references to the existing K8S documentation are not sufficient, how can we provide newly created content?
Proposal: Write HTML pages and include references to K8S documentation in the new HTML pages. Is it OK to simply use the Kubernetes style sheet for the new HTML pages?
Alternative: Write markdown pages in a structure in analogy to the K8S project, and implement the generation of HTML pages in anology with the K8S documentation generation process also in the dashboard project.
Links to the K8S documentation contain specific version information. I.e. if a specific topic of the K8S documentation shall be referenced, it is not possible to omit the version information. Currently, this is V1.1. If it is omitted in the link, the user is redirected to the K8S main documentation page.
Do we need to describe how to "containerize" an application? If yes, here are some links with reference information:
Proposal for [Learn more] links
Zero State page
Deploy from settings page
Upload page
Replication controller list page
Currently, no cards are implemented containing a [Learn more] link. By design, at least the following should be implemented:
The text was updated successfully, but these errors were encountered: