docs: add and enhance documentation for gui, setup and usage (#34)

This commit is contained in:
Stephan Lüscher 2024-05-10 22:04:43 +02:00 committed by GitHub
parent 4f2130bcce
commit 4df5d1667e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 225 additions and 79 deletions

36
docs/gui.md Normal file
View file

@ -0,0 +1,36 @@
# Usage with GUI
We have simple UI available at <https://forge.ublue.local>.
## Navigation
For navigation you can use the navigation bar on the top left.
![navigation](./assets/gui_navigation.png)
### Home
Currently nothing to see here. The goal is to display some
general information here. Links to documentation and important
news etc.
### Ansible
Here you can load your forge [configuration](./index.md#configuration) file from the data store,
clone projects and build container images. The buttons should be self explanatory.
The "Deploy VM" button is currently a mock-up, sorry :wink:
we are [working](https://github.com/ublue-os/forge/issues/35) on it.
![ansible](./assets/gui_ansible.png)
### Registry
Currently nothing to see here. The goal is to display some
information about the docker registry <registry.ublue.local> here.
Like a list of all available images you have uploaded etc.
### About
Currently nothing to see here. The goal is to display some
information here about the software and versions used in this project
and maybe some acknowledgments etc.