update readme; improve gui config settings

Author: dwgnr

Cargo.lock

@@ -103,7 +103,7 @@ RUST_LOG=warn cargo cli -- delete teststaff123
 # Add user in LDAP only
 cargo cli --ldap true --slurm false --dirs false add teststaff123 --group staff --firstname Martina --lastname Musterfrau
 
-# Specify key pair for ssh connection
+# Specify key pair for SSH connection
 # Example of listing all users while using key pair at "~/.ssh/some_user.pub" and "~/.ssh/some_user"
 cargo cli list --ssh-path "~/.ssh/some_user"
 
@@ -148,7 +148,7 @@ dpkg -i ../target/debian/*.deb
 
 ## GUI 
 
-We also provide a GUI version of this tool.
+We also provide an experimental GUI version.
 More information can be found under the [GUI README](./usermgmt_gui/README.md).
 
 You can start the GUI version via the following command:
@@ -352,10 +352,9 @@ run_slurm_remote = true
 ssh_port = 22
 # If true, the application will try to authenticate via SSH agent before the simple password authentication
 ssh_agent = false
-# Path to ssh key pair to be used if no ssh agent is used.
+# Path to SSH key pair to be used if no SSH agent is used.
 # Path points to base name of the private and public key. 
-# Example: With path "~/.shh/some_key_pair", there should be private key named "~/.shh/some_key_pair" 
-# and public key "~/.shh/some_key_pair.pub"
+# Example: For private key ~/.ssh/some_key_pair, there should be a corresponding public key "~/.ssh/some_key_pair.pub"
 ssh_key_path = "~/.ssh/some_key_pair"
 ```
 
@@ -382,7 +381,7 @@ usermgmt delete teststaff123
 ### Adding Users
 
 The uid integer value will be automatically determined based on the `--group` parameter provided. 
-Currently you can choose between the two groups *staff* and *student*. 
+Currently, you can choose between the two groups *staff* and *student*. 
 
 The uid for a new user will be determined based on the following rules:
 - Uids for *staff* start with 1000
@@ -416,19 +415,19 @@ This project currently consists of 3 crates:
 
 To preserve the backwards compatibility with earlier versions, this features must be opted in.
 
-Setup the use of creation dates in LDAP via:
+Set up the use of creation dates in LDAP via:
 
 1. Set the field value `ldap_add_created_at` to `true` in `conf.toml`.
 2. Add the value `createdAtRole` to `objectclass_common` in `conf.toml`.
 
 ### Use SSH agent for authentication 
 
-To save yourself entering passwords for SSH authentication again and again, 
+To save yourself from entering passwords for SSH authentication over and over again, 
 you can let the application use a running SSH agent. 
 
 Activate this feature via setting the field `ssh_agent` to `true` in `conf.toml`.
 
-Start your SSH agent in the terminal via the command (often started automatically):
+Start your SSH agent in the terminal via the command (often started automatically during system boot):
 
 ```sh
 ssh-agent
@@ -447,7 +446,7 @@ and does not ask for a password.
 If more than one key is registered within the agent,
 you will be prompted to select the key you want to use.
 
-**Additional steps on macOS:**
+**Additional optional steps on macOS:**
 
 Ensure macOS remembers the key (optional, via Keychain): 
 
@@ -466,7 +465,6 @@ Host *
 This integrates with the macOS keychain and ensures the key is added automatically. 
 
 
-
 ### Show more logs
 
 The log-level can be changed using the `RUST_LOG` environment variable. 
@@ -480,24 +478,16 @@ You'll receive the most verbose output when you set it to *debug*.
 RUST_LOG=debug usermgmt delete teststaff123
 ```
 
-The application also tries to write logs to logging file. 
-The application writes to a logs file within the data folder of the application according to the convention of the used OS.
-If this is not possible, it tries to log within the same folder of the executable of this application.
-If that fails too, the application only writes to the terminal via stderr.
-See the [docs](https://docs.rs/dirs/latest/dirs/fn.data_dir.html) of this rust crate for details about this convention.
+The application also tries to write logs to a log file. 
+Logs are written in the data folder of the application according to the convention of the used OS.
+If this is not possible, it tries to log to the location of the executable.
+If this also fails, the application only writes to the terminal via stderr.
+See the [docs of this crate](https://docs.rs/dirs/latest/dirs/fn.data_dir.html) for details.
 
 ### Show stack trace in case of error
 
-Many of the errors, reported by the application, can also shown with their stack trace.
-The stack trace is quite useful for locating the place in the code where the error was caused.
-This is especially handy for debugging.
-By default the stack trace in Rust is disabled though.
-You need to set the environmental variable named "RUST_BACKTRACE" to 1.
-This can be accomplished via this command in the terminal.
-
-```bash 
-export RUST_BACKTRACE=1
-```
+Errors reported by the application, can be displayed including their stack trace.
+Since the stack trace is disabled by default, you need to set the environment variable `RUST_BACKTRACE=1`.
 
 ## Pitfalls 
 

README.md

@@ -1,39 +1,31 @@
-# Readme
+# Usermgmt GUI
 
-This crate is an application which allows simultaneous user management for LDAP and Slurm 
-via GUI.
-
-This application utilizes [egui](https://github.com/emilk/egui) as the GUI framework.
+This application utilizes [egui](https://github.com/emilk/egui).
 
 ## License
 
-The whole project is licensed under [MIT](./LICENSE)
+The project is licensed under [MIT](./LICENSE)
 
 ## Development
 
-You can run this application by running the following command 
+You can run the GUI with: 
 
 ```bash
 cargo gui
 ```
 
-## GUI settings
-
-Options which determine the look of the GUI are determined by values contained 
-within certain configuration files under assets.
+## GUI Settings
 
-There are two files 
+The GUI layout can be configured with the following two files:
 
 - [Init file](./assets/Init.toml): Only loaded at the start of the application.
-- [Settings file](./assets/Settings.toml): Loaded at the start of the application. 
-During development, this file is also loaded whenever its content changes. This hot reload feature
-while developing allows to see the changes in the GUI immediately. 
+- [Settings file](./assets/Settings.toml): Loaded at the start of the application.  
+  - During development, this file is loaded whenever its content changes. 
 
-Note: In release the reload feature of the [Settings file](./assets/Settings.toml) is not active.
-This program includes both files into the resulting binary at compile time.
-So user of the application do not need to worry about having theses files on their system.
+**Note:** In release mode the reload feature of the [Settings file](./assets/Settings.toml) is not active.
+This program includes both files into the resulting binary at compile time. 
 
-## Additional information
+## Additional Information
 
 The [GENERAL_README](./GENERAL_README.md) describes the other crates and the general structure
-of the whole project.
+of the project.

usermgmt_gui/README.md

@@ -1,4 +1,4 @@
-# This file contains all settings which are set at the start of the GUI application 
+# This file contains all settings that are set at the start of the GUI application
 # and reloaded if content changes during development.
 
 box_label_font_size = 28.0
@@ -10,23 +10,23 @@ tooltip_size = 20.0
 tooltip_symbol = "?"
 
 [tooltiptexts]
-ldap_creds = "Credentials for logging in to manage of LDAP users"
-ldap_readonly_creds = "Credentials for logging in to perform readonly operation on LDAP users"
-ssh_creds = "Credentials for logging in to manage SLURM users"
-list_ldap_btn = "List users saved within LDAP database"
-list_ssh_btn = "List users saved within Slurm database"
-username = "Name which is used as the identifier to determine a specific user in the LDAP/Slurm database. Note: This must be unique among all users"
-firstname = "Firstname of an user"
-lastname = "Lastname of an user"
-email = "Email which is to be used to contact an user"
-pub_key = "Public ssh key which needs to be saved to LDPA database so an user can log into the cluster"
-group = "Name of group which an user belongs to"
-default_qos = "Default quility of service of an user"
-qos = "All the quilities of services under which an user can run a job"
-conf_student_qos = "Which quality of services are applied for a student by default"
+ldap_creds = "LDAP credentials"
+ldap_readonly_creds = "LDAP readonly credentials"
+ssh_creds = "SSH credentials"
+list_ldap_btn = "List users stored in LDAP database"
+list_ssh_btn = "List users stored in Slurm database"
+username = "Name used as the identifier to determine a specific user in the LDAP/Slurm database. Note: This must be unique among all users"
+firstname = "Firstname of a user"
+lastname = "Lastname of a user"
+email = "Email address of the user"
+pub_key = "SSH public key that is to be stored in LDAP"
+group = "Name of group the user belongs to"
+default_qos = "Default quality of service (QoS) of a user"
+qos = "All QoS the user can use to run jobs"
+conf_student_qos = "Default QoS for students"
 conf_student_default_qos = "Which default Quality of service are used for a student"
 conf_run_slurm_remote = "Run slurm command on remote nodes instead on your own local computer."
-conf_ssh_port = "Port used for ssh connection"
+conf_ssh_port = "Port used for SSH connection"
 conf_staff_default_qos = "Default value of the Slurm default QOS for the staff group"
 conf_default_ssh_user = "Default user for SSH login during directory management"
 conf_head_node = """Slurm head node (where sacctmgr is installed, remote or locally on the machine).
@@ -113,7 +113,7 @@ dir_conf_path = "Path to directory with the file called conf.toml"
 general_status = "Status"
 required = "Required"
 optional = "Optional"
-readonly_ldap_cred = "Ldap readonly credentials"
+readonly_ldap_cred = "LDAP readonly credentials"
 status_list_slurm = "Status of listing Slurm users"
 status_list_ldap = "Status of listing LDAP users"
 username = "Username"