From dc16d6588fae468de137541142d5d0b85b9fddc3 Mon Sep 17 00:00:00 2001 From: yangsngshaoxue Date: Tue, 13 Sep 2022 09:45:20 +0800 Subject: [PATCH] docs: update development guide Delete redundant article sections Change-Id: I2e51aeba37f3789ef2315b4a4d4f541ff81e947d --- doc/source/admin/index.rst | 2 ++ .../skyline-console-settings.rst | 22 +++++++++++-------- doc/source/development/how-to-develop.rst | 2 -- doc/source/development/index.rst | 1 - doc/source/glossary.rst | 2 +- doc/source/index.rst | 5 ----- doc/source/install/source-install-ubuntu.rst | 8 +++---- doc/source/test/how-to-edit-e2e-case.rst | 18 --------------- 8 files changed, 20 insertions(+), 40 deletions(-) delete mode 100644 doc/source/development/how-to-develop.rst diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index 03f7a2be..213ab09b 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -13,5 +13,7 @@ operate by users, and has higher concurrency performance. identity For more information about dashboard, see :ref:`skyline-dashboard`. + To deploy skyline, see :ref:`skyline-installation-guide`. + To configure skyline, see :ref:`skyline-settings`. diff --git a/doc/source/configuration/skyline-console-settings.rst b/doc/source/configuration/skyline-console-settings.rst index b566d45a..5bc2bfc9 100644 --- a/doc/source/configuration/skyline-console-settings.rst +++ b/doc/source/configuration/skyline-console-settings.rst @@ -4,9 +4,11 @@ Skyline Console Settings Reference ================================== -- Prepare a usable backend - - Prepare an accessible backend, for example: `https://172.20.154.250` - - Modify the corresponding configuration in `config/webpack.dev.js`: +- Prepare a usable backend + + - Prepare an accessible backend, for example: ``https://172.20.154.250`` + + - Modify the corresponding configuration in ``config/webpack.dev.js``: .. code:: javascript @@ -20,9 +22,11 @@ Skyline Console Settings Reference }; } -- Configure access host and port - - Modify `devServer.host` and `devServer.port` - - Modify the corresponding configuration in `config/webpack.dev.js` +- Configure access host and port + + - Modify ``devServer.host`` and ``devServer.port`` + + - Modify the corresponding configuration in ``config/webpack.dev.js`` .. code:: javascript @@ -39,12 +43,12 @@ Skyline Console Settings Reference // progress: true }; -- Execute in the project root directory, which is the same level as `package.json` +- Execute in the project root directory, which is the same level as ``package.json`` .. code:: shell yarn run dev +- Use the ``host`` and ``port`` configured in ``config/webpack.dev.js`` to access, such as ``http://localhost:8088`` -- Use the `host` and `port` configured in `config/webpack.dev.js` to access, such as `http://localhost:8088` -- The front-end real-time update environment used for development is done. +- The front-end real-time update environment used for development is done. diff --git a/doc/source/development/how-to-develop.rst b/doc/source/development/how-to-develop.rst deleted file mode 100644 index 8878c880..00000000 --- a/doc/source/development/how-to-develop.rst +++ /dev/null @@ -1,2 +0,0 @@ -How To Develop -~~~~~~~~~~~~~~~ diff --git a/doc/source/development/index.rst b/doc/source/development/index.rst index a431bd77..a15fdb91 100644 --- a/doc/source/development/index.rst +++ b/doc/source/development/index.rst @@ -8,4 +8,3 @@ This section describes how to develop the Skyline Console. ready-to-work catalog-introduction - how-to-develop diff --git a/doc/source/glossary.rst b/doc/source/glossary.rst index a65818e4..4004e439 100644 --- a/doc/source/glossary.rst +++ b/doc/source/glossary.rst @@ -5,4 +5,4 @@ Glossary ======== This glossary offers a list of terms and definitions to define a - vocabulary for Skyline Console concepts. +vocabulary for Skyline Console concepts. diff --git a/doc/source/index.rst b/doc/source/index.rst index 5fe8d5d0..d5adec96 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -57,8 +57,3 @@ Information :maxdepth: 1 glossary - -.. only:: html - - * :ref:`genindex` - * :ref:`modindex` diff --git a/doc/source/install/source-install-ubuntu.rst b/doc/source/install/source-install-ubuntu.rst index d69b0827..10644c87 100644 --- a/doc/source/install/source-install-ubuntu.rst +++ b/doc/source/install/source-install-ubuntu.rst @@ -96,9 +96,9 @@ We will install the Skyline Console service from source code. Finalize installation --------------------- -#. Start nginx service +Start nginx service - .. code-block:: shell +.. code-block:: shell - sudo systemctl start nginx.service - sudo systemctl enable nginx.service + sudo systemctl start nginx.service + sudo systemctl enable nginx.service diff --git a/doc/source/test/how-to-edit-e2e-case.rst b/doc/source/test/how-to-edit-e2e-case.rst index 2e88526d..80a2677f 100644 --- a/doc/source/test/how-to-edit-e2e-case.rst +++ b/doc/source/test/how-to-edit-e2e-case.rst @@ -132,21 +132,3 @@ account as clean as possible after the test case is executed .. code-block:: javascript cy.deleteAllAvailableVolume(); - -Reference ----------- - -- The function operation form in ``test/e2e/support/form-commands.js``, - please refer to the detailed introduction - -- The functions in ``test/e2e/support/table-commands.js``, - click on the buttons in the operation table, search, and enter for details. - please refer to the detailed introduction - -- The functions in ``test/e2e/support/detail-commands.js``, the operation - returns the list page, the detection details, and the switching details Tab. - please refer to the detailed introduction - -Create and delete associated resources mainly use the functions in -``test/e2e/support/resource-commands.js``, please refer to the detailed -introduction