Commit Graph
15 Commits
Author SHA1 Message Date
Sébastien Han f9f08c88ca docs: move the test readme to the official doc
The instructions to deploy a developer environment are useful and should
be part of the official documentation instead of being hidden in the
repo's README.md. Also, remove ancient documentation to deploy with
kubespray a multi-node env.
Also, add a warning to always run tests env in a virtual machine.

Closes: https://github.com/rook/rook/issues/9166
Signed-off-by: Sébastien Han <seb@redhat.com>
2021-11-23 15:56:28 +01:00
Travis Nielsen 0591753673 docs: update master doc links to latest
With the renaming of master docs to latest, all the links also
need to be updated.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2021-09-22 12:41:32 -06:00
subhamkrai 51910d0fed docs: updating according to the markdown convention
this commit update all the docs according to the
markdown convention for the command.

[skip ci]

Signed-off-by: subhamkrai <srai@redhat.com>
2021-03-05 10:45:04 +05:30
Jiffin Tony Thottan 0815899078 docs: provide link for crc documentation
CRC aka code ready containers provide openshift cluster 4.x in a single host machine
Signed-off-by: Jiffin Tony Thottan <thottanjiffin@gmail.com>
2020-08-19 22:49:32 +05:30
Alexander Trost c7afa0eb43 misc: docs: unified formatting and style
This is the first phase  miscellaneous part of three phases to improve and
rework the Rook documentation for better user accessibility to the Rook
projects and  with that the storage providers.
Phase two is about automatic generation of CRD documentation and phase
three is about reworking the docs themselves and, e.g., examples for
CRDs and certain use cases.

Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2019-11-01 18:13:27 +01:00
Travis NielsenandYaniv Kaul 42cccf3210 docs: remove comments on merged issues in dev guide
Both issues were already merged in Kubespray, so hopefully irrelevant anymore.

Co-authored-by: Yaniv Kaul <ykaul@redhat.com>
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2019-10-26 00:40:55 -06:00
giovanism 7e9403ccce docs: Update kubespray development-environment instructions
This is necessary as the current kubespray VM's dockerd engine
depreciated the --graph daemon option.

Signed-off-by: giovanism <giovanism@outlook.co.id>
2019-08-22 16:43:23 +07:00
Noah Watkins 647bb544a6 doc: add link to vagrant+libvirt setup
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2019-03-25 14:11:09 -07:00
Alexander Trost 64a9308d07 tests/scripts: Added basic k8s-vagrant-multi-node wrapper script
This adds a basic wrapper script around k8s-vagrant-multi-node project.

Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2019-03-18 15:30:31 +01:00
Dmitry Yusupov 90ad28475c add 00 to all the weights in *.md files
Signed-off-by: Dmitry Yusupov <dmitry@nexenta.com>
2019-02-04 09:46:00 -08:00
travisn 0524084592 docs: table of contents with a storage provider organization
Signed-off-by: travisn <tnielsen@redhat.com>
2018-12-08 08:07:03 -07:00
Yehuda Sadeh 6296b3daee docs: escape docker options
options collide with jekyll markup

Signed-off-by: Yehuda Sadeh <yehuda@redhat.com>
2018-05-23 14:51:42 -07:00
Dan Mick a22064c176 Add note about how to enable access to Dashboard
Signed-off-by: Dan Mick <dan.mick@redhat.com>
2018-03-23 18:35:50 -07:00
Dan Mick 33ba9a064e Document requirement for 'insecure-registries'
Signed-off-by: Dan Mick <dan.mick@redhat.com>
2018-02-26 13:12:36 -08:00
Sébastien Han 3c6fa79518 doc: add doc for multi-node setup and dev workflow
This commit adds instructions to develop on a multi-node deployment,
which is somehow similar to a production setup.
It also proposes a development workflow approach to
write/build/test/ship
code to Rook.

Signed-off-by: Sébastien Han <seb@redhat.com>
2018-02-21 17:45:49 +01:00