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 3 commits into
base: devel
Choose a base branch
from

Conversation

@arendej
Copy link
Contributor

@arendej arendej 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
Copy link
Contributor

@ansibot ansibot 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

Loading

@ansibot
Copy link
Contributor

@ansibot ansibot commented Jul 23, 2019

Loading

.. _oVirt_faq:

***************
Ansible oVirt FAQ
Copy link
Member

@Akasurde Akasurde Jul 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Loading

Loading
Loading
Loading
Loading
Loading

.. code-block:: yaml
{
Copy link
Member

@Akasurde Akasurde Jul 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace this with actual output of ovirt_ module output.

Loading

Loading
Loading
Loading
@ansibot
Copy link
Contributor

@ansibot ansibot 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

Loading

on the modules, indicating no guarantee for backwards compatibility.

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

@Akasurde Akasurde Jul 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Loading

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?
Copy link
Member

@Akasurde Akasurde Jul 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Loading

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?
Copy link
Member

@Akasurde Akasurde Jul 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Loading


scenario_rename_vm
scenario_remove_vm
scenario_find_vm_folder
Copy link
Member

@Akasurde Akasurde Jul 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is non-existing document reference.

Loading

@Akasurde Akasurde force-pushed the funixz_ovirt-guide-start branch from 377b54a to fb06ea5 Jul 24, 2019
@Akasurde
Copy link
Member

@Akasurde Akasurde 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

Loading

@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
Copy link
Contributor

@ansibot ansibot 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

Loading

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_ovirt-guide-start branch from fb06ea5 to b2f160c Jul 24, 2019
@ansibot
Copy link
Contributor

@ansibot ansibot 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

Loading

@samccann
Copy link
Contributor

@samccann samccann 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.

Loading

@arendej
Copy link
Contributor Author

@arendej arendej 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

Loading

@acozine
Copy link
Contributor

@acozine acozine 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.

Loading

@samccann samccann mentioned this pull request Sep 3, 2019
@ansibot
Copy link
Contributor

@ansibot ansibot commented Sep 25, 2019

@funixz this PR contains the following merge commits:

Please rebase your branch to remove these commits.

click here for bot help

Loading

@ansibot
Copy link
Contributor

@ansibot ansibot commented Sep 25, 2019

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

docs/docsite/rst/index.rst:0:0: unknown: 
docs/docsite/rst/index.rst:0:0: unknown:    ovirt_scenarios/ovirt_scenarios
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: >>>>>>> b2f160c369d26b7fc5dea65dae33eda7e6686620
docs/docsite/rst/index.rst:0:0: unknown: Ansible oVirt FAQ
docs/docsite/rst/index.rst:0:0: unknown: List of useful links for oVirt/ oVirt
docs/docsite/rst/index.rst:0:0: unknown: oVirt is the upsteam open-source edition of Red Hat Virtualization.
docs/docsite/rst/scenario_guides/guide_ovirt.rst:19:0: explicit-markup-missing-blank-line: Explicit markup ends without a blank line; unexpected unindent.
docs/docsite/rst/scenario_guides/guide_ovirt.rst:21:0: definition-list-missing-blank-line: Definition list ends without a blank line; unexpected unindent.
docs/docsite/rst/scenario_guides/guide_ovirt.rst:21:0: warning: Missing matching underline for section title overline.
docs/docsite/rst/scenario_guides/guide_ovirt.rst:27:0: block-quote-missing-blank-line: Block quote ends without a blank line; unexpected unindent.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:6:0: warning: Title underline too short.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:7:0: warning: Invalid section title or transition marker.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:22: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
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_concepts.rst:6:0: duplicate-label: duplicate label ovirt_concepts, other instance in /root/ansible/docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_concepts.rst
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: duplicate-label: duplicate label rhv_external_doc_links, other instance in /root/ansible/docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_external_doc_links.rst
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_getting_started.rst:5:0: duplicate-label: duplicate label ovirt_ansible_getting_started, other instance in /root/ansible/docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_getting_started.rst
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_intro.rst:5:0: duplicate-label: duplicate label ovirt_ansible_intro, other instance in /root/ansible/docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_intro.rst
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_module_reference.rst:5:0: duplicate-label: duplicate label ovirt_ansible_module_index, other instance in /root/ansible/docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_module_reference.rst
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_requirements.rst:5:0: duplicate-label: duplicate label ovirt_requirements, other instance in /root/ansible/docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_requirements.rst
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:5:0: duplicate-label: duplicate label ovirt_scenarios, other instance in /root/ansible/docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_scenarios.rst
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_troubleshooting.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/scenario_guides/ovirt_scenarios/ovirt_troubleshooting.rst:5:0: duplicate-label: duplicate label ovirt_troubleshooting, other instance in /root/ansible/docs/docsite/rst/scenario_guides/ovirt_scenarios/oVirt_troubleshooting.rst

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

docs/docsite/rst/scenario_guides/guide_ovirt.rst:19:0: Explicit markup ends without a blank line; unexpected unindent.
docs/docsite/rst/scenario_guides/ovirt_scenarios/faq.rst:6:0: Title underline 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

Loading

@samccann
Copy link
Contributor

@samccann samccann commented Feb 11, 2020

@funixz can you please fix the merge commit comment above and rebase etc?

I will add some general comments in a review as well.

Loading

@samccann
Copy link
Contributor

@samccann samccann commented Feb 11, 2020

Some general comments:

  • include only files/sections that have actual content. If you want to keep the other sections as reminders to yourself or another contributor, you can comment them out so they won't generate HTML.

  • remove the list of modules. By the time we get this in shape and published, they'll all have moved to a collection so you can just point there. For now, they aren't needed.

  • remove the basic stuff like what is a playbook, etc. That is already covered in the ansible docs. You can link to https://docs.ansible.com/ansible/latest/user_guide/basic_concepts.html#ansible-concepts for example (though please use an rst :ref: for that.

I'll take a deeper look once you've cleaned these bigger items up. Thanks!

Loading

@arendej
Copy link
Contributor Author

@arendej arendej commented Feb 21, 2020

Sorry I haven't been able to jump back onto this. Once I can slide in the time, I will. I haven't forgotten.

Loading

@samccann
Copy link
Contributor

@samccann samccann commented Aug 21, 2020

Hi @funixz - any update on this PR and where you want to go with it? Thanks!

Loading

@arendej
Copy link
Contributor Author

@arendej arendej commented Aug 21, 2020

Hi @funixz - any update on this PR and where you want to go with it? Thanks!

I'll eventually jump back on this. If anyone else is in line to contribute, the more the merrier.
We can close the PR, if that's preferred.

Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants