Skip to content
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

Ovirt Scenario and User guidelines #59413

Open
wants to merge 1 commit into
base: devel
from

Conversation

@funixz
Copy link
Contributor

commented Jul 23, 2019

SUMMARY

follow-up to funixz:patch-8, setting up ovirt/rhv to have presence in scenario guides.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

ovirt scenario guides in docs

ADDITIONAL INFORMATION

n/a

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jul 23, 2019

The test ansible-test sanity --test docs-build [explain] failed with 40 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: ***********************************
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: Ansible oVirt FAQ
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone oVirt Host server ?
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone oVirt Host server ?
docs/docsite/rst/index.rst:0:0: unknown: List of useful links for oVirt/ oVirt
docs/docsite/rst/index.rst:0:0: unknown: What is oVirt? What is oVirt?
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_concepts'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_external_doc_links'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_intro'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_inventory'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_requirements'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_scenarios'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_troubleshooting'
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:3:0: warning: Title overline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:11:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:24:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:24:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_concepts.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:3:0: warning: Title overline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:5:0: warning: Duplicate explicit target name: "ovirt config automated with ansible".
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:5:0: warning: Duplicate explicit target name: "ovirt official documentation".
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_getting_started.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_intro.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_module_reference.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_requirements.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_scenarios.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_scenarios.rst:14:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/scenario_find_vm_folder'
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_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 2 errors:

docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:3:0: Title overline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:3:0: Title overline too short.

click here for bot help

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jul 23, 2019

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jul 23, 2019

The test ansible-test sanity --test docs-build [explain] failed with 40 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: ***********************************
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: Ansible oVirt FAQ
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone oVirt Host server ?
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone oVirt Host server ?
docs/docsite/rst/index.rst:0:0: unknown: List of useful links for oVirt/ oVirt
docs/docsite/rst/index.rst:0:0: unknown: What is oVirt? What is oVirt?
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_concepts'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_external_doc_links'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_intro'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_inventory'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_requirements'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_scenarios'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_troubleshooting'
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:3:0: warning: Title overline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:11:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:24:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:24:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_concepts.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:3:0: warning: Title overline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:5:0: warning: Duplicate explicit target name: "ovirt config automated with ansible".
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:5:0: warning: Duplicate explicit target name: "ovirt official documentation".
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_getting_started.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_intro.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_module_reference.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_requirements.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_scenarios.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_scenarios.rst:14:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/scenario_find_vm_folder'
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_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 2 errors:

docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:3:0: Title overline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:3:0: Title overline too short.

click here for bot help

.. _oVirt_faq:

***************
Ansible oVirt FAQ

This comment has been minimized.

Copy link
@Akasurde

Akasurde Jul 23, 2019

Member
Suggested change
Ansible oVirt FAQ
*****************
Ansible oVirt FAQ
*****************

.. code-block:: yaml

{

This comment has been minimized.

Copy link
@Akasurde

Akasurde Jul 23, 2019

Member

Replace this with actual output of ovirt_ module output.

@ansibot ansibot removed the needs_triage label Jul 23, 2019

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jul 23, 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: Ansible oVirt FAQ
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone oVirt Host server ?
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone oVirt Host server ?
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_concepts'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_external_doc_links'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_intro'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_inventory'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_requirements'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_scenarios'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_troubleshooting'
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:3:0: warning: Title overline & underline mismatch.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:25:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:25:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_concepts.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:5:0: warning: Duplicate explicit target name: "ovirt config automated with ansible".
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:5:0: warning: Duplicate explicit target name: "ovirt official documentation".
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_getting_started.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_intro.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_module_reference.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_requirements.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_scenarios.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_scenarios.rst:14:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/scenario_find_vm_folder'
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_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 2 errors:

docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:3:0: Title overline & underline mismatch.
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:5:0: Duplicate explicit target name: "ovirt config automated with ansible".

click here for bot help

1 similar comment
@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jul 23, 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: Ansible oVirt FAQ
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone oVirt Host server ?
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone oVirt Host server ?
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_concepts'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_external_doc_links'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_intro'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_inventory'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_requirements'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_scenarios'
docs/docsite/rst/scenario_guides/guide_ovirt.rst:13:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/ovirt_troubleshooting'
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:3:0: warning: Title overline & underline mismatch.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:25:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:25:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_concepts.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:5:0: warning: Duplicate explicit target name: "ovirt config automated with ansible".
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:5:0: warning: Duplicate explicit target name: "ovirt official documentation".
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_getting_started.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_intro.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_module_reference.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_requirements.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_scenarios.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_scenarios.rst:14:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/ovirt_scenarios/scenario_find_vm_folder'
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_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 2 errors:

docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:3:0: Title overline & underline mismatch.
docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst:5:0: Duplicate explicit target name: "ovirt config automated with ansible".

click here for bot help

on the modules, indicating no guarantee for backwards compatibility.

Can I deploy a virtual machine on a standalone oVirt Host server ?
----------------------------------------------------------------

This comment has been minimized.

Copy link
@Akasurde

Akasurde Jul 24, 2019

Member
Suggested change
----------------------------------------------------------------
Can I deploy a virtual machine on a standalone oVirt Host server ?
------------------------------------------------------------------
Red Hat Virtualization is an open-source alternative hypervisor to such like VMware. As of oVirt version 4.1+ the feature-set and
maturity of oVirt insists that it is prime for enterprise production workloads, among others.

What version of oVirt/RHV will Ansible modules work with?

This comment has been minimized.

Copy link
@Akasurde

Akasurde Jul 24, 2019

Member
Suggested change
What version of oVirt/RHV will Ansible modules work with?
What version of oVirt/RHV will Ansible modules work with?
---------------------------------------------------------
Yes. ``ovirt_vm`` can deploy a virtual machine with required settings on a standalone (local-storage install) oVirt Host server.
An arrangement of other ``ovirt_*`` modules combined can achieve more complex VM deployments.

Does oVirt/RHV have a REST APT?

This comment has been minimized.

Copy link
@Akasurde

Akasurde Jul 24, 2019

Member
Suggested change
Does oVirt/RHV have a REST APT?
Does oVirt/RHV have a REST APT?
-------------------------------

scenario_rename_vm
scenario_remove_vm
scenario_find_vm_folder

This comment has been minimized.

Copy link
@Akasurde

Akasurde Jul 24, 2019

Member

This is non-existing document reference.

@Akasurde Akasurde force-pushed the funixz:funixz_ovirt-guide-start branch from 377b54a to fb06ea5 Jul 24, 2019

@Akasurde

This comment has been minimized.

Copy link
Member

commented Jul 24, 2019

@funixz I updated few things in this PR. You can build docs locally by installing sphinx and

cd <Ansible_checkout>/docs/docsite
rst=scenario_guides/guide_ovirt.rst make htmlsingle

Check errors and warnings

@Akasurde Akasurde changed the title post-rebase, sed rhv/ovirt Ovirt Scenario and User guidelines Jul 24, 2019

@Akasurde Akasurde requested review from acozine and samccann Jul 24, 2019

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jul 24, 2019

The test ansible-test sanity --test docs-build [explain] failed with 17 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: Ansible oVirt FAQ
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone oVirt Host server ?
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone oVirt Host server ?
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:3:0: warning: Title overline & underline mismatch.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:25:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:25:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_external_doc_links.rst:5:0: warning: Duplicate explicit target name: "ovirt config automated with ansible".
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_external_doc_links.rst:5:0: warning: Duplicate explicit target name: "ovirt official documentation".
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_getting_started.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_module_reference.rst:0:0: not-in-toc-tree: document isn't included in any toctree

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

docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:3:0: Title overline & underline mismatch.
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_external_doc_links.rst:5:0: Duplicate explicit target name: "ovirt config automated with ansible".

click here for bot help

1 similar comment
@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jul 24, 2019

The test ansible-test sanity --test docs-build [explain] failed with 17 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: Ansible oVirt FAQ
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone oVirt Host server ?
docs/docsite/rst/index.rst:0:0: unknown: Can I deploy a virtual machine on a standalone oVirt Host server ?
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:3:0: warning: Title overline & underline mismatch.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:25:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:25:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_external_doc_links.rst:5:0: warning: Duplicate explicit target name: "ovirt config automated with ansible".
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_external_doc_links.rst:5:0: warning: Duplicate explicit target name: "ovirt official documentation".
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_getting_started.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_module_reference.rst:0:0: not-in-toc-tree: document isn't included in any toctree

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

docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:3:0: Title overline & underline mismatch.
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_external_doc_links.rst:5:0: Duplicate explicit target name: "ovirt config automated with ansible".

click here for bot help

oVirt Scenario / User guide
Signed-off-by: Aren <7918248+funixz@users.noreply.github.com>
Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com>
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

@Akasurde Akasurde force-pushed the funixz:funixz_ovirt-guide-start branch from fb06ea5 to b2f160c Jul 24, 2019

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jul 24, 2019

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

docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_getting_started.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_module_reference.rst:0:0: not-in-toc-tree: document isn't included in any toctree

click here for bot help

@ansibot ansibot added the ci_verified label Jul 24, 2019

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jul 24, 2019

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

docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_getting_started.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_module_reference.rst:0:0: not-in-toc-tree: document isn't included in any toctree

click here for bot help

@samccann

This comment has been minimized.

Copy link
Contributor

commented Jul 31, 2019

Please remove all mention of RHV and keep this as oVirt only please, unless someone in Red Hat is signing up to officially support these modules.

@funixz

This comment has been minimized.

Copy link
Contributor Author

commented Jul 31, 2019

Please remove all mention of RHV and keep this as oVirt only please, unless someone in Red Hat is signing up to officially support these modules.

will do

@ansibot ansibot added the stale_ci label Aug 1, 2019

@acozine

This comment has been minimized.

Copy link
Contributor

commented Aug 12, 2019

@funixz you can fix the not-in-toc-tree errors by either adding the page(s) in question to a TOC, or marking them :orphan:. See https://raw.githubusercontent.com/ansible/ansible/devel/docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_getting_started.rst for an example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.