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

Align docs/ui.md with www/README.md #9330

Merged
merged 1 commit into from
Jun 9, 2015
Merged

Conversation

jackgr
Copy link
Contributor

@jackgr jackgr commented Jun 5, 2015

This PR contains changes to docs/ui.md and www/README.md to bring docs/ui.md up to date with #9000, and to align the contents of the two files.

cc @bgrant0607, @bcbroussard, @preillyme

@k8s-bot
Copy link

k8s-bot commented Jun 5, 2015

Can one of the admins verify that this patch is reasonable to test? (reply "ok to test", or if you trust the user, reply "add to whitelist")

If this message is too spammy, please complain to ixdy.


### Running remotely
When Kubernetes is deployed remotely, the api server deploys the UI. To access it, visit `/static/app/` on your master server.
Copy link
Member

Choose a reason for hiding this comment

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

/ui now should redirect to the ui.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Indeed, it does. Nice. Updated the docs accordingly.

@jackgr
Copy link
Contributor Author

jackgr commented Jun 8, 2015

@bcbroussard Not sure which sections of which document your comments address. Can you please clarify?

@bcbroussard
Copy link
Contributor

@jackgr I'm not sure why the code snippets went away, but you can see the comments with code here 97b1866

@jackgr
Copy link
Contributor Author

jackgr commented Jun 8, 2015

@bcbroussard Agree with your point that many people will come here first. However, this document is about working with the UI, not about accessing and using it. We have a document about accessing and using it, which is docs/ui.md.

Moving the section about deploying for production to the top of this document as a way to teach readers how to access the UI would move it out of the parent section about building and deploying the UI, and break the symmetry between development and production in that section.

Rather than try to make this document do double duty, I've added two lines at the top, pointing the reader to docs/ui.md for information on accessing and using the UI. This seems a clean solution, since readers who arrive at docs/ui.md looking for information about working with the UI will likewise find a pointer to this document.

In summary, we have two documents about the UI: docs/ui.md explains how to access and use it, while www/README.md explains how to work with it (i.e., how to configure, build, deploy and update it).

@bcbroussard
Copy link
Contributor

Thanks @jackgr, adding those lines at the top works for me.

What about removing the proxy instructions from docs/ui.md?

@jackgr
Copy link
Contributor Author

jackgr commented Jun 8, 2015

Per my previous comment, the proxy is still a valid way to serve the UI, and people familiar with the old UI will be expecting it. Seems reasonable to keep the proxy instructions, showing how to serve the new UI, and giving them insight, via the pointer to www/README.md, into alternate ways to serve the new UI. In other words, I don't see a good motivation to remove the proxy instructions.

@bgrant0607
Copy link
Member

Good enough for now. LGTM.

@bgrant0607 bgrant0607 added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 8, 2015
@jackgr jackgr force-pushed the ui_build_js branch 2 times, most recently from 589a309 to 7b26857 Compare June 8, 2015 23:54
krousey added a commit that referenced this pull request Jun 9, 2015
Align docs/ui.md with www/README.md
@krousey krousey merged commit df69f2a into kubernetes:master Jun 9, 2015
@jackgr jackgr deleted the ui_build_js branch June 9, 2015 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm "Looks good to me", indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants