====================================
Skyline (OpenStack Modern Dashboard)
====================================

Skyline Console is a modern dashboard for OpenStack - UI.

-  `Documentation <https://docs.openstack.org/skyline-console/latest/index.html>`__
-  `Installing Guide <https://docs.openstack.org/skyline-console/latest/install/index.html>`__
-  `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.

It is also available at `Installing Guide <https://docs.openstack.org/skyline-console/latest/install/index.html>`__.

Docs
----

How to develop
~~~~~~~~~~~~~~

-  `Preparation before
   development <docs/en/develop/1-ready-to-work.md>`__
-  `Directory structure <docs/en/develop/2-catalog-introduction.md>`__
-  `Develop a new resource
   page <docs/en/develop/3-0-how-to-develop.md>`__
-  `BaseList
   introduction <docs/en/develop/3-1-BaseList-introduction.md>`__
-  `BaseTabList
   introduction <docs/en/develop/3-2-BaseTabList-introduction.md>`__
-  `BaseDetail
   introduction <docs/en/develop/3-3-BaseDetail-introduction.md>`__
-  `BaseDetailInfo
   introduction <docs/en/develop/3-4-BaseDetailInfo-introduction.md>`__
-  `BaseStore
   introduction <docs/en/develop/3-5-BaseStore-introduction.md>`__
-  `FormAction
   introduction <docs/en/develop/3-6-FormAction-introduction.md>`__
-  `ModalAction
   introduction <docs/en/develop/3-7-ModalAction-introduction.md>`__
-  `ConfirmAction
   introduction <docs/en/develop/3-8-ConfirmAction-introduction.md>`__
-  `StepAction
   introduction <docs/en/develop/3-9-StepAction-introduction.md>`__
-  `FormItem
   introduction <docs/en/develop/3-10-FormItem-introduction.md>`__
-  `Action introduction <docs/en/develop/3-11-Action-introduction.md>`__
-  `Menu introduction <docs/en/develop/3-12-Menu-introduction.md>`__
-  `Route introduction <docs/en/develop/3-13-Route-introduction.md>`__
-  `I18n introduction <docs/en/develop/3-14-I18n-introduction.md>`__

How to test
~~~~~~~~~~~

-  `Two kinds of tests <docs/en/test/1-ready-to-work.md>`__
-  `Directory structure <docs/en/test/2-catalog-introduction.md>`__
-  `How to edit e2e case <docs/en/test/3-0-how-to-edit-e2e-case.md>`__
-  `E2E - Form operation <docs/en/test/3-1-E2E-form-operation.md>`__
-  `E2E - Table operation <docs/en/test/3-2-E2E-table-operation.md>`__
-  `E2E - Detail operation <docs/en/test/3-3-E2E-detail-operation.md>`__
-  `E2E - Resource
   operation <docs/en/test/3-4-E2E-resource-operation.md>`__