Provide references to new docs

Story: 2001058
Task: 4779

Change-Id: I95bab9bc3262fb32e648e9fcce37bf87bdcbd918
This commit is contained in:
Tomasz Trębski 2017-07-03 21:11:36 +02:00 committed by Tomasz Trębski
parent 6b0dbac6d8
commit 94885f91a9
7 changed files with 100 additions and 6 deletions

21
CONTRIBUTING.rst Normal file
View File

@ -0,0 +1,21 @@
If you would like to contribute to the development of OpenStack,
you must follow the steps documented at:
http://docs.openstack.org/infra/manual/developers.html#getting-started
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
http://docs.openstack.org/infra/manual/developers.html#development-workflow
Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Storyboard (using tag **bug**), not GitHub:
https://storyboard.openstack.org/#!/project/869
Additionally, specific guidelines for contributing to Monasca-Log-Api may be found in
Monasca-Log-Api's Documentation:
https://docs.openstack.org/monasca-log-api/latest/contributor/

5
HACKING.rst Normal file
View File

@ -0,0 +1,5 @@
monasca-log-api Style Commandments
==================================
- Step 1: Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/
- Step 2: Read on

67
README.rst Normal file
View File

@ -0,0 +1,67 @@
========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/badges/monasca-log-api.svg
:target: https://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
OpenStack Monasca-Log-Api
=========================
OpenStack Monasca-Log-Api provides RESTful Api to collect logs
from the OpenStack cloud.
OpenStack Monasca-Log-Api is distributed under the terms of the Apache
License, Version 2.0. The full terms and conditions of this
license are detailed in the LICENSE file.
Api
---
To learn how to use Monasca-Log-Api, consult the documentation
available online at:
* `Api Guide <https://developer.openstack.org/api-guide/monitoring-log-api/>`_
* `Api Ref <https://developer.openstack.org/api-ref/monitoring-log-api/>`_
For more information on OpenStack Apis, SDKs and CLIs,
please see:
* `OpenStack Application Development <https://www.openstack.org/appdev/>`_
* `OpenStack Developer Documentation <https://developer.openstack.org/>`_
Developers
----------
For information on how to contribute to Monasca-Log-Api, please see the
contents of the CONTRIBUTING.rst.
Any new code must follow the development guidelines detailed
in the HACKING.rst file, and pass all unit tests as well as linters.
Further developer focused documentation is available at:
* `Openstack Monasca-Log-Api <https://docs.openstack.org/developer/monasca-log-api/>`_
Operators
---------
To learn how to deploy and configure OpenStack Monasca-Log-Api, consult the
documentation available online at:
* `Installation <https://docs.openstack.org/monasca-log-api/latest/install/>`_
* `Configuration <https://docs.openstack.org/monasca-log-api/latest/configuration/>`_
Bug tracking
------------
In the unfortunate event that bugs are discovered, they should
be reported to the appropriate bug tracker. If you obtained
the software from a 3rd party operating system vendor, it is
often wise to use their own bug tracker for reporting problems.
In all other cases use the master OpenStack bug tracker,
available at:
* `Storyboard <https://storyboard.openstack.org/#!/project/869>`_

View File

@ -1,8 +1,8 @@
.. _configuring:
=====================================
Monasca Log Api Configuration Options
=====================================
============
Cofiguration
============
This section provides a list of all possible options for each
configuration file. Refer to :ref:`basic-configuration` for a

View File

@ -1,5 +1,6 @@
Monasca Log Contribution Guidelines
===================================
=======================
Contribution Guidelines
=======================
In the Contributions Guide, you will find documented policies for
developing with monasca-log. This includes the processes we use for

View File

@ -2,7 +2,7 @@
name = monasca-log-api
summary = Monasca API for sending log entries
description-file =
README.md
README.rst
author = OpenStack
author-email = openstack-dev@lists.openstack.org
home-page = https://github.com/openstack/monasca-log-api