New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

begin rhv guides #50514

Open
wants to merge 3 commits into
base: devel
from

Conversation

Projects
None yet
6 participants
@funixz
Copy link
Contributor

funixz commented Jan 3, 2019

just like there's a vmware guide ;)

SUMMARY

starting a guide section for RHV/ oVirt just like there is one for VMware

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

RHV guide section in the docs.

ADDITIONAL INFORMATION

Just adding docs to match up content for RHV for what there is about VMware.

N/A

Note that this is an initial commit... more commits to come via this fork/branch,
If there's a better way to move this into the docs, please let me know.

funixz added some commits Jan 3, 2019

placeholder to begin rhv guides
just like there's a vmware guide ;)
@ansibot

This comment has been minimized.

Copy link
Contributor

ansibot commented Jan 3, 2019

The test ansible-test sanity --test docs-build [explain] failed with 31 errors:

docs/docsite/rst/index.rst:0:0: unknown: 
docs/docsite/rst/index.rst:0:0: unknown: 
docs/docsite/rst/index.rst:0:0: unknown: 
docs/docsite/rst/index.rst:0:0: unknown: ******************************
docs/docsite/rst/index.rst:0:0: unknown: ******************************
docs/docsite/rst/index.rst:0:0: unknown: ------------------------------------------------------------
docs/docsite/rst/index.rst:0:0: unknown: ------------------------------------------------------------
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone RHV Host server ?
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone RHV Host server ?
docs/docsite/rst/index.rst:0:0: unknown: List of useful links for RHV/ oVirt
docs/docsite/rst/rhv/faq.rst:24:0: warning: Title underline too short.
docs/docsite/rst/rhv/faq.rst:24:0: warning: Title underline too short.
docs/docsite/rst/rhv/index.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_concepts'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_external_doc_links'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_getting_started'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_intro'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_module_reference'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_requirements'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_scenarios'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_troubleshooting'
docs/docsite/rst/rhv/rhv_concepts.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/rhv_concepts.rst:29:0: definition-list-missing-blank-line: Definition list ends without a blank line; unexpected unindent.
docs/docsite/rst/rhv/rhv_concepts.rst:48:0: unexpected-indentation: Unexpected indentation.
docs/docsite/rst/rhv/rhv_external_doc_links.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/rhv_external_doc_links.rst:3:0: warning: Title overline too short.
docs/docsite/rst/rhv/rhv_getting_started.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/rhv_intro.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/rhv_module_reference.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/rhv_requirements.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/rhv_troubleshooting.rst:0:0: not-in-toc-tree: document isn't included in any toctree

The test ansible-test sanity --test rstcheck [explain] failed with 3 errors:

docs/docsite/rst/rhv/faq.rst:24:0: Title underline too short.
docs/docsite/rst/rhv/rhv_concepts.rst:29:0: Definition list ends without a blank line; unexpected unindent.
docs/docsite/rst/rhv/rhv_external_doc_links.rst:3:0: Title overline too short.

click here for bot help

@ansibot

This comment has been minimized.

Copy link
Contributor

ansibot commented Jan 3, 2019

@funixz funixz changed the title placeholder to begin rhv guides begin rhv guides Jan 3, 2019

@funixz

This comment has been minimized.

Copy link
Contributor Author

funixz commented Jan 3, 2019

will get to work on cleaning up the rst

@mattclay mattclay added the ci_verified label Jan 7, 2019

@ansibot

This comment has been minimized.

Copy link
Contributor

ansibot commented Jan 7, 2019

The test ansible-test sanity --test docs-build [explain] failed with 31 errors:

docs/docsite/rst/index.rst:0:0: unknown: 
docs/docsite/rst/index.rst:0:0: unknown: 
docs/docsite/rst/index.rst:0:0: unknown: 
docs/docsite/rst/index.rst:0:0: unknown: ******************************
docs/docsite/rst/index.rst:0:0: unknown: ******************************
docs/docsite/rst/index.rst:0:0: unknown: ------------------------------------------------------------
docs/docsite/rst/index.rst:0:0: unknown: ------------------------------------------------------------
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone RHV Host server ?
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone RHV Host server ?
docs/docsite/rst/index.rst:0:0: unknown: List of useful links for RHV/ oVirt
docs/docsite/rst/rhv/faq.rst:24:0: warning: Title underline too short.
docs/docsite/rst/rhv/faq.rst:24:0: warning: Title underline too short.
docs/docsite/rst/rhv/index.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_concepts'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_external_doc_links'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_getting_started'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_intro'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_module_reference'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_requirements'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_scenarios'
docs/docsite/rst/rhv/index.rst:16:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'rhv/RHV_troubleshooting'
docs/docsite/rst/rhv/rhv_concepts.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/rhv_concepts.rst:29:0: definition-list-missing-blank-line: Definition list ends without a blank line; unexpected unindent.
docs/docsite/rst/rhv/rhv_concepts.rst:48:0: unexpected-indentation: Unexpected indentation.
docs/docsite/rst/rhv/rhv_external_doc_links.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/rhv_external_doc_links.rst:3:0: warning: Title overline too short.
docs/docsite/rst/rhv/rhv_getting_started.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/rhv_intro.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/rhv_module_reference.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/rhv_requirements.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/rhv/rhv_troubleshooting.rst:0:0: not-in-toc-tree: document isn't included in any toctree

The test ansible-test sanity --test rstcheck [explain] failed with 3 errors:

docs/docsite/rst/rhv/faq.rst:24:0: Title underline too short.
docs/docsite/rst/rhv/rhv_concepts.rst:29:0: Definition list ends without a blank line; unexpected unindent.
docs/docsite/rst/rhv/rhv_external_doc_links.rst:3:0: Title overline too short.

click here for bot help

@ansibot ansibot removed the needs_triage label Jan 7, 2019

@ansibot ansibot added the stale_ci label Jan 15, 2019

@machacekondra
Copy link
Contributor

machacekondra left a comment

Nice, thank you for this. cc @mwperina

------------------------------------------------------------

Most of the more recently build ``ovirt_*`` modules are best experienced with oVirt/ RHV 4.1 or newer, hence the preview flags
on the modules, indicating no guarantee for backwards compatibility.

This comment has been minimized.

@machacekondra

machacekondra Jan 23, 2019

Contributor

Note that we make the modules backward compatible, even when docs says it don't have to be.

This comment has been minimized.

@funixz

funixz Jan 23, 2019

Author Contributor

how far back are they tested to work?

This comment has been minimized.

@machacekondra

machacekondra Jan 24, 2019

Contributor

It should work on all 4.x versions. The only limitation is SDK, which must be always the latest.

Show resolved Hide resolved docs/docsite/rst/rhv/rhv_concepts.rst
@acozine

This comment has been minimized.

Copy link
Contributor

acozine commented Jan 25, 2019

@funixz thanks for working on this - please put the files in docs/docsite/rst/scenario_guides/rhv instead of directly under rst - we will be moving the vmware files into a similar directory

@dagwieers dagwieers added the virt label Feb 11, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment