openstack/openstack-helm
Code Issues Proposed changes
f19f0873f0
openstack-helm/README.rst

47 lines
1.7 KiB
ReStructuredText
Raw Normal View History

Beggining of docs conversion to OpenStack format This commit introduces initial infrastructure for building documentation using the OpenStack's sphinx extension and tox. To demonstrate that README.md is rewritten into README.rst and should appear in documentation built by `tox -e docs`. Partial-Implements: blueprint docs-to-rst Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
2017-04-27 11:01:26 +02:00
==============
Update kubeadm-aio install docs This clarifies some of the steps in the kubeadm-aio guide, which includes: adding minimum suggested system specs, commands to verify success of a helm chart installation, and general clean up and reformatting of the docs Change-Id: I3f8cac9de7940970754e09bedf4d1d37022e7255
2017-07-03 15:06:13 -05:00
OpenStack-Helm
Beggining of docs conversion to OpenStack format This commit introduces initial infrastructure for building documentation using the OpenStack's sphinx extension and tox. To demonstrate that README.md is rewritten into README.rst and should appear in documentation built by `tox -e docs`. Partial-Implements: blueprint docs-to-rst Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
2017-04-27 11:01:26 +02:00
==============
Mission
-------
Docs: true-up to recent changes A few doc edits so that they're in sync with the OSH mission statement, helm-toolkit conventions, and project doc location. Change-Id: I33ccc39cd84fab3b537ad93970c21cf9065044e9
2017-11-05 10:06:46 -06:00
The goal of OpenStack-Helm is to provide a collection of Helm charts that
simply, resiliently, and flexibly deploy OpenStack and related services
on Kubernetes.
Beggining of docs conversion to OpenStack format This commit introduces initial infrastructure for building documentation using the OpenStack's sphinx extension and tox. To demonstrate that README.md is rewritten into README.rst and should appear in documentation built by `tox -e docs`. Partial-Implements: blueprint docs-to-rst Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
2017-04-27 11:01:26 +02:00
Communication
-------------
Openstack-helm broken links in main README Main README for https://github.com/openstack/openstack-helm have several broken links at the bottom of the page. The following links were corrected "Installation, Minikube, Bare Metal" plus Slack link were corrected on branch bug/1688301 Replace minikube with kubeadm-aio install Change-Id: Ib5f76683c26f92ca12104fcbab644b51c64e1f8f Closes-Bug: #1688301
2017-05-04 12:01:53 -04:00
* Join us on `Slack <https://kubernetes.slack.com/messages/C3WERB7DE/>`_ - #openstack-helm
Beggining of docs conversion to OpenStack format This commit introduces initial infrastructure for building documentation using the OpenStack's sphinx extension and tox. To demonstrate that README.md is rewritten into README.rst and should appear in documentation built by `tox -e docs`. Partial-Implements: blueprint docs-to-rst Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
2017-04-27 11:01:26 +02:00
* Join us on `IRC <irc://chat.freenode.net:6697/openstack-helm>`_:
#openstack-helm on freenode
* Community IRC Meetings: [Every Tuesday @ 3PM UTC],
#openstack-meeting-5 on freenode
* Meeting Agenda Items: `Agenda
<https://etherpad.openstack.org/p/openstack-helm-meeting-agenda>`_
Update README Updates the README with links to blueprints, bugs, and removes redundant information. Also updates references to evaluating openstack-helm Change-Id: I2d5dcba8e73bc91d35411584b9d649e4d6fdbcf7
2017-07-03 10:59:19 -05:00
Launchpad
---------
Bugs and blueprints are tracked via OpenStack-Helm's Launchpad.
Beggining of docs conversion to OpenStack format This commit introduces initial infrastructure for building documentation using the OpenStack's sphinx extension and tox. To demonstrate that README.md is rewritten into README.rst and should appear in documentation built by `tox -e docs`. Partial-Implements: blueprint docs-to-rst Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
2017-04-27 11:01:26 +02:00
Update README Updates the README with links to blueprints, bugs, and removes redundant information. Also updates references to evaluating openstack-helm Change-Id: I2d5dcba8e73bc91d35411584b9d649e4d6fdbcf7
2017-07-03 10:59:19 -05:00
* `Bugs <https://bugs.launchpad.net/openstack-helm>`_
* `Blueprints <https://blueprints.launchpad.net/openstack-helm>`_
Beggining of docs conversion to OpenStack format This commit introduces initial infrastructure for building documentation using the OpenStack's sphinx extension and tox. To demonstrate that README.md is rewritten into README.rst and should appear in documentation built by `tox -e docs`. Partial-Implements: blueprint docs-to-rst Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
2017-04-27 11:01:26 +02:00
Installation and Development
----------------------------
Docs: true-up to recent changes A few doc edits so that they're in sync with the OSH mission statement, helm-toolkit conventions, and project doc location. Change-Id: I33ccc39cd84fab3b537ad93970c21cf9065044e9
2017-11-05 10:06:46 -06:00
Please review our `documentation <https://docs.openstack.org/openstack-helm>`_.
Readme: fix broken link and add gate link. This PS removes a broken link in the Readme, and adds an extra link to the gate scripts. Change-Id: I92ec8e6d8ba68c26d58af1e338f9aee893a1bf38
2017-07-09 10:39:02 -05:00
For quick installation, evaluation, and convenience, we have a kubeadm
Update README Updates the README with links to blueprints, bugs, and removes redundant information. Also updates references to evaluating openstack-helm Change-Id: I2d5dcba8e73bc91d35411584b9d649e4d6fdbcf7
2017-07-03 10:59:19 -05:00
based all-in-one solution that runs in a Docker container. The Kubeadm-AIO set
Fix dead link for AIO guide With the recent changes to the AIO guide[0] the link in the readme now sends to a non-existing page. This change updates the link and removes an extra comma in the link text. [0] https://review.openstack.org/#/c/534408/ Change-Id: I19fae9b4733909fceb7481a8408d376b27516178
2018-01-19 10:06:18 -06:00
up can be found `here <https://docs.openstack.org/openstack-helm/latest/install/developer/index.html>`_.
Update README Updates the README with links to blueprints, bugs, and removes redundant information. Also updates references to evaluating openstack-helm Change-Id: I2d5dcba8e73bc91d35411584b9d649e4d6fdbcf7
2017-07-03 10:59:19 -05:00
This project is under active development. We encourage anyone interested in
Docs: true-up to recent changes A few doc edits so that they're in sync with the OSH mission statement, helm-toolkit conventions, and project doc location. Change-Id: I33ccc39cd84fab3b537ad93970c21cf9065044e9
2017-11-05 10:06:46 -06:00
OpenStack-Helm to review our `Installation <https://docs.openstack.org/openstack-helm/latest/install/index.html>`_
Readme: fix broken link and add gate link. This PS removes a broken link in the Readme, and adds an extra link to the gate scripts. Change-Id: I92ec8e6d8ba68c26d58af1e338f9aee893a1bf38
2017-07-09 10:39:02 -05:00
documentation. Feel free to ask questions or check out our current
`Issues and Bugs <https://bugs.launchpad.net/openstack-helm>`_.
Openstack-helm broken links in main README Main README for https://github.com/openstack/openstack-helm have several broken links at the bottom of the page. The following links were corrected "Installation, Minikube, Bare Metal" plus Slack link were corrected on branch bug/1688301 Replace minikube with kubeadm-aio install Change-Id: Ib5f76683c26f92ca12104fcbab644b51c64e1f8f Closes-Bug: #1688301
2017-05-04 12:01:53 -04:00
Update README Updates the README with links to blueprints, bugs, and removes redundant information. Also updates references to evaluating openstack-helm Change-Id: I2d5dcba8e73bc91d35411584b9d649e4d6fdbcf7
2017-07-03 10:59:19 -05:00
To evaluate a multinode installation, follow the
Docs: true-up to recent changes A few doc edits so that they're in sync with the OSH mission statement, helm-toolkit conventions, and project doc location. Change-Id: I33ccc39cd84fab3b537ad93970c21cf9065044e9
2017-11-05 10:06:46 -06:00
`Bare Metal <https://docs.openstack.org/openstack-helm/latest/install/multinode.html>`_
Docs: Update Readme links to point to ReadtheDocs Followinf dicussion on Slack it was apparent that the readme was not pointing to our current docs - this ps rectifies that. Change-Id: I5b047105e8ad2422f3df93653f1a87fdf1c77d24
2017-05-23 18:38:26 -05:00
install guide.
Copy Permalink