Documenting pg 03 and fixing typos on 01 and 02

Author: MariaJCU

src/en/01_introduction.md

@@ -23,7 +23,9 @@ PgManage’s interface allows to quickly switch between database sessions throug
  - Mac OSX
 
 > **Note:** PgManage currently only supports x86_64 architecture. ARM64 support may be added in the future.
+
 > **Note:** Only Windows 10 and higher versions are supported
+
 ## Credits
 
 - [OmniDB](https://github.com/OmniDB/OmniDB)

src/en/02_quick_start.md

@@ -8,8 +8,7 @@ Download the PgManage distribution file for your platform from the [Command Prom
 
 ### Linux
 
-PgManage for Linux is packaged in `.AppImage` format and does not require installation.
-Download PgManage .AppImage file, in the command line change to the directory containing the downloaded file, make it executable, and run it:
+PgManage for Linux is packaged in `.AppImage` format and does not require installation. Download PgManage's `.AppImage` file. Then, in the command line, change to the directory containing the downloaded file, make it executable, and run it:
 
 ```
 chmod +x ./pgmanage-$version.AppImage
@@ -18,28 +17,91 @@ chmod +x ./pgmanage-$version.AppImage
 
 ### Windows
 
-Run the PgManage setup executable and follow the installation instructions.
+- Run the PgManage setup executable and follow the installation instructions.
+- To install PostgreSQL client utilities, follow the steps in the [Installing Client Utilities on Windows](#installing-client-utilities-on-windows) section.
 
 ### Mac
 
 Download the `DMG` file and double click on it and drag the PgManage icon to the `Applications Folder` icon.
 
-### Oracle Support
+**FIXME:** add PostgreSQL command line tools installation instructions
 
-A note about extra dependencies for Oracle support.
+---
+
+### PostgreSQL Client
+
+When PgManage starts, it will try to automatically find PostgreSQL's client executable files for the `pg_dump`, `pg_restore`, `pg_dumpall`, and `psql` commands. For cases in which this autodiscovery does not work or is not desired, a path to the binaries may be specified on the application’s `Utilities Menu → Settings`.
+
+![Image of the settings dialog](./images/pgmanage-settings.png)
+
+To check that the binaries were found, you may click the `validate` button which will display the installed PostgreSQL’s version.
+
+![Image of the confirmation message](./images/pgmanage-validate.png)
+
+> **Note:** The autodiscovery of client binaries is not available on Windows. The only way to use the backup and restore features is to manually install the PostgreSQL client utilities.
+
+#### Installing Client Utilities on Windows
+
+- You may download a Windows’ PostgreSQL installer from  [enterprisedb.com](https://www.enterprisedb.com/downloads/postgres-postgresql-downloads).
+- Take note of the installation path where the components will be installed.
+
+![Image of the PostgreSQL installer asking for an installation path](./images/edb_windows_psql_installer1.png)
+
+- The installer will ask what components to install. Only install the `command line tools`.
+
+![Image of the PostgreSQL installer asking what components to install](./images/edb_windows_psql_installer2.png)
+
+- Finally, add the path to the binaries in the PgManage’s `Utilities Menu → Settings`. Notice that the binary files are inside the `bin` folder.
+
+![Image of the settings dialog](./images/pgmanage_windows_binaries_validation.png)
+
+#### Installing Client Utilities on Linux:
+
+Setting up paths to PostgreSQL client binaries is not necessary for Linux systems because these will be automatically discovered in the $PATH environment variable. Still, there are some cases in which the path autodiscovery may fail:
+
+- if multiple versions of the PostgreSQL client binaries are installed
+
+- if the PostgreSQL client binaries are installed in a location not included in the $PATH environment variable
 
-### Postgresql Client
-While being self-contained application for the majority of features, pgmanage relies on postgresql command line tools to perform database backup and restore operations.
+Once you have installed your preferred PostgreSQL’s version, add the path of the binaries in `Utilities Menu → Settings`.
 
-TODO: add installation guide for various linux distros, windows and osx\
-TODO: add note about extra dependencies for Oracle support.
+> **Note:** You may install PostgreSQL for your particular Linux distribution on [postgresql.org](https://www.postgresql.org/download/linux/).
 
+#### Installing Client Utilities on Mac
+
+To install the client binaries in MacOS, there are two options: to install the complete Postgres packages or to only  install libpq and then update the PATH.
+
+To install the complete Postgres’s packages run the following command:
+
+```
+	brew install postgresql@[Major version]
+```
+
+To install only the binaries and update the PATH variable, run the following commands:
+
+```
+	brew install libpq
+	echo 'export PATH="/usr/local/opt/libpq/bin:$PATH"' >> ~/.zshrc	
+```
+
+Once you have installed your preferred Postgres version, add the path to the binaries in `Utilities Menu → Settings`.
+
+> **Note:** For more information on how to install Postgres on Mac, refer to [Postgres' documentation](https://www.postgresql.org/download/macosx/).
+
+---
+
+### Oracle Support
+
+A note about extra dependencies for Oracle support.
+
+---
 
 ## Launching the App
 
 When the application starts for the first time, it will prompt a message to set up a master password. Fill up the provided fields and press `Set master password`.
+This password will be requested the next time you open the application but you may reset it with a `Reset Master Password` button. 
 
-This password will be requested the next time you open the application but you may reset it with a “Reset Master Password” button.
+>**Note:** resetting the master password will erase all the information that was encrypted with it, including database connection credentials.
 
 ![Setting up the master password](./images/master_pass.png)
 
@@ -64,22 +126,21 @@ PgManage stores sensitive data, such as database access credentials and SSH keys
 ---
 
 ## Creating your first DB connection
+
 Click on the ⚡ icon on the left sidebar, the connection management UI will be shown:
-![Connection Management](./images/connection_mgr.png)
+  
+![Connection Management](./images/connection_mgr.png)  
 
-Connections and Connection Groups are shown on the left, clicking on the left panel items shows the item's view/edit form.
+Connections and Connection Groups are shown on the left. Clicking on the left panel items shows the item’s view/edit form. Click on `➕ Add → Connection`. Set the connection title and database type; the rest of the form will change depending on the database type selected. Fill in the rest of the database connection properties.
 
-Click the `➕ Add` button, select Connection
-Set connection title and database type, the rest of the form will change depending on the database type selected.
-Fill in the rest of database connection properties.
-**Note:** Alternatively the connection string may be used to establish a database connection.
+> **Note:** Alternatively, the connection string may be used to establish a database connection.
 
 There are two special connection types, which behave differently:
 
 - **SQLite connections** do not need any other settings besides the sqlite3 file path.
 - **Terminal connections** are shell/console sessions with a remote host. These require setting SSH properties.
 
-> **Note:** the password field is optional. If you leave it empty, the password prompt will be shown each time before establishing the connection. For PostgreSQL connections, PgManage will also try to retrieve the connection password from the `.pgpass` file, unless the connection properties are provided in connection string form.
+> **Note:** the password field is optional. If you leave it empty, the password prompt will be shown each time before establishing the connection. For PostgreSQL connections, PgManage will also try to retrieve the connection password from the `.pgpass` file.
 
 ### SSH Tunnelling
 

src/en/03_user_guide.md

@@ -16,17 +16,38 @@ The **context menus** can be accessed by right-clicking on one of the tree nodes
 
 The actions available depend on the selected database object. Here is a list of command actions on alphabetical order:
 
-- **Alter/edit:** opens a query tab with a template to change the given object.
-**TODO**: replace the above with a description of the new Table Editor functionality, same applies to "Create Table". The editor is available via Tables node->right click->Create Table OR by right clicking on the table node->table actions->alter table
+- **Alter/edit:** opens a new tab with an interface to alter the given object. For example, a table may be altered by right-clicking on the table object and selecting `Table Actions → Alter Table`. From there, you may do the following:
+    - Change a field by double-clicking
+    - Add a column with the `Add Column` button
+    - Remove a column with the `❌ icon` at the end of each row
+    - Check the generated query under the `Generated SQL`
+    - Execute the generated query with the `Apply Changes` button.
+
+![Alter table interface](./images/alter_table.png)
 
 - **Analyze Table:** opens a query tab with a template for the [ANALYZE](https://www.postgresql.org/docs/current/sql-analyze.html) action.
-- **Create:** opens a query tab with a template to create the given object.
+- **Create:** opens a new tab with an interface to create the given object. For example, a table may be created by right-clicking on the `Tables` object and selecting `Create Table`. From here you may do the following:
+    - change the table name
+    - change the assigned schema
+    - edit the columns by double-clicking on the fields
+    - add a column with the `Add Column` button
+    - remove a column with the `❌ icon` at the end of each line.
+    - move a given column up or down with the arrows at the end of each line
+    - check the generated query under the `Generated SQL` field.
+    - execute the generated query with the `Apply Changes` button.
+
+![Create table interface](./images/create_table.png)
+
 - **Drop/Delete:** deletes the selected object from the server.
 - **Monitoring:** the dashboard or the backends may be selected to be opened on a new tab.
 - **Refresh:** refreshes the selected object.
 - **Reindex:** opens a query tab with a template for the [REINDEX](https://www.postgresql.org/docs/current/sql-reindex.html) action.
-- **Render Graph:** creates the graph of tables inside the database. It can generate a simple graph or a complete graph.
-**TODO**: ^^^ this feature was replaced with ER Diagram menu item.
+- **Render Graph:** opens a tab with an Entity Relationship diagram. This feature is available by right-clicking one of the schema objects and selecting `ER Diagram`. From there, you may:
+    - move the tables by clicking and dragging
+    - click on the name of a foreign key to highlight the table's relation with another.
+
+![Entity Relationship diagram with a hilighted foreighn key](./images/erd.png)
+
 - **Server Configuration:** opens the Server Configuration settings tab.
 - **Truncate Table:** opens a query tab with a template for the [TRUNCATE](https://www.postgresql.org/docs/current/sql-truncate.html) action.
 - **Update Records:** opens a query tab with a template for the [UPDATE](https://www.postgresql.org/docs/current/sql-update.html) action.
@@ -148,28 +169,50 @@ One may return to a previous configuration snapshot by selecting the snapshot fr
 
 ## PostgreSQL Extension Management
 
-PostgreSQL Extensions can be managed via dedicated dialog accessible by right clicking Extensions node and its subnodes in the DB Object Tree
-**TODO**: Add detailed documentation and screenshot
+PostgreSQL Extensions can be managed via the dedicated dialog accessible by right-clicking the `Extensions` node and its subnodes in the DB Object Tree.
+
+When the `Extensions` node is right-clicked, the following menu will be displayed:
+
+![Extensions node with menu](./images/extensions0.png)
+
+By clicking `Create Extension UI` a menu will open with a user interface, allowing to enter the extension name, a comment, a schema, and a version. A preview of the created query will be displayed under "Preview":
+
+![Create Extension menu](./images/create_extension.png)
+
+Right-clicking on a given extension will display a menu with the following options:
+
+- **Alter Extension UI:** The `Alter Extension UI` option will open a user interface to create an `ALTER EXTENSION` query. This displays the following fields: the name of the extension, a comment, the schema, the version, and the query's preview.
+
+![Alter Extension menu](./images/alter_extension.png)
+
+- **Alter Extension:** Displays a template on a new tap with an `ALTER EXTENSION` query.
+
+- **Edit Comment:** Displays a template on a new tap with a `COMMENT ON EXTENSION` query.
+
+- **Drop Extension UI:** The `Drop Extension UI` will open a prompt confirming if the given extension should be dropped. Cascading can be enabled if desired.
+
+![Drop Extension menu](./images/drop_extension.png)
+
+- **Drop Extension:** Displays a template on a new tap with a `DROP EXTENSION` query.
 
 ---
 
 ## Data Editor Grid
-**TODO**: document the new Data Editor tab here, remove old data editor instructions below.
 
 The data editor grid allows editing data of a specified query in a visual format. This feature can be accessed by right-clicking on a table in the DB entity tree.
 
 ![Image illustrating how to access the data editor grid](./images/edit_data_light.png)
 
-Then, a new tab will be created with a default query of `select * from mytable t`. A text editor allows to add further conditions to the query.
+Then, a new tab will be created with the data editor. By default, the first 10 rows of the `SELECT * from [table] ORDER BY t.id` query will be displayed. A text field allows to change the query's conditions.
 
-![Image showing the data grid tab](./images/edit_data_light1.png)
+![Image showing the data grid tab](./images/data_editor0.png)
 
 The data editor grid allows the following changes:
-- **Delete a row:** Click on the `❌ icon` and the selected rows will become red.
-- **Edit cells:** Double click on a data cell to edit the grid. Or, `right-click → Edit Content` to open a separate editor.
-- **Displayed rows:** Click on the `Query Rows` dropdown-menu and select the number of desired rows.
+- **Delete a row:** Click on the `❌ icon` next to a row and it will become red. You may deselect the row with the going back icon next to the row.
+- **Edit cells:** Double-click on a data cell to edit the grid.
+- **Displayed rows:** Click on the `Limit` dropdown menu and select the number of desired rows.
 
-Once the desired changes are done, click on the `Save` button.
+Once the desired changes are done, click on the `Apply changes` button.
 
 ---
 
@@ -209,7 +252,18 @@ The different backup/restore jobs will be displayed under the `Jobs` section. He
 Under the `Actions` column, you may view details about a specific job or delete the job. The information about the job will contain the executed command, the start time, the duration of execution, and the output.
 
 > **Note:** The backup and restore features run in the background, allowing you to navigate outside of the current tab without pausing the process.
-**TODO**: add note about the new PIGZ compression support and how to configure it (in app settings dialog)
+
+### PIGZ Support 
+PIGZ compression is now available for Linux. If desired, PIGZ needs to be installed on the target OS. For example, in Ubuntu, you may install it as follows:
+
+```
+sudo apt update -y
+sudo apt install -y pigz
+```
+Next, the path to the PIGZ binaries needs to be specified in PgManage. If PIGZ is installed, the path may be added in the `Utilities Menu → Settings → Options → Pigz Binary Path`.
+
+![Settings menu with the PIGZ's path field](./images/settings_options.png)
+
 ### Backup
 
 PgManage allows you to create backups for a database or the whole server. The database backups can be `custom`, `.tar`, `plain`, or `directory`. The  only format supported for server backups is `plain`.
@@ -235,6 +289,47 @@ Once the general information is filled out the `Revert Settings`, `Preview`, and
 - **Restore:** executes the restore commands as indicated in the form.
 
 ---
-### Extras
+## pg_cron GUI Instructions
+
+First, install pg_cron in your target OS. For example, in Ubuntu, you may install it as follows:
+
+```
+sudo apt-get -y install postgresql-[postgres version]-cron
+```
+
+Next, add pg_cron to `shared_preload_libraries` in postgresql.conf. To do this change the following parameter:
+
+```
+shared_preload_libraries = 'pg_cron'
+```
+
+> **Note:** to get the path to your postgresql.conf file you may run the following query: `SHOW config_file;` To get the path to your pg_hba.conf file run the following query: `SHOW hba_file;`
+
+Restart the postgres service so that the changes in the configuration take effect:
+
+```
+sudo systemctl restart postgresql-[version].service
+```
+
+Then, the pg_cron functions and metadata tables can be created. In the postgres shell run the following as super user:
+
+```
+CREATE EXTENSION pg_cron;
+```
+
+To ensure that pg_cron can start jobs, libpg needs permission to open a connection to the local database. This can be done by enabling `trust` authentication for connections coming from localhost. In your `pg_hba.conf` file, add the following line under "IPv4 local connections":
+```
+host    all           all           0.0.0.0/0          md5
+```
+
+Add the following line at the end of the `pg_hba.conf` file to allow connections from all hosts:
+```
+hostssl	 all         all          0.0.0.0/0    		md5
+```
+
+> **Note:** for more information on installing and setting up a cron extention, visit [pg_cron's GitHub repository](https://github.com/citusdata/pg_cron)
+
+Now, PgManage should display the `jobs` node under the database node.
+
 **TODO:** add detailed pg_cron GUI instructions
 brief:install pg_cron extension via extension manager. the "jobs" node should appear under the database node. right click-> new job