diff --git a/doc/user-guides/source/cli.rst b/doc/user-guides/source/cli.rst index b60dc99482..2f06faeb8e 100644 --- a/doc/user-guides/source/cli.rst +++ b/doc/user-guides/source/cli.rst @@ -2,39 +2,48 @@ OpenStack command-line clients ============================== -.. Files should be in order of current User Guides and then as following: - Files currently in End User Guide - Files currently only in Admin User Guide, marked with admin_only +.. We need separate toc trees for End User Guide and Admin User Guide + to not run into a bug where the next/previous pages do not work due + to this guide including some files conditionally. - Since Sphinx does not allow comments below, empty lines are used - for the three blocks +.. only:: admin_guide - TODO(ajaeger): Review TOC and consider different options + .. toctree:: + :maxdepth: 2 -.. toctree:: - :maxdepth: 2 + common/cli_overview.rst + common/cli_install_openstack_command_line_clients.rst + common/cli_discover_version_number_for_a_client.rst + common/cli_set_environment_variables_using_openstack_rc.rst + adminuser/manage_projects_users_and_roles.rst + adminuser/nova_cli_manage_projects_security.rst + adminuser/cli_manage_services.rst + common/cli_manage_images.rst + common/cli_manage_volumes.rst + adminuser/cli_manage_flavors.rst + adminuser/cli_admin_manage_environment.rst + adminuser/cli_set_quotas.rst + adminuser/analyzing-log-files-with-swift-cli.rst - common/cli_overview.rst - common/cli_install_openstack_command_line_clients.rst - common/cli_discover_version_number_for_a_client.rst - common/cli_set_environment_variables_using_openstack_rc.rst - adminuser/manage_projects_users_and_roles.rst - adminuser/nova_cli_manage_projects_security.rst - adminuser/cli_manage_services.rst - common/cli_manage_images.rst - common/cli_manage_volumes.rst - enduser/cli_nova_configure_access_security_for_instances.rst - enduser/cli_launch_instances.rst - enduser/cli_manage_instances_hosts.rst - enduser/cli_provide_user_data_to_instances.rst - enduser/cli_use_snapshots_to_migrate_instances.rst - enduser/cli_config_drive.rst - enduser/cli_create_and_manage_networks.rst - enduser/managing-openstack-object-storage-with-swift-cli.rst - enduser/cli_create_and_manage_stacks.rst - enduser/cli_ceilometer.rst - enduser/trove-manage-db.rst - adminuser/cli_manage_flavors.rst - adminuser/cli_admin_manage_environment.rst - adminuser/cli_set_quotas.rst - adminuser/analyzing-log-files-with-swift-cli.rst +.. only:: user_guide + + .. toctree:: + :maxdepth: 2 + + common/cli_overview.rst + common/cli_install_openstack_command_line_clients.rst + common/cli_discover_version_number_for_a_client.rst + common/cli_set_environment_variables_using_openstack_rc.rst + common/cli_manage_images.rst + common/cli_manage_volumes.rst + enduser/cli_nova_configure_access_security_for_instances.rst + enduser/cli_launch_instances.rst + enduser/cli_manage_instances_hosts.rst + enduser/cli_provide_user_data_to_instances.rst + enduser/cli_use_snapshots_to_migrate_instances.rst + enduser/cli_config_drive.rst + enduser/cli_create_and_manage_networks.rst + enduser/managing-openstack-object-storage-with-swift-cli.rst + enduser/cli_create_and_manage_stacks.rst + enduser/cli_ceilometer.rst + enduser/trove-manage-db.rst diff --git a/doc/user-guides/source/dashboard.rst b/doc/user-guides/source/dashboard.rst index 782a7d61bd..5a98e75464 100644 --- a/doc/user-guides/source/dashboard.rst +++ b/doc/user-guides/source/dashboard.rst @@ -18,35 +18,39 @@ OpenStack dashboard sizes of server instances. -.. Files should be in order of current User Guides and then as following: - Files currently in End User Guide - Files currently only in Admn User Guide, marked with admin_only +.. We need separate toc trees for End User Guide and Admin User Guide + to not run into a bug where the next/previous pages do not work due + to this guide including some files conditionally. - Since Sphinx does not allow comments below, empty lines are used - as separators. +.. only:: admin_guide - TODO(ajaeger): Review TOC and consider different options + .. toctree:: + :maxdepth: 2 + common/log_in_dashboard.rst -.. toctree:: - :maxdepth: 2 + adminuser/dashboard_manage_images.rst + adminuser/dashboard_admin_manage_roles.rst + adminuser/dashboard_manage_instances.rst + adminuser/dashboard_manage_flavors.rst + adminuser/dashboard_manage_volumes.rst + adminuser/dashboard_set_quotas + adminuser/dashboard_manage_resources.rst + adminuser/dashboard_manage_host_aggregates.rst + adminuser/dashboard_admin_manage_stacks.rst - common/log_in_dashboard.rst - enduser/dashboard_manage_images.rst - enduser/configure_access_and_security_for_instances.rst - enduser/dashboard_launch_instances.rst - enduser/dashboard_create_networks.rst - enduser/dashboard_manage_containers.rst - enduser/dashboard_manage_volumes.rst - enduser/dashboard_stacks.rst - enduser/dashboard_databases.rst +.. only:: user_guide + + .. toctree:: + :maxdepth: 2 + + common/log_in_dashboard.rst + enduser/dashboard_manage_images.rst + enduser/configure_access_and_security_for_instances.rst + enduser/dashboard_launch_instances.rst + enduser/dashboard_create_networks.rst + enduser/dashboard_manage_containers.rst + enduser/dashboard_manage_volumes.rst + enduser/dashboard_stacks.rst + enduser/dashboard_databases.rst - adminuser/dashboard_manage_images.rst - adminuser/dashboard_admin_manage_roles.rst - adminuser/dashboard_manage_instances.rst - adminuser/dashboard_manage_volumes.rst - adminuser/dashboard_manage_flavors.rst - adminuser/dashboard_set_quotas - adminuser/dashboard_manage_resources.rst - adminuser/dashboard_manage_host_aggregates.rst - adminuser/dashboard_admin_manage_stacks.rst