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

Add documentation for the web UI #44

Closed
rezib opened this issue Dec 15, 2023 · 2 comments · Fixed by #81
Closed

Add documentation for the web UI #44

rezib opened this issue Dec 15, 2023 · 2 comments · Fixed by #81
Assignees
Labels
documentation Improvements or additions to documentation UI
Milestone

Comments

@rezib
Copy link
Contributor

rezib commented Dec 15, 2023

The documentation should be updated for the web UI:

  • The feature should be mentioned in getting started and overview pages with some nice screenshots
  • A new dedicated page should explain:
    • How to install and launch the UI application
    • Explain briefly to end users how to navigate in the pages with features available (search, filters, etc)
@rezib rezib added documentation Improvements or additions to documentation UI labels Dec 15, 2023
@rezib rezib added this to the v0.4.0 milestone Mar 8, 2024
@florianLSP
Copy link
Contributor

  • In Quickstart:
    • In the section installation From Sources:
      • Add paragraph to explain how to install Web-UI
    • In Explore content:
      • Add a new section Web-UI under REST-API to explain that UI is included in racksdb-web when you run the command racksdb-web --with-ui
      • Add ‘more links’ section with the like of the page Web-UI
  • In Getting Started:
    • Display an image with 3 screenshots of the UI
  • In Overview:
    • In Interfaces:
      • Add to the schema ‘Web-ui’
      • Add a text to explain that it’s now possible to use the UI
      • Add a link to the page ‘Web-UI’
      • Display an image with 3 screenshots of the UI
  • Create Web-UI page that list all the features of the UI:
  • In README:
    • Remove beta mention
    • Display an image with 3 screenshots of the UI
    • Edit the link to direct it to the UI doc
  • In CLI manpages racksdb-web:
    • Add the possibility to access to the Web-UI by running the command racksdb-web --with-ui

@rezib
Copy link
Contributor Author

rezib commented Mar 28, 2024

* In **CLI manpages racksdb-web**:
  
  * Add the possibility to access to the Web-UI by running the command `racksdb-web --with-ui`

Note that it's already done in 53f1cba.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation UI
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants