Skip to content

New documentation page for ui#1509

Merged
thjaeckle merged 6 commits into
eclipse-ditto:masterfrom
thfries:documentation-ui
Oct 12, 2022
Merged

New documentation page for ui#1509
thjaeckle merged 6 commits into
eclipse-ditto:masterfrom
thfries:documentation-ui

Conversation

@thfries
Copy link
Copy Markdown
Contributor

@thfries thfries commented Oct 9, 2022

Hi there,

Please find this PR to address #1496
After having some hard time to set up the documentation pages 😉, I started a new page for the ui.

@thjaeckle: Not sure, how to exactly use the docker image. Can you please add a remark where the UI can be reached?

Let me know, if the place in the structure fits as proposed.
This is just a first draft, that needs to be refined I think.

Kind regards, Thomas

Signed-off-by: thfries <thomas.fries0@gmail.com>
Signed-off-by: thfries <thomas.fries0@gmail.com>
Copy link
Copy Markdown
Member

@thjaeckle thjaeckle left a comment

Choose a reason for hiding this comment

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

Thanks @thfries for providing the documentation.

I added some inline feedback .. and added how to start the Docker container.
There I noticed that for the Ditto 3.0.0 release the "latest" tag was not uploaded to Docker-Hub and I fixed that :)

Comment thread documentation/src/main/resources/_data/sidebars/ditto_sidebar.yml
Comment thread documentation/src/main/resources/pages/ditto/user-interface.md Outdated
Comment thread documentation/src/main/resources/pages/ditto/user-interface.md Outdated
Comment thread documentation/src/main/resources/pages/ditto/user-interface.md Outdated
Comment thread documentation/src/main/resources/pages/ditto/user-interface.md Outdated
@thjaeckle thjaeckle added documentation UI Issues related to the Ditto explorer UI labels Oct 11, 2022
thfries and others added 4 commits October 12, 2022 06:55
Co-authored-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
Co-authored-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
Co-authored-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
- remove trade mark
- change order in sidebar
- make links to online sandbox work

Signed-off-by: thfries <thomas.fries0@gmail.com>
@thfries
Copy link
Copy Markdown
Contributor Author

thfries commented Oct 12, 2022

Hi @thjaeckle,
thanks for the feedback. I processed all remarks. Links with the pre-selected sandbox also work 😀

Open points from my view:

  • Shall we review other pages if referring to the ui would make sense?
  • Some general quick-start guide on the UI?

But other than that I m ok to start with this page as is. wdyt?

Copy link
Copy Markdown
Member

@thjaeckle thjaeckle left a comment

Choose a reason for hiding this comment

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

Hi @thjaeckle, thanks for the feedback. I processed all remarks. Links with the pre-selected sandbox also work 😀

Open points from my view:

  • Shall we review other pages if referring to the ui would make sense?
  • Some general quick-start guide on the UI?

But other than that I m ok to start with this page as is. wdyt?

I don't think that adding cross-references to the UI documentation page from many other pages does bring much benefit.
I guess someone searching for a UI will find the new documentation page.

A Quick-Start guide would be good, yes.
But I would also see that as an add-on to the added documentation.

FMPOV good to merge 👍
Thanks 🎉

@thfries thfries marked this pull request as ready for review October 12, 2022 16:30
@thjaeckle thjaeckle merged commit 3d84b18 into eclipse-ditto:master Oct 12, 2022
@thfries thfries deleted the documentation-ui branch February 26, 2023 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation UI Issues related to the Ditto explorer UI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants