From 9fbd2ae95ec5426c144b16fb4eb949c2fe4fb121 Mon Sep 17 00:00:00 2001 From: yangsngshaoxue Date: Fri, 26 Aug 2022 17:55:03 +0800 Subject: [PATCH] docs: Add admin and user guide Add admin and user guide Change-Id: I6f8e81c85c80fc20a875c453554627db800f9a1b --- doc/source/admin/compute.rst | 17 +++++++++++++ doc/source/admin/dashboard.rst | 5 ++++ doc/source/admin/identity.rst | 29 ++++++++++++++++++++++ doc/source/admin/index.rst | 13 +++++++++- doc/source/admin/skyline-configuration.rst | 2 ++ doc/source/admin/storage.rst | 8 ++++++ doc/source/development/index.rst | 6 +++++ doc/source/index.rst | 2 ++ doc/source/install/installing-guide.rst | 2 ++ doc/source/test/index.rst | 6 +++++ doc/source/user/compute.rst | 23 +++++++++++++++++ doc/source/user/dashboard.rst | 8 ++++++ doc/source/user/index.rst | 10 +++++--- doc/source/user/network.rst | 17 +++++++++++++ doc/source/user/storage.rst | 20 +++++++++++++++ doc/source/user/supported-browsers.rst | 2 ++ 16 files changed, 166 insertions(+), 4 deletions(-) create mode 100644 doc/source/admin/compute.rst create mode 100644 doc/source/admin/dashboard.rst create mode 100644 doc/source/admin/identity.rst create mode 100644 doc/source/admin/skyline-configuration.rst create mode 100644 doc/source/admin/storage.rst create mode 100644 doc/source/development/index.rst create mode 100644 doc/source/test/index.rst create mode 100644 doc/source/user/compute.rst create mode 100644 doc/source/user/dashboard.rst create mode 100644 doc/source/user/network.rst create mode 100644 doc/source/user/storage.rst create mode 100644 doc/source/user/supported-browsers.rst diff --git a/doc/source/admin/compute.rst b/doc/source/admin/compute.rst new file mode 100644 index 00000000..91e89467 --- /dev/null +++ b/doc/source/admin/compute.rst @@ -0,0 +1,17 @@ +Manage instances (Compute) +========================== + +Manage compute nodes +-------------------- + +Create a flavor +--------------- + +Delete a flavor +--------------- + +Create a host aggregate +----------------------- + +Manage host aggregates +---------------------- diff --git a/doc/source/admin/dashboard.rst b/doc/source/admin/dashboard.rst new file mode 100644 index 00000000..835e795c --- /dev/null +++ b/doc/source/admin/dashboard.rst @@ -0,0 +1,5 @@ +Openstack Dashboard +==================== + +Administrator tab +------------------ diff --git a/doc/source/admin/identity.rst b/doc/source/admin/identity.rst new file mode 100644 index 00000000..9dfeb994 --- /dev/null +++ b/doc/source/admin/identity.rst @@ -0,0 +1,29 @@ +Manage projects, users and roles(Identity) +========================================== + +Create a role +------------- + +Edit a role +----------- + +Delete a role +-------------- + +Add a new project +----------------- + +Delete a project +---------------- + +Update a project +---------------- + +Add a new user +--------------- + +Delete a new user +----------------- + +Update a user +------------- diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index b4910e54..89c10779 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -2,5 +2,16 @@ Administration Guide ==================== +Skyline is an OpenStack dashboard optimized by UI and UE. It has a modern +technology stack and ecology, is easier for developers to maintain and +operate by users, and has higher concurrency performance. + .. toctree:: - :maxdepth: 1 + + skyline-configuration + dashboard + compute + storage + identity + +To deploy skyline, see :ref:`skyline-installation-guide`. diff --git a/doc/source/admin/skyline-configuration.rst b/doc/source/admin/skyline-configuration.rst new file mode 100644 index 00000000..b9166494 --- /dev/null +++ b/doc/source/admin/skyline-configuration.rst @@ -0,0 +1,2 @@ +Skyline Configuration +===================== diff --git a/doc/source/admin/storage.rst b/doc/source/admin/storage.rst new file mode 100644 index 00000000..925e7969 --- /dev/null +++ b/doc/source/admin/storage.rst @@ -0,0 +1,8 @@ +Manage volumes (Storage) +======================== + +Create a volume type +-------------------- + +Delete a volume type +-------------------- diff --git a/doc/source/development/index.rst b/doc/source/development/index.rst new file mode 100644 index 00000000..e733512c --- /dev/null +++ b/doc/source/development/index.rst @@ -0,0 +1,6 @@ +================== +Development Guide +================== + +.. toctree:: + :maxdepth: 1 diff --git a/doc/source/index.rst b/doc/source/index.rst index 74016e75..5fe8d5d0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -42,6 +42,8 @@ Contributor Docs :maxdepth: 2 contributor/index + development/index + test/index Release Notes ============= diff --git a/doc/source/install/installing-guide.rst b/doc/source/install/installing-guide.rst index f59891f0..dbdce500 100644 --- a/doc/source/install/installing-guide.rst +++ b/doc/source/install/installing-guide.rst @@ -1,3 +1,5 @@ +.. _skyline-installation-guide: + ===================================== Skyline Installation Guide for Ubuntu ===================================== diff --git a/doc/source/test/index.rst b/doc/source/test/index.rst new file mode 100644 index 00000000..5b623afa --- /dev/null +++ b/doc/source/test/index.rst @@ -0,0 +1,6 @@ +=========== +Tests Guide +=========== + +.. toctree:: + :maxdepth: 1 diff --git a/doc/source/user/compute.rst b/doc/source/user/compute.rst new file mode 100644 index 00000000..a911f434 --- /dev/null +++ b/doc/source/user/compute.rst @@ -0,0 +1,23 @@ +Launch and manage instances (Compute) +===================================== + +Upload an image +--------------- + +Import a key pair +----------------- + +Launch an instance +------------------ + +Create an instance snapshot +---------------------------- + +Manage an instance +------------------ + +Allocate a floating IP address to an instance +---------------------------------------------- + +Connect to instance by using SSH +--------------------------------- diff --git a/doc/source/user/dashboard.rst b/doc/source/user/dashboard.rst new file mode 100644 index 00000000..706b0306 --- /dev/null +++ b/doc/source/user/dashboard.rst @@ -0,0 +1,8 @@ +Openstack Dashboard +=================== + +User tab +-------- + +Console tab +----------- diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 8fcc7e0f..3fffeb12 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -1,6 +1,10 @@ -======================================== +================== User Documentation -======================================== +================== .. toctree:: - :maxdepth: 1 + dashboard + network + compute + storage + supported-browsers diff --git a/doc/source/user/network.rst b/doc/source/user/network.rst new file mode 100644 index 00000000..ff223029 --- /dev/null +++ b/doc/source/user/network.rst @@ -0,0 +1,17 @@ +Create and manage networks +=========================== + +create a network +---------------- + +create a router +---------------- + +create a port +-------------- + +create a fip +------------- + +create a security group +------------------------ diff --git a/doc/source/user/storage.rst b/doc/source/user/storage.rst new file mode 100644 index 00000000..8c64d67b --- /dev/null +++ b/doc/source/user/storage.rst @@ -0,0 +1,20 @@ +Create and manage volumes (Storage) +=================================== + +Create a volume +---------------- + +Attach a volume to an instance +------------------------------- + +Detach a volume from an instance +-------------------------------- + +Create a snapshot from a volume +-------------------------------- + +Edit a volume +-------------- + +Delete a volume +---------------- diff --git a/doc/source/user/supported-browsers.rst b/doc/source/user/supported-browsers.rst new file mode 100644 index 00000000..1a9b3664 --- /dev/null +++ b/doc/source/user/supported-browsers.rst @@ -0,0 +1,2 @@ +Supported Browsers +==================