diff --git a/.gitignore b/.gitignore index 37f85b618e..554853c9e3 100644 --- a/.gitignore +++ b/.gitignore @@ -7,7 +7,7 @@ target/ /publish-docs/ /www/output/ /generated/ -/doc/playground-user-guide/build-admin/ +/doc/user-guides/build-admin/ build/ /build-*.log.gz diff --git a/doc-tools-check-languages.conf b/doc-tools-check-languages.conf index cced8e6664..99c7160da2 100644 --- a/doc-tools-check-languages.conf +++ b/doc-tools-check-languages.conf @@ -25,7 +25,7 @@ DOC_DIR="doc/" # Values need to match content in project-config/jenkins/scripts/common_translation_update.sh declare -A SPECIAL_BOOKS SPECIAL_BOOKS=( - ["playground-user-guide"]="RST" + ["user-guides"]="RST" ["networking-guide"]="skip" ["hot-guide"]="skip" ) diff --git a/doc/playground-user-guide/setup.cfg b/doc/user-guides/setup.cfg similarity index 100% rename from doc/playground-user-guide/setup.cfg rename to doc/user-guides/setup.cfg diff --git a/doc/playground-user-guide/setup.py b/doc/user-guides/setup.py similarity index 100% rename from doc/playground-user-guide/setup.py rename to doc/user-guides/setup.py diff --git a/doc/playground-user-guide/source/analyzing-log-files-with-swift-cli.rst b/doc/user-guides/source/analyzing-log-files-with-swift-cli.rst similarity index 100% rename from doc/playground-user-guide/source/analyzing-log-files-with-swift-cli.rst rename to doc/user-guides/source/analyzing-log-files-with-swift-cli.rst diff --git a/doc/playground-user-guide/source/backup_db.rst b/doc/user-guides/source/backup_db.rst similarity index 100% rename from doc/playground-user-guide/source/backup_db.rst rename to doc/user-guides/source/backup_db.rst diff --git a/doc/playground-user-guide/source/backup_db_incremental.rst b/doc/user-guides/source/backup_db_incremental.rst similarity index 100% rename from doc/playground-user-guide/source/backup_db_incremental.rst rename to doc/user-guides/source/backup_db_incremental.rst diff --git a/doc/playground-user-guide/source/cli.rst b/doc/user-guides/source/cli.rst similarity index 100% rename from doc/playground-user-guide/source/cli.rst rename to doc/user-guides/source/cli.rst diff --git a/doc/playground-user-guide/source/cli_access_instance_through_a_console.rst b/doc/user-guides/source/cli_access_instance_through_a_console.rst similarity index 100% rename from doc/playground-user-guide/source/cli_access_instance_through_a_console.rst rename to doc/user-guides/source/cli_access_instance_through_a_console.rst diff --git a/doc/playground-user-guide/source/cli_admin_manage_environment.rst b/doc/user-guides/source/cli_admin_manage_environment.rst similarity index 100% rename from doc/playground-user-guide/source/cli_admin_manage_environment.rst rename to doc/user-guides/source/cli_admin_manage_environment.rst diff --git a/doc/playground-user-guide/source/cli_admin_manage_ip_addresses.rst b/doc/user-guides/source/cli_admin_manage_ip_addresses.rst similarity index 100% rename from doc/playground-user-guide/source/cli_admin_manage_ip_addresses.rst rename to doc/user-guides/source/cli_admin_manage_ip_addresses.rst diff --git a/doc/playground-user-guide/source/cli_admin_manage_stacks.rst b/doc/user-guides/source/cli_admin_manage_stacks.rst similarity index 100% rename from doc/playground-user-guide/source/cli_admin_manage_stacks.rst rename to doc/user-guides/source/cli_admin_manage_stacks.rst diff --git a/doc/playground-user-guide/source/cli_change_the_size_of_your_server.rst b/doc/user-guides/source/cli_change_the_size_of_your_server.rst similarity index 100% rename from doc/playground-user-guide/source/cli_change_the_size_of_your_server.rst rename to doc/user-guides/source/cli_change_the_size_of_your_server.rst diff --git a/doc/playground-user-guide/source/cli_cheat_sheet.rst b/doc/user-guides/source/cli_cheat_sheet.rst similarity index 100% rename from doc/playground-user-guide/source/cli_cheat_sheet.rst rename to doc/user-guides/source/cli_cheat_sheet.rst diff --git a/doc/playground-user-guide/source/cli_cinder_quotas.rst b/doc/user-guides/source/cli_cinder_quotas.rst similarity index 100% rename from doc/playground-user-guide/source/cli_cinder_quotas.rst rename to doc/user-guides/source/cli_cinder_quotas.rst diff --git a/doc/playground-user-guide/source/cli_delete_an_instance.rst b/doc/user-guides/source/cli_delete_an_instance.rst similarity index 100% rename from doc/playground-user-guide/source/cli_delete_an_instance.rst rename to doc/user-guides/source/cli_delete_an_instance.rst diff --git a/doc/playground-user-guide/source/cli_keystone_manage_services.rst b/doc/user-guides/source/cli_keystone_manage_services.rst similarity index 100% rename from doc/playground-user-guide/source/cli_keystone_manage_services.rst rename to doc/user-guides/source/cli_keystone_manage_services.rst diff --git a/doc/playground-user-guide/source/cli_launch_instances.rst b/doc/user-guides/source/cli_launch_instances.rst similarity index 100% rename from doc/playground-user-guide/source/cli_launch_instances.rst rename to doc/user-guides/source/cli_launch_instances.rst diff --git a/doc/playground-user-guide/source/cli_manage_bare_metal_nodes.rst b/doc/user-guides/source/cli_manage_bare_metal_nodes.rst similarity index 100% rename from doc/playground-user-guide/source/cli_manage_bare_metal_nodes.rst rename to doc/user-guides/source/cli_manage_bare_metal_nodes.rst diff --git a/doc/playground-user-guide/source/cli_manage_flavors.rst b/doc/user-guides/source/cli_manage_flavors.rst similarity index 100% rename from doc/playground-user-guide/source/cli_manage_flavors.rst rename to doc/user-guides/source/cli_manage_flavors.rst diff --git a/doc/playground-user-guide/source/cli_manage_instances_hosts.rst b/doc/user-guides/source/cli_manage_instances_hosts.rst similarity index 100% rename from doc/playground-user-guide/source/cli_manage_instances_hosts.rst rename to doc/user-guides/source/cli_manage_instances_hosts.rst diff --git a/doc/playground-user-guide/source/cli_manage_ip_addresses.rst b/doc/user-guides/source/cli_manage_ip_addresses.rst similarity index 100% rename from doc/playground-user-guide/source/cli_manage_ip_addresses.rst rename to doc/user-guides/source/cli_manage_ip_addresses.rst diff --git a/doc/playground-user-guide/source/cli_manage_services.rst b/doc/user-guides/source/cli_manage_services.rst similarity index 100% rename from doc/playground-user-guide/source/cli_manage_services.rst rename to doc/user-guides/source/cli_manage_services.rst diff --git a/doc/playground-user-guide/source/cli_nova_configure_access_security_for_instances.rst b/doc/user-guides/source/cli_nova_configure_access_security_for_instances.rst similarity index 100% rename from doc/playground-user-guide/source/cli_nova_configure_access_security_for_instances.rst rename to doc/user-guides/source/cli_nova_configure_access_security_for_instances.rst diff --git a/doc/playground-user-guide/source/cli_nova_evacuate.rst b/doc/user-guides/source/cli_nova_evacuate.rst similarity index 100% rename from doc/playground-user-guide/source/cli_nova_evacuate.rst rename to doc/user-guides/source/cli_nova_evacuate.rst diff --git a/doc/playground-user-guide/source/cli_nova_manage_services.rst b/doc/user-guides/source/cli_nova_manage_services.rst similarity index 100% rename from doc/playground-user-guide/source/cli_nova_manage_services.rst rename to doc/user-guides/source/cli_nova_manage_services.rst diff --git a/doc/playground-user-guide/source/cli_nova_migrate.rst b/doc/user-guides/source/cli_nova_migrate.rst similarity index 100% rename from doc/playground-user-guide/source/cli_nova_migrate.rst rename to doc/user-guides/source/cli_nova_migrate.rst diff --git a/doc/playground-user-guide/source/cli_nova_specify_host.rst b/doc/user-guides/source/cli_nova_specify_host.rst similarity index 100% rename from doc/playground-user-guide/source/cli_nova_specify_host.rst rename to doc/user-guides/source/cli_nova_specify_host.rst diff --git a/doc/playground-user-guide/source/cli_overview.rst b/doc/user-guides/source/cli_overview.rst similarity index 100% rename from doc/playground-user-guide/source/cli_overview.rst rename to doc/user-guides/source/cli_overview.rst diff --git a/doc/playground-user-guide/source/cli_provide_user_data_to_instances.rst b/doc/user-guides/source/cli_provide_user_data_to_instances.rst similarity index 100% rename from doc/playground-user-guide/source/cli_provide_user_data_to_instances.rst rename to doc/user-guides/source/cli_provide_user_data_to_instances.rst diff --git a/doc/playground-user-guide/source/cli_reboot_an_instance.rst b/doc/user-guides/source/cli_reboot_an_instance.rst similarity index 100% rename from doc/playground-user-guide/source/cli_reboot_an_instance.rst rename to doc/user-guides/source/cli_reboot_an_instance.rst diff --git a/doc/playground-user-guide/source/cli_search_instance_with_ip_address.rst b/doc/user-guides/source/cli_search_instance_with_ip_address.rst similarity index 100% rename from doc/playground-user-guide/source/cli_search_instance_with_ip_address.rst rename to doc/user-guides/source/cli_search_instance_with_ip_address.rst diff --git a/doc/playground-user-guide/source/cli_set_quotas.rst b/doc/user-guides/source/cli_set_quotas.rst similarity index 100% rename from doc/playground-user-guide/source/cli_set_quotas.rst rename to doc/user-guides/source/cli_set_quotas.rst diff --git a/doc/playground-user-guide/source/cli_stop_and_start_an_instance.rst b/doc/user-guides/source/cli_stop_and_start_an_instance.rst similarity index 100% rename from doc/playground-user-guide/source/cli_stop_and_start_an_instance.rst rename to doc/user-guides/source/cli_stop_and_start_an_instance.rst diff --git a/doc/playground-user-guide/source/cli_swift_archive_auto_extract.rst b/doc/user-guides/source/cli_swift_archive_auto_extract.rst similarity index 100% rename from doc/playground-user-guide/source/cli_swift_archive_auto_extract.rst rename to doc/user-guides/source/cli_swift_archive_auto_extract.rst diff --git a/doc/playground-user-guide/source/cli_swift_bulk_delete.rst b/doc/user-guides/source/cli_swift_bulk_delete.rst similarity index 100% rename from doc/playground-user-guide/source/cli_swift_bulk_delete.rst rename to doc/user-guides/source/cli_swift_bulk_delete.rst diff --git a/doc/playground-user-guide/source/cli_swift_create_containers.rst b/doc/user-guides/source/cli_swift_create_containers.rst similarity index 100% rename from doc/playground-user-guide/source/cli_swift_create_containers.rst rename to doc/user-guides/source/cli_swift_create_containers.rst diff --git a/doc/playground-user-guide/source/cli_swift_discoverability.rst b/doc/user-guides/source/cli_swift_discoverability.rst similarity index 100% rename from doc/playground-user-guide/source/cli_swift_discoverability.rst rename to doc/user-guides/source/cli_swift_discoverability.rst diff --git a/doc/playground-user-guide/source/cli_swift_env_vars.rst b/doc/user-guides/source/cli_swift_env_vars.rst similarity index 100% rename from doc/playground-user-guide/source/cli_swift_env_vars.rst rename to doc/user-guides/source/cli_swift_env_vars.rst diff --git a/doc/playground-user-guide/source/cli_swift_large_lists.rst b/doc/user-guides/source/cli_swift_large_lists.rst similarity index 100% rename from doc/playground-user-guide/source/cli_swift_large_lists.rst rename to doc/user-guides/source/cli_swift_large_lists.rst diff --git a/doc/playground-user-guide/source/cli_swift_large_object_creation.rst b/doc/user-guides/source/cli_swift_large_object_creation.rst similarity index 100% rename from doc/playground-user-guide/source/cli_swift_large_object_creation.rst rename to doc/user-guides/source/cli_swift_large_object_creation.rst diff --git a/doc/playground-user-guide/source/cli_swift_manage_access_swift.rst b/doc/user-guides/source/cli_swift_manage_access_swift.rst similarity index 100% rename from doc/playground-user-guide/source/cli_swift_manage_access_swift.rst rename to doc/user-guides/source/cli_swift_manage_access_swift.rst diff --git a/doc/playground-user-guide/source/cli_swift_manage_objects.rst b/doc/user-guides/source/cli_swift_manage_objects.rst similarity index 100% rename from doc/playground-user-guide/source/cli_swift_manage_objects.rst rename to doc/user-guides/source/cli_swift_manage_objects.rst diff --git a/doc/playground-user-guide/source/cli_swift_pseudo_hierarchical_folders_directories.rst b/doc/user-guides/source/cli_swift_pseudo_hierarchical_folders_directories.rst similarity index 100% rename from doc/playground-user-guide/source/cli_swift_pseudo_hierarchical_folders_directories.rst rename to doc/user-guides/source/cli_swift_pseudo_hierarchical_folders_directories.rst diff --git a/doc/playground-user-guide/source/cli_swift_serialized_response_formats.rst b/doc/user-guides/source/cli_swift_serialized_response_formats.rst similarity index 100% rename from doc/playground-user-guide/source/cli_swift_serialized_response_formats.rst rename to doc/user-guides/source/cli_swift_serialized_response_formats.rst diff --git a/doc/playground-user-guide/source/cli_swift_set_object_versions.rst b/doc/user-guides/source/cli_swift_set_object_versions.rst similarity index 100% rename from doc/playground-user-guide/source/cli_swift_set_object_versions.rst rename to doc/user-guides/source/cli_swift_set_object_versions.rst diff --git a/doc/playground-user-guide/source/cli_swift_static_website.rst b/doc/user-guides/source/cli_swift_static_website.rst similarity index 100% rename from doc/playground-user-guide/source/cli_swift_static_website.rst rename to doc/user-guides/source/cli_swift_static_website.rst diff --git a/doc/playground-user-guide/source/cli_use_snapshots_to_migrate_instances.rst b/doc/user-guides/source/cli_use_snapshots_to_migrate_instances.rst similarity index 100% rename from doc/playground-user-guide/source/cli_use_snapshots_to_migrate_instances.rst rename to doc/user-guides/source/cli_use_snapshots_to_migrate_instances.rst diff --git a/doc/playground-user-guide/source/common/cli_create_and_manage_networks.rst b/doc/user-guides/source/common/cli_create_and_manage_networks.rst similarity index 100% rename from doc/playground-user-guide/source/common/cli_create_and_manage_networks.rst rename to doc/user-guides/source/common/cli_create_and_manage_networks.rst diff --git a/doc/playground-user-guide/source/common/cli_discover_version_number_for_a_client.rst b/doc/user-guides/source/common/cli_discover_version_number_for_a_client.rst similarity index 100% rename from doc/playground-user-guide/source/common/cli_discover_version_number_for_a_client.rst rename to doc/user-guides/source/common/cli_discover_version_number_for_a_client.rst diff --git a/doc/playground-user-guide/source/common/cli_install_openstack_command_line_clients.rst b/doc/user-guides/source/common/cli_install_openstack_command_line_clients.rst similarity index 100% rename from doc/playground-user-guide/source/common/cli_install_openstack_command_line_clients.rst rename to doc/user-guides/source/common/cli_install_openstack_command_line_clients.rst diff --git a/doc/playground-user-guide/source/common/cli_manage_images.rst b/doc/user-guides/source/common/cli_manage_images.rst similarity index 100% rename from doc/playground-user-guide/source/common/cli_manage_images.rst rename to doc/user-guides/source/common/cli_manage_images.rst diff --git a/doc/playground-user-guide/source/common/cli_manage_volumes.rst b/doc/user-guides/source/common/cli_manage_volumes.rst similarity index 100% rename from doc/playground-user-guide/source/common/cli_manage_volumes.rst rename to doc/user-guides/source/common/cli_manage_volumes.rst diff --git a/doc/playground-user-guide/source/common/cli_nova_launch_instance_from_volume.rst b/doc/user-guides/source/common/cli_nova_launch_instance_from_volume.rst similarity index 100% rename from doc/playground-user-guide/source/common/cli_nova_launch_instance_from_volume.rst rename to doc/user-guides/source/common/cli_nova_launch_instance_from_volume.rst diff --git a/doc/playground-user-guide/source/common/cli_nova_show_usage_statistics_for_hosts_instances.rst b/doc/user-guides/source/common/cli_nova_show_usage_statistics_for_hosts_instances.rst similarity index 100% rename from doc/playground-user-guide/source/common/cli_nova_show_usage_statistics_for_hosts_instances.rst rename to doc/user-guides/source/common/cli_nova_show_usage_statistics_for_hosts_instances.rst diff --git a/doc/playground-user-guide/source/common/cli_set_compute_quotas.rst b/doc/user-guides/source/common/cli_set_compute_quotas.rst similarity index 100% rename from doc/playground-user-guide/source/common/cli_set_compute_quotas.rst rename to doc/user-guides/source/common/cli_set_compute_quotas.rst diff --git a/doc/playground-user-guide/source/common/cli_set_environment_variables_using_openstack_rc.rst b/doc/user-guides/source/common/cli_set_environment_variables_using_openstack_rc.rst similarity index 100% rename from doc/playground-user-guide/source/common/cli_set_environment_variables_using_openstack_rc.rst rename to doc/user-guides/source/common/cli_set_environment_variables_using_openstack_rc.rst diff --git a/doc/playground-user-guide/source/common/networking_advanced_quotas.rst b/doc/user-guides/source/common/networking_advanced_quotas.rst similarity index 100% rename from doc/playground-user-guide/source/common/networking_advanced_quotas.rst rename to doc/user-guides/source/common/networking_advanced_quotas.rst diff --git a/doc/playground-user-guide/source/conf.py b/doc/user-guides/source/conf.py similarity index 100% rename from doc/playground-user-guide/source/conf.py rename to doc/user-guides/source/conf.py diff --git a/doc/playground-user-guide/source/configure_access_and_security_for_instances.rst b/doc/user-guides/source/configure_access_and_security_for_instances.rst similarity index 100% rename from doc/playground-user-guide/source/configure_access_and_security_for_instances.rst rename to doc/user-guides/source/configure_access_and_security_for_instances.rst diff --git a/doc/playground-user-guide/source/create_db.rst b/doc/user-guides/source/create_db.rst similarity index 100% rename from doc/playground-user-guide/source/create_db.rst rename to doc/user-guides/source/create_db.rst diff --git a/doc/playground-user-guide/source/dashboard.rst b/doc/user-guides/source/dashboard.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard.rst rename to doc/user-guides/source/dashboard.rst diff --git a/doc/playground-user-guide/source/dashboard_admin_manage_roles.rst b/doc/user-guides/source/dashboard_admin_manage_roles.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_admin_manage_roles.rst rename to doc/user-guides/source/dashboard_admin_manage_roles.rst diff --git a/doc/playground-user-guide/source/dashboard_admin_manage_stacks.rst b/doc/user-guides/source/dashboard_admin_manage_stacks.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_admin_manage_stacks.rst rename to doc/user-guides/source/dashboard_admin_manage_stacks.rst diff --git a/doc/playground-user-guide/source/dashboard_create_networks.rst b/doc/user-guides/source/dashboard_create_networks.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_create_networks.rst rename to doc/user-guides/source/dashboard_create_networks.rst diff --git a/doc/playground-user-guide/source/dashboard_databases.rst b/doc/user-guides/source/dashboard_databases.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_databases.rst rename to doc/user-guides/source/dashboard_databases.rst diff --git a/doc/playground-user-guide/source/dashboard_manage_containers.rst b/doc/user-guides/source/dashboard_manage_containers.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_manage_containers.rst rename to doc/user-guides/source/dashboard_manage_containers.rst diff --git a/doc/playground-user-guide/source/dashboard_manage_flavors.rst b/doc/user-guides/source/dashboard_manage_flavors.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_manage_flavors.rst rename to doc/user-guides/source/dashboard_manage_flavors.rst diff --git a/doc/playground-user-guide/source/dashboard_manage_host_aggregates.rst b/doc/user-guides/source/dashboard_manage_host_aggregates.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_manage_host_aggregates.rst rename to doc/user-guides/source/dashboard_manage_host_aggregates.rst diff --git a/doc/playground-user-guide/source/dashboard_manage_images.rst b/doc/user-guides/source/dashboard_manage_images.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_manage_images.rst rename to doc/user-guides/source/dashboard_manage_images.rst diff --git a/doc/playground-user-guide/source/dashboard_manage_instances.rst b/doc/user-guides/source/dashboard_manage_instances.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_manage_instances.rst rename to doc/user-guides/source/dashboard_manage_instances.rst diff --git a/doc/playground-user-guide/source/dashboard_manage_resources.rst b/doc/user-guides/source/dashboard_manage_resources.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_manage_resources.rst rename to doc/user-guides/source/dashboard_manage_resources.rst diff --git a/doc/playground-user-guide/source/dashboard_manage_services.rst b/doc/user-guides/source/dashboard_manage_services.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_manage_services.rst rename to doc/user-guides/source/dashboard_manage_services.rst diff --git a/doc/playground-user-guide/source/dashboard_manage_volumes.rst b/doc/user-guides/source/dashboard_manage_volumes.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_manage_volumes.rst rename to doc/user-guides/source/dashboard_manage_volumes.rst diff --git a/doc/playground-user-guide/source/dashboard_set_quotas.rst b/doc/user-guides/source/dashboard_set_quotas.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_set_quotas.rst rename to doc/user-guides/source/dashboard_set_quotas.rst diff --git a/doc/playground-user-guide/source/dashboard_stacks.rst b/doc/user-guides/source/dashboard_stacks.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_stacks.rst rename to doc/user-guides/source/dashboard_stacks.rst diff --git a/doc/playground-user-guide/source/dashboard_view_cloud_resources.rst b/doc/user-guides/source/dashboard_view_cloud_resources.rst similarity index 100% rename from doc/playground-user-guide/source/dashboard_view_cloud_resources.rst rename to doc/user-guides/source/dashboard_view_cloud_resources.rst diff --git a/doc/playground-user-guide/source/figures/change_instance_state.png b/doc/user-guides/source/figures/change_instance_state.png similarity index 100% rename from doc/playground-user-guide/source/figures/change_instance_state.png rename to doc/user-guides/source/figures/change_instance_state.png diff --git a/doc/playground-user-guide/source/figures/dashboard-project-tab.png b/doc/user-guides/source/figures/dashboard-project-tab.png similarity index 100% rename from doc/playground-user-guide/source/figures/dashboard-project-tab.png rename to doc/user-guides/source/figures/dashboard-project-tab.png diff --git a/doc/playground-user-guide/source/figures/dashboard_admin_project_tab.png b/doc/user-guides/source/figures/dashboard_admin_project_tab.png similarity index 100% rename from doc/playground-user-guide/source/figures/dashboard_admin_project_tab.png rename to doc/user-guides/source/figures/dashboard_admin_project_tab.png diff --git a/doc/playground-user-guide/source/hot-guide/hot.rst b/doc/user-guides/source/hot-guide/hot.rst similarity index 100% rename from doc/playground-user-guide/source/hot-guide/hot.rst rename to doc/user-guides/source/hot-guide/hot.rst diff --git a/doc/playground-user-guide/source/hot-guide/hot_advanced_topics.rst b/doc/user-guides/source/hot-guide/hot_advanced_topics.rst similarity index 100% rename from doc/playground-user-guide/source/hot-guide/hot_advanced_topics.rst rename to doc/user-guides/source/hot-guide/hot_advanced_topics.rst diff --git a/doc/playground-user-guide/source/hot-guide/hot_basic_resources.rst b/doc/user-guides/source/hot-guide/hot_basic_resources.rst similarity index 100% rename from doc/playground-user-guide/source/hot-guide/hot_basic_resources.rst rename to doc/user-guides/source/hot-guide/hot_basic_resources.rst diff --git a/doc/playground-user-guide/source/hot-guide/hot_composition.rst b/doc/user-guides/source/hot-guide/hot_composition.rst similarity index 100% rename from doc/playground-user-guide/source/hot-guide/hot_composition.rst rename to doc/user-guides/source/hot-guide/hot_composition.rst diff --git a/doc/playground-user-guide/source/hot-guide/hot_environment.rst b/doc/user-guides/source/hot-guide/hot_environment.rst similarity index 100% rename from doc/playground-user-guide/source/hot-guide/hot_environment.rst rename to doc/user-guides/source/hot-guide/hot_environment.rst diff --git a/doc/playground-user-guide/source/hot-guide/hot_existing_templates.rst b/doc/user-guides/source/hot-guide/hot_existing_templates.rst similarity index 100% rename from doc/playground-user-guide/source/hot-guide/hot_existing_templates.rst rename to doc/user-guides/source/hot-guide/hot_existing_templates.rst diff --git a/doc/playground-user-guide/source/hot-guide/hot_hello_world.rst b/doc/user-guides/source/hot-guide/hot_hello_world.rst similarity index 100% rename from doc/playground-user-guide/source/hot-guide/hot_hello_world.rst rename to doc/user-guides/source/hot-guide/hot_hello_world.rst diff --git a/doc/playground-user-guide/source/hot-guide/hot_software_deployment.rst b/doc/user-guides/source/hot-guide/hot_software_deployment.rst similarity index 100% rename from doc/playground-user-guide/source/hot-guide/hot_software_deployment.rst rename to doc/user-guides/source/hot-guide/hot_software_deployment.rst diff --git a/doc/playground-user-guide/source/hot-guide/hot_spec.rst b/doc/user-guides/source/hot-guide/hot_spec.rst similarity index 100% rename from doc/playground-user-guide/source/hot-guide/hot_spec.rst rename to doc/user-guides/source/hot-guide/hot_spec.rst diff --git a/doc/playground-user-guide/source/index-admin.rst b/doc/user-guides/source/index-admin.rst similarity index 100% rename from doc/playground-user-guide/source/index-admin.rst rename to doc/user-guides/source/index-admin.rst diff --git a/doc/playground-user-guide/source/index.rst b/doc/user-guides/source/index.rst similarity index 100% rename from doc/playground-user-guide/source/index.rst rename to doc/user-guides/source/index.rst diff --git a/doc/playground-user-guide/source/intro-admin.rst b/doc/user-guides/source/intro-admin.rst similarity index 100% rename from doc/playground-user-guide/source/intro-admin.rst rename to doc/user-guides/source/intro-admin.rst diff --git a/doc/playground-user-guide/source/intro-user.rst b/doc/user-guides/source/intro-user.rst similarity index 100% rename from doc/playground-user-guide/source/intro-user.rst rename to doc/user-guides/source/intro-user.rst diff --git a/doc/playground-user-guide/source/locale/playground-user-guide.pot b/doc/user-guides/source/locale/user-guides.pot similarity index 100% rename from doc/playground-user-guide/source/locale/playground-user-guide.pot rename to doc/user-guides/source/locale/user-guides.pot diff --git a/doc/playground-user-guide/source/log_in_dashboard.rst b/doc/user-guides/source/log_in_dashboard.rst similarity index 100% rename from doc/playground-user-guide/source/log_in_dashboard.rst rename to doc/user-guides/source/log_in_dashboard.rst diff --git a/doc/playground-user-guide/source/manage_db_config.rst b/doc/user-guides/source/manage_db_config.rst similarity index 100% rename from doc/playground-user-guide/source/manage_db_config.rst rename to doc/user-guides/source/manage_db_config.rst diff --git a/doc/playground-user-guide/source/manage_projects_users_and_roles.rst b/doc/user-guides/source/manage_projects_users_and_roles.rst similarity index 100% rename from doc/playground-user-guide/source/manage_projects_users_and_roles.rst rename to doc/user-guides/source/manage_projects_users_and_roles.rst diff --git a/doc/playground-user-guide/source/managing-openstack-object-storage-with-swift-cli.rst b/doc/user-guides/source/managing-openstack-object-storage-with-swift-cli.rst similarity index 100% rename from doc/playground-user-guide/source/managing-openstack-object-storage-with-swift-cli.rst rename to doc/user-guides/source/managing-openstack-object-storage-with-swift-cli.rst diff --git a/doc/playground-user-guide/source/nova_cli_manage_projects_security.rst b/doc/user-guides/source/nova_cli_manage_projects_security.rst similarity index 100% rename from doc/playground-user-guide/source/nova_cli_manage_projects_security.rst rename to doc/user-guides/source/nova_cli_manage_projects_security.rst diff --git a/doc/playground-user-guide/source/sdk.rst b/doc/user-guides/source/sdk.rst similarity index 100% rename from doc/playground-user-guide/source/sdk.rst rename to doc/user-guides/source/sdk.rst diff --git a/doc/playground-user-guide/source/sdk_assign_cors_headers.rst b/doc/user-guides/source/sdk_assign_cors_headers.rst similarity index 100% rename from doc/playground-user-guide/source/sdk_assign_cors_headers.rst rename to doc/user-guides/source/sdk_assign_cors_headers.rst diff --git a/doc/playground-user-guide/source/sdk_authenticate.rst b/doc/user-guides/source/sdk_authenticate.rst similarity index 100% rename from doc/playground-user-guide/source/sdk_authenticate.rst rename to doc/user-guides/source/sdk_authenticate.rst diff --git a/doc/playground-user-guide/source/sdk_authenticate_against_compute_endpoint.rst b/doc/user-guides/source/sdk_authenticate_against_compute_endpoint.rst similarity index 100% rename from doc/playground-user-guide/source/sdk_authenticate_against_compute_endpoint.rst rename to doc/user-guides/source/sdk_authenticate_against_compute_endpoint.rst diff --git a/doc/playground-user-guide/source/sdk_authenticate_against_identity_endpoint.rst b/doc/user-guides/source/sdk_authenticate_against_identity_endpoint.rst similarity index 100% rename from doc/playground-user-guide/source/sdk_authenticate_against_identity_endpoint.rst rename to doc/user-guides/source/sdk_authenticate_against_identity_endpoint.rst diff --git a/doc/playground-user-guide/source/sdk_authenticate_against_image_service_endpoint.rst b/doc/user-guides/source/sdk_authenticate_against_image_service_endpoint.rst similarity index 100% rename from doc/playground-user-guide/source/sdk_authenticate_against_image_service_endpoint.rst rename to doc/user-guides/source/sdk_authenticate_against_image_service_endpoint.rst diff --git a/doc/playground-user-guide/source/sdk_authenticate_against_networking_endpoint.rst b/doc/user-guides/source/sdk_authenticate_against_networking_endpoint.rst similarity index 100% rename from doc/playground-user-guide/source/sdk_authenticate_against_networking_endpoint.rst rename to doc/user-guides/source/sdk_authenticate_against_networking_endpoint.rst diff --git a/doc/playground-user-guide/source/sdk_authenticate_compute_output.rst b/doc/user-guides/source/sdk_authenticate_compute_output.rst similarity index 100% rename from doc/playground-user-guide/source/sdk_authenticate_compute_output.rst rename to doc/user-guides/source/sdk_authenticate_compute_output.rst diff --git a/doc/playground-user-guide/source/sdk_authenticate_networking_endpoint.rst b/doc/user-guides/source/sdk_authenticate_networking_endpoint.rst similarity index 100% rename from doc/playground-user-guide/source/sdk_authenticate_networking_endpoint.rst rename to doc/user-guides/source/sdk_authenticate_networking_endpoint.rst diff --git a/doc/playground-user-guide/source/sdk_configure_access_security_instances.rst b/doc/user-guides/source/sdk_configure_access_security_instances.rst similarity index 100% rename from doc/playground-user-guide/source/sdk_configure_access_security_instances.rst rename to doc/user-guides/source/sdk_configure_access_security_instances.rst diff --git a/doc/playground-user-guide/source/sdk_install.rst b/doc/user-guides/source/sdk_install.rst similarity index 100% rename from doc/playground-user-guide/source/sdk_install.rst rename to doc/user-guides/source/sdk_install.rst diff --git a/doc/playground-user-guide/source/sdk_manage_images.rst b/doc/user-guides/source/sdk_manage_images.rst similarity index 100% rename from doc/playground-user-guide/source/sdk_manage_images.rst rename to doc/user-guides/source/sdk_manage_images.rst diff --git a/doc/playground-user-guide/source/sdk_schedule_objects_for_deletion.rst b/doc/user-guides/source/sdk_schedule_objects_for_deletion.rst similarity index 100% rename from doc/playground-user-guide/source/sdk_schedule_objects_for_deletion.rst rename to doc/user-guides/source/sdk_schedule_objects_for_deletion.rst diff --git a/doc/playground-user-guide/source/trove-manage-db.rst b/doc/user-guides/source/trove-manage-db.rst similarity index 100% rename from doc/playground-user-guide/source/trove-manage-db.rst rename to doc/user-guides/source/trove-manage-db.rst diff --git a/doc/playground-user-guide/sphinx-ext/scope.py b/doc/user-guides/sphinx-ext/scope.py similarity index 100% rename from doc/playground-user-guide/sphinx-ext/scope.py rename to doc/user-guides/sphinx-ext/scope.py diff --git a/tools/build-user-guides.sh b/tools/build-user-guides.sh index 59e41f8528..830e62672d 100755 --- a/tools/build-user-guides.sh +++ b/tools/build-user-guides.sh @@ -2,11 +2,11 @@ echo "Building End User Guide" echo "=======================" -sphinx-build -t user_only -E -W doc/playground-user-guide/source/ doc/playground-user-guide/build/html +sphinx-build -t user_only -E -W doc/user-guides/source/ doc/user-guides/build/html echo "Building Admin User Guide" echo "=========================" -sphinx-build -t admin_only -E -W doc/playground-user-guide/source/ doc/playground-user-guide/build-admin/html +sphinx-build -t admin_only -E -W doc/user-guides/source/ doc/user-guides/build-admin/html # Cleanup: Rename index-html to index everywhere -mv doc/playground-user-guide/build-admin/html/index-admin.html doc/playground-user-guide/build-admin/html/index.html -sed -i -e 's/index-admin.html/index.html/g' doc/playground-user-guide/build-admin/html/*.html doc/playground-user-guide/build-admin/html/*/*.html +mv doc/user-guides/build-admin/html/index-admin.html doc/user-guides/build-admin/html/index.html +sed -i -e 's/index-admin.html/index.html/g' doc/user-guides/build-admin/html/*.html doc/user-guides/build-admin/html/*/*.html diff --git a/tools/generatepot-rst.sh b/tools/generatepot-rst.sh index ca570d1777..ed6f03222e 100755 --- a/tools/generatepot-rst.sh +++ b/tools/generatepot-rst.sh @@ -26,7 +26,7 @@ fi OPTS="" # We need to build guides with all tags so that all strings get # extracted. -if [ "$DOCNAME" = "playground-user-guide" ] ; then +if [ "$DOCNAME" = "user-guides" ] ; then OPTS="-t user_only -t admin_only" fi diff --git a/tox.ini b/tox.ini index efefc86ac4..52ff9db55d 100644 --- a/tox.ini +++ b/tox.ini @@ -45,12 +45,12 @@ commands = rsync -a www/static/ publish-docs/www/ # Build both RST User Guides {toxinidir}/tools/build-user-guides.sh - # Copy RST playground-user-guide - mkdir -p publish-docs/playground-user-guide/content/ - rsync -a doc/playground-user-guide/build/html/ publish-docs/playground-user-guide/content/ + # Copy RST user-guides + mkdir -p publish-docs/user-guides/content/ + rsync -a doc/user-guides/build/html/ publish-docs/user-guides/content/ # Copy RST user-guide-admincontent - mkdir -p publish-docs/playground-user-guide-admin/content/ - rsync -a doc/playground-user-guide/build-admin/html/ publish-docs/playground-user-guide-admin/content/ + mkdir -p publish-docs/user-guides-admin/content/ + rsync -a doc/user-guides/build-admin/html/ publish-docs/user-guides-admin/content/ # Build RST networking guide sphinx-build -E -W doc/networking-guide/source doc/networking-guide/build/html mkdir -p publish-docs/networking-guide/content/ @@ -110,7 +110,7 @@ commands = doc-tools-check-languages doc-tools-check-languages.conf publish all [testenv:generatepot-rst] # Generate POT files for translation, needs {posargs} like: -# tox -e generatepot-rst -- playground-user-guide +# tox -e generatepot-rst -- user-guides commands = {toxinidir}/tools/generatepot-rst.sh {posargs} [doc8]