-
Notifications
You must be signed in to change notification settings - Fork 38.9k
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
Conversation
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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
@bcbroussard Not sure which sections of which document your comments address. Can you please clarify? |
@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 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 In summary, we have two documents about the UI: |
Thanks @jackgr, adding those lines at the top works for me. What about removing the proxy instructions from |
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. |
Good enough for now. LGTM. |
589a309
to
7b26857
Compare
Align docs/ui.md with www/README.md
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