More compact README.rst
This file is included from the main documentation, so make it smaller. Remove a separate MISSION.rst, nobody is going to read it. Update the links to look more uniform. Change-Id: I9b88faaad5ad0ccc85a7660d8cd7e8d20f3ed120
This commit is contained in:
parent
d048a5f4c4
commit
5a76f5429b
@ -1,9 +0,0 @@
|
||||
Bifrost's Mission
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
The mission of bifrost is to provide an easy path to deploy ironic in
|
||||
a stand-alone fashion, in order to help facilitate the deployment of
|
||||
infrastucture, while also being a configurable project that can consume
|
||||
other OpenStack components to allow users to easily customize the
|
||||
environment to fit their needs, and drive forward the stand-alone
|
||||
perspective.
|
44
README.rst
44
README.rst
@ -1,37 +1,43 @@
|
||||
Bifrost
|
||||
-------
|
||||
|
||||
Bifrost (pronounced bye-frost) is a set of Ansible playbooks that
|
||||
automates the task of deploying a base image onto a set of known hardware using
|
||||
ironic. It provides modular utility for one-off operating system deployment
|
||||
with as few operational requirements as reasonably possible.
|
||||
|
||||
Team and repository tags:
|
||||
|
||||
.. image:: https://governance.openstack.org/tc/badges/bifrost.svg
|
||||
:target: https://governance.openstack.org/tc/reference/tags/index.html
|
||||
:alt: Team and repository tags
|
||||
|
||||
Use Cases
|
||||
~~~~~~~~~
|
||||
Bifrost (pronounced bye-frost) is a set of Ansible playbooks that
|
||||
automates the task of deploying a base image onto a set of known hardware using
|
||||
ironic_. It provides modular utility for one-off operating system deployment
|
||||
with as few operational requirements as reasonably possible.
|
||||
|
||||
The mission of bifrost is to provide an easy path to deploy ironic in
|
||||
a stand-alone fashion, in order to help facilitate the deployment of
|
||||
infrastucture, while also being a configurable project that can consume
|
||||
other OpenStack components to allow users to easily customize the
|
||||
environment to fit their needs, and drive forward the stand-alone
|
||||
perspective.
|
||||
|
||||
Use cases include:
|
||||
|
||||
* Installation of ironic in standalone/noauth mode without other OpenStack
|
||||
components.
|
||||
* Deployment of an operating system to a known pool of hardware as
|
||||
a batch operation.
|
||||
* Testing and development of ironic in a standalone use case.
|
||||
* Testing and development of ironic in the standalone mode.
|
||||
|
||||
Documentation
|
||||
~~~~~~~~~~~~~
|
||||
.. _ironic: https://docs.openstack.org/ironic/latest/
|
||||
|
||||
Bifrost's documentation can be found at the
|
||||
`OpenStack documentation site <https://docs.openstack.org/bifrost/latest>`_.
|
||||
Useful Links
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Bifrost's documentation can be found at:
|
||||
https://docs.openstack.org/bifrost/latest
|
||||
|
||||
Release notes are at:
|
||||
https://docs.openstack.org/releasenotes/bifrost/
|
||||
|
||||
The project source code repository is located at:
|
||||
https://opendev.org/openstack/bifrost/
|
||||
|
||||
Bugs can be filed in storyboard:
|
||||
https://storyboard.openstack.org/#!/project/941
|
||||
|
||||
Release notes
|
||||
~~~~~~~~~~~~~
|
||||
https://docs.openstack.org/releasenotes/bifrost/
|
||||
https://storyboard.openstack.org/#!/project/openstack/bifrost
|
||||
|
@ -3,8 +3,6 @@ Welcome to bifrost's documentation!
|
||||
|
||||
.. include:: ../../README.rst
|
||||
|
||||
.. include:: ../../MISSION.rst
|
||||
|
||||
Contents
|
||||
--------
|
||||
|
||||
|
2
tox.ini
2
tox.ini
@ -27,7 +27,7 @@ deps =
|
||||
pycodestyle>=2.0.0,<2.7.0 # MIT
|
||||
commands =
|
||||
flake8 {posargs}
|
||||
doc8 doc/source releasenotes/source README.rst CONTRIBUTING.rst MISSION.rst HACKING.rst
|
||||
doc8 doc/source releasenotes/source README.rst CONTRIBUTING.rst HACKING.rst
|
||||
|
||||
[testenv:venv]
|
||||
commands = {posargs}
|
||||
|
Loading…
Reference in New Issue
Block a user