diff --git a/README.rst b/README.rst index f4b35556..7613d6b0 100644 --- a/README.rst +++ b/README.rst @@ -4,81 +4,44 @@ Skyline (OpenStack Modern Dashboard) Skyline Console is a modern dashboard for OpenStack - UI. -- `Documentation `__ -- `Installing Guide `__ -- `Issue tracking: `__ -- `Release notes: `__ -- `Wiki `__ +* Project documentation: https://docs.openstack.org/skyline-console/latest/ +* Release management: https://launchpad.net/skyline-console +* Installing Guide: https://docs.openstack.org/skyline-console/latest/install/ +* Issue tracking: https://launchpad.net/skyline-console +* Release notes: https://docs.openstack.org/releasenotes/skyline-console/ +* Wiki: https://wiki.openstack.org/wiki/Skyline .. image:: https://governance.openstack.org/tc/badges/skyline-console.svg :target: https://governance.openstack.org/tc/reference/tags/ -Instructions ------------- - -`简体中文 <./README/README-zh_CN.rst>`__ \| English \| `한국어 <./README/README-ko_KR.rst>`__ - -**Table of contents** - -- `Instructions <#instructions>`__ - - - `Using Skyline <#usingskyline>`__ - - `Docs <#docs>`__ - - - `How to develop <#how-to-develop>`__ - - `How to test <#how-to-test>`__ - Using Skyline -------------- +============= -See doc/source/install/index.rst about how to install Skyline in your OpenStack setup. It describes the example steps and has pointers for more detailed settings and configurations. +See ``doc/source/install/index.rst`` about how to install Skyline in your OpenStack setup. It describes the example steps and has pointers for more detailed settings and configurations. -It is also available at `Installing Guide `__. +It is also available at `Installing Guide `__. -Docs ----- +Getting Started for Developers +============================== -How to develop -~~~~~~~~~~~~~~ +`Development Guide `_ +describes how to setup Skyline development environment and start development. -- `Preparation before - development `__ -- `Directory structure `__ -- `Develop a new resource - page `__ -- `BaseList - introduction `__ -- `BaseTabList - introduction `__ -- `BaseDetail - introduction `__ -- `BaseDetailInfo - introduction `__ -- `BaseStore - introduction `__ -- `FormAction - introduction `__ -- `ModalAction - introduction `__ -- `ConfirmAction - introduction `__ -- `StepAction - introduction `__ -- `FormItem - introduction `__ -- `Action introduction `__ -- `Menu introduction `__ -- `Route introduction `__ -- `I18n introduction `__ +Building Contributor Documentation +================================== -How to test -~~~~~~~~~~~ +This documentation is written by contributors, for contributors. -- `Two kinds of tests `__ -- `Directory structure `__ -- `How to edit e2e case `__ -- `E2E - Form operation `__ -- `E2E - Table operation `__ -- `E2E - Detail operation `__ -- `E2E - Resource - operation `__ +The source is maintained in the ``doc/source`` directory using +`reStructuredText`_ and built by `Sphinx`_ + +.. _reStructuredText: https://docutils.sourceforge.net/rst.html +.. _Sphinx: https://sphinx-doc.org/ + +Some of the diagrams are generated using the ``dot`` language + from Graphviz. See the `Graphviz documentation `_ + for Graphviz and dot language usage information. + +To build the docs, use:: + + $ tox -e docs diff --git a/doc/README.rst b/doc/README.rst deleted file mode 100644 index 9e4bf81c..00000000 --- a/doc/README.rst +++ /dev/null @@ -1,33 +0,0 @@ -================================ -Skyline Console Development Docs -================================ - -Files under this directory tree are used for generating the documentation -for the skyline-console source code. - -Developer documentation is built to: -https://docs.openstack.org/skyline-console/latest/ - -Tools -===== - -Sphinx - The Python Sphinx package is used to generate the documentation output. - Information on Sphinx, including formatting information for RST source - files, can be found in the `Sphinx online documentation - `_. - -Graphviz - Some of the diagrams are generated using the ``dot`` language - from Graphviz. See the `Graphviz documentation `_ - for Graphviz and dot language usage information. - - -Building Documentation -====================== - -Doc builds are performed using tox with the ``docs`` target:: - - % cd .. - % tox -e docs -