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

Update docs to match the new Brooklyn UI #263

Merged
merged 3 commits into from
Jul 27, 2018

Conversation

tbouron
Copy link
Member

@tbouron tbouron commented Jul 26, 2018

This is the required changes to match the newly donated Brooklyn UI (see https://lists.apache.org/thread.html/20d82876f7e84244c2c4d3464a1531a10af50ca3d20e9e1de97a5faf@%3Cdev.brooklyn.apache.org%3E)

It updated the relevant portions of text as well as all the screenshot.

Note that another PR is required for the website part: #264

@ahgittin
Copy link
Contributor

Fabulously thorough job.

I think guide/ops/troubleshooting/web-console-issues.md is still relevant, so we shouldn't delete that page, should we? (Also, if we do delete it, shouldn't there be a reference to that page which is deleted -- I didn't see that, and note guide/SUMMARY.md still refers to it.)

There is also a reference to BrooklynJavascriptGuiLauncher on ./dev/env/ide/index.md. As per comment apache/brooklyn-server#974 (comment) this is no longer supported and we should identify the best way in each IDE to run with the UI.

However that can be deferred, and the docs at this stage in this section could simply link to a REST CLI launcher class and note that we would welcome suggestions on the best way to run with osgi and the UI from within IDEs. Or if you know how to do OSGi+UI launches, add those notes, but do keep the instructions that Brooklyn+REST can be launched non-OSGi, maybe noting that some features around bundle management will be unavailable.

@tbouron
Copy link
Member Author

tbouron commented Jul 26, 2018

Fabulously thorough job.

Thanks!

I think guide/ops/troubleshooting/web-console-issues.md is still relevant, so we shouldn't delete that page, should we? (Also, if we do delete it, shouldn't there be a reference to that page which is deleted -- I didn't see that, and note guide/SUMMARY.md still refers to it.)

Well, we never saw this issue with the new UI hence why I deleted the page. I don't think this is relevant anymore. But thanks for the nudge about SUMMARY.md, I forgot to check the references, will remove.

There is also a reference to BrooklynJavascriptGuiLauncher on ./dev/env/ide/index.md. As per comment apache/brooklyn-server#974 (comment) this is no longer supported and we should identify the best way in each IDE to run with the UI.

Didn't remove the reference as I don't think it should be part of this set of PRs (commented this on the relevant PR) But yeah, this can be updated in a following PR.

@tbouron
Copy link
Member Author

tbouron commented Jul 26, 2018

@ahgittin Added back the web console issues page + updated the IDE setup

@asfgit asfgit merged commit 9027a16 into apache:master Jul 27, 2018
asfgit pushed a commit that referenced this pull request Jul 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants