diff --git a/docs/en_US/browser.rst b/docs/en_US/browser.rst index 58f7235cd..c54e0fa37 100644 --- a/docs/en_US/browser.rst +++ b/docs/en_US/browser.rst @@ -21,7 +21,7 @@ Features of pgAdmin 4 include: When pgAdmin opens, the interface features a menu bar and a window divided into two panes: the *Browser* tree control in the left pane, and a tabbed browser in the right pane. -.. image:: images/pgadmin_welcome.png +.. image:: images/welcome.png :alt: pgAdmin4 welcome page Select an icon from the *Quick Links* panel on the *Dashboard* tab to: diff --git a/docs/en_US/debugger.rst b/docs/en_US/debugger.rst index c09b311b7..297659a7e 100644 --- a/docs/en_US/debugger.rst +++ b/docs/en_US/debugger.rst @@ -1,7 +1,7 @@ .. _debugger: ************************* -`pgAdmin Debugger`:index: +`Debugger`:index: ************************* .. image:: images/debug_main.png diff --git a/docs/en_US/deployment.rst b/docs/en_US/deployment.rst index 93325df4a..de8e3b649 100644 --- a/docs/en_US/deployment.rst +++ b/docs/en_US/deployment.rst @@ -1,8 +1,8 @@ .. _deployment: -*************************** -`pgAdmin Deployment`:index: -*************************** +******************* +`Deployment`:index: +******************* Pre-compiled and configured installation packages for pgAdmin 4 are available for a number of desktop environments; we recommend using an installer whenever diff --git a/docs/en_US/getting_started.rst b/docs/en_US/getting_started.rst index dc5301f70..340df1b57 100644 --- a/docs/en_US/getting_started.rst +++ b/docs/en_US/getting_started.rst @@ -8,7 +8,7 @@ Pre-compiled and configured installation packages for pgAdmin 4 are available for a number of desktop environments; we recommend using an installer whenever possible. -In a Server Deployment, the pgAdmin application is deployed behind a webserver +In a *Server Deployment*, the pgAdmin application is deployed behind a webserver or with the WSGI interface. If you install pgAdmin in server mode, you will be prompted to provide a role name and pgAdmin password when you initially connect to pgAdmin. The first @@ -18,28 +18,26 @@ and manage additional pgAdmin user accounts. When a user authenticates with pgAdmin, the pgAdmin tree control displays the server definitions associated with that login role. -Contents: - -.. toctree:: - - server_deployment - pgadmin_login - pgadmin_user - change_user_password - -In a Desktop Deployment, the pgAdmin application is configured to use the +In a *Desktop Deployment*, the pgAdmin application is configured to use the desktop runtime environment to host the program on a supported platform. Typically, users will install a pre-built package to run pgAdmin in desktop mode, but a manual desktop deployment can be installed and though it is more difficult to setup, it may be useful for developers interested in understanding how pgAdmin works. +It is also possible to use a *Container Deployment* of pgAdmin, in which Server +Mode is pre-configured for security. + Contents: .. toctree:: :maxdepth: 2 - desktop_deployment + deployment + login + user_management + change_user_password + .. note:: Pre-compiled and configured installation packages are available for a number of platforms. These packages should be used by end-users whereever @@ -71,12 +69,13 @@ the *Help* menu, and selecting the name of the resource that you wish to open. Contents: .. toctree:: + :maxdepth: 2 browser - pgadmin_menu_bar - pgadmin_toolbar - pgadmin_tabbed_browser - pgadmin_tree_control + menu_bar + toolbar + tabbed_browser + tree_control preferences keyboard_shortcuts diff --git a/docs/en_US/images/add_pgadmin_user.png b/docs/en_US/images/add_user.png similarity index 100% rename from docs/en_US/images/add_pgadmin_user.png rename to docs/en_US/images/add_user.png diff --git a/docs/en_US/images/pgadmin_login.png b/docs/en_US/images/login.png similarity index 100% rename from docs/en_US/images/pgadmin_login.png rename to docs/en_US/images/login.png diff --git a/docs/en_US/images/pgadmin_login_recover.png b/docs/en_US/images/login_recover.png similarity index 100% rename from docs/en_US/images/pgadmin_login_recover.png rename to docs/en_US/images/login_recover.png diff --git a/docs/en_US/images/pgadmin_toolbar.png b/docs/en_US/images/toolbar.png similarity index 100% rename from docs/en_US/images/pgadmin_toolbar.png rename to docs/en_US/images/toolbar.png diff --git a/docs/en_US/images/pgadmin_user.png b/docs/en_US/images/user.png similarity index 100% rename from docs/en_US/images/pgadmin_user.png rename to docs/en_US/images/user.png diff --git a/docs/en_US/images/pgadmin_welcome.png b/docs/en_US/images/welcome.png similarity index 100% rename from docs/en_US/images/pgadmin_welcome.png rename to docs/en_US/images/welcome.png diff --git a/docs/en_US/index.rst b/docs/en_US/index.rst index a57823b56..163395394 100644 --- a/docs/en_US/index.rst +++ b/docs/en_US/index.rst @@ -15,6 +15,7 @@ of database objects. Contents: .. toctree:: + :maxdepth: 2 getting_started connecting @@ -24,7 +25,6 @@ Contents: management_basics backup_and_restore developer_tools - deployment contributions pgagent licence diff --git a/docs/en_US/pgadmin_login.rst b/docs/en_US/login.rst similarity index 71% rename from docs/en_US/pgadmin_login.rst rename to docs/en_US/login.rst index d4d7bc362..56905212c 100644 --- a/docs/en_US/pgadmin_login.rst +++ b/docs/en_US/login.rst @@ -1,15 +1,15 @@ -.. _pgadmin_login: +.. _login: -***************************** -`pgAdmin Login Dialog`:index: -***************************** +********************* +`Login Dialog`:index: +********************* -Use the *pgAdmin Login* dialog to log in to pgAdmin: +Use the *Login* dialog to log in to pgAdmin: -.. image:: images/pgadmin_login.png +.. image:: images/login.png :alt: pgAdmin login dialog -Use the fields in the *pgAdmin Login* dialog to authenticate your connection: +Use the fields in the *Login* dialog to authenticate your connection: #. Provide the email address associated with your account in the *Email Address* field. #. Provide your password in the *Password* field. @@ -19,7 +19,7 @@ Use the fields in the *pgAdmin Login* dialog to authenticate your connection: If you cannot supply your password, click the *Forgotten your password?* button to launch a password recovery utility. -.. image:: images/pgadmin_login_recover.png +.. image:: images/login_recover.png :alt: pgAdmin recover login password #. Provide the email address associated with your account in the *Email Address* field. diff --git a/docs/en_US/pgadmin_menu_bar.rst b/docs/en_US/menu_bar.rst similarity index 99% rename from docs/en_US/pgadmin_menu_bar.rst rename to docs/en_US/menu_bar.rst index 5ad096624..3d0a5f663 100644 --- a/docs/en_US/pgadmin_menu_bar.rst +++ b/docs/en_US/menu_bar.rst @@ -1,8 +1,8 @@ -.. _pgadmin_menu_bar: +.. _menu_bar: -************************* -`pgAdmin Menu Bar`:index: -************************* +***************** +`Menu Bar`:index: +***************** The pgAdmin menu bar provides drop-down menus for access to options, commands, and utilities. The menu bar displays the following selections: *File*, *Object*, Tools*, and *Help*. Selections may be grayed out which indicates they are disabled for the object currently selected in the *pgAdmin* tree control. diff --git a/docs/en_US/pgadmin_tabbed_browser.rst b/docs/en_US/tabbed_browser.rst similarity index 99% rename from docs/en_US/pgadmin_tabbed_browser.rst rename to docs/en_US/tabbed_browser.rst index 26239b12f..0b00cca81 100644 --- a/docs/en_US/pgadmin_tabbed_browser.rst +++ b/docs/en_US/tabbed_browser.rst @@ -1,8 +1,8 @@ -.. _pgadmin_tabbed_browser: +.. _tabbed_browser: -******************************* -`pgAdmin Tabbed Browser`:index: -******************************* +*********************** +`Tabbed Browser`:index: +*********************** The right pane of the *pgAdmin* window features a collection of tabs that display information about the object currently selected in the *pgAdmin* tree control in the left window. Select a tab to access information about the highlighted object in the tree control. diff --git a/docs/en_US/pgadmin_toolbar.rst b/docs/en_US/toolbar.rst similarity index 81% rename from docs/en_US/pgadmin_toolbar.rst rename to docs/en_US/toolbar.rst index 295408c82..0db191740 100644 --- a/docs/en_US/pgadmin_toolbar.rst +++ b/docs/en_US/toolbar.rst @@ -1,14 +1,14 @@ -.. _pgadmin_toolbar: +.. _toolbar: -************************* -`pgAdmin Toolbar`:index: -************************* +**************** +`Toolbar`:index: +**************** The pgAdmin toolbar provides shortcut buttons for frequently used features like View Data and the Query Tool which are most frequently used in pgAdmin. This toolbar is visible on the Browser panel. Buttons get enabled/disabled based on the selected browser node. -.. image:: /images/pgadmin_toolbar.png +.. image:: /images/toolbar.png :alt: pgAdmin Toolbar * Use the :ref:`Query Tool ` button to open the Query Tool in the current database context. diff --git a/docs/en_US/pgadmin_tree_control.rst b/docs/en_US/tree_control.rst similarity index 99% rename from docs/en_US/pgadmin_tree_control.rst rename to docs/en_US/tree_control.rst index dd3a5f93f..b6ff44ca7 100644 --- a/docs/en_US/pgadmin_tree_control.rst +++ b/docs/en_US/tree_control.rst @@ -1,7 +1,7 @@ -.. _pgadmin_tree_control: +.. _tree_control: ***************************** -`pgAdmin Tree Control`:index: +`Tree Control`:index: ***************************** The left pane of the main window displays a tree control (the *pgAdmin* tree control) that provides access to the objects that reside on a server. diff --git a/docs/en_US/pgadmin_user.rst b/docs/en_US/user_management.rst similarity index 96% rename from docs/en_US/pgadmin_user.rst rename to docs/en_US/user_management.rst index 1e18adfbb..2e75093b5 100644 --- a/docs/en_US/pgadmin_user.rst +++ b/docs/en_US/user_management.rst @@ -1,4 +1,4 @@ -.. _pgadmin_user: +.. _user_management: ******************************* `User Management Dialog`:index: @@ -12,14 +12,14 @@ When you authenticate with pgAdmin, the server definitions associated with that * assign privileges * manage the password associated with a role -.. image:: images/pgadmin_user.png +.. image:: images/user.png :alt: pgAdmin user management window Use the *Filter by email* search field to find a user; enter a user's email address to find a user. If the user exists, the *User Management* table will display the user's current information. To add a user, click *Add* to add new role. -.. image:: images/add_pgadmin_user.png +.. image:: images/add_user.png :alt: pgAdmin user management window add new user Provide information about the new pgAdmin role in the row: