WIP: PED10891-Ansible-basics #544

Amrita42 · 2025-09-26T16:08:31Z

PR creator: Description

Describe the overall goals of this pull request.

PR creator: Are there any relevant issues/feature requests?

bsc#...
jsc#...

PR reviewer: Checklist for editorial review

Apart from the usual checks, please double-check also the following:

do any new files fulfill the naming conventions specified in https://github.com/SUSE/doc-modular/blob/main/templates/README.md?
article title/structure title: does it have the required length and does it use sentence style capitalization?
revhistory: is it up-to-date and does it follow the guidelines specified in https://documentation.suse.com/style/current/html/style-guide-db/sec-smartdocs.html#sec-revhistory?
metadata: does it follow the guidlines specified in https://documentation.suse.com/style/current/html/style-guide-db/sec-smartdocs.html#sec-taglist-smartdocs?

Amrita42 · 2025-10-23T07:07:40Z

@dariavladykina please review thanks

lvicoun

Hi Amrita,
so far these suggestions. Thanks!

lvicoun · 2025-10-23T09:24:38Z

articles/ansible.asm.xml

+    <merge>
+      <title>Ansible core</title>
+      <revhistory xml:id="rh-ansible">
+        <revision><date>2025-06-19</date>


Suggested change

<revision><date>2025-06-19</date>

<revision><date>2025-11-04</date>

lvicoun · 2025-10-23T09:25:18Z

articles/ansible.asm.xml

+
+      <!-- Productname & Version -->
+      <meta name="productname" its:translate="no">
+        <productname version="16">&sles;</productname>


Suggested change

<productname version="16">&sles;</productname>

<productname version="16.0" os="sles;sles4sap">&productname;</productname>

lvicoun · 2025-10-23T09:25:58Z

articles/ansible.asm.xml

+<!-- S T R U C T U R E -->
+  <structure renderas="article" xml:id="ansible" xml:lang="en">
+    <merge>
+      <title>Ansible core</title>


Suggested change

<title>Ansible core</title>

<title>Introduction to Ansible</title>

Feel free to change, however, as a beginner I wouldn't know what Ansible core is, so I'd search for Introduction or Getting started.

lvicoun · 2025-10-23T09:27:28Z

articles/ansible.asm.xml

+      </meta>
+
+      <!-- Social Media -->
+      <meta name="title" its:translate="yes">Ansible automation platform</meta>


The title must be the same as the article title.

lvicoun · 2025-10-23T09:28:43Z

articles/ansible.asm.xml

+            <term>WHAT?</term>
+            <listitem>
+              <para>
+This article gives an introduction to Ansible and guides you on how to automate repetitive IT tasks.


I'd leave the first sentence from here as it mentioned in the Why?

Suggested change

This article gives an introduction to Ansible and guides you on how to automate repetitive IT tasks.

lvicoun · 2025-10-23T12:15:54Z

concepts/ansible-inventory-file.xml

+           <listitem>
+          <para>Variables can be assigned to all hosts within a specific group.
+           These are defined under the group name using a <literal>:vars</literal> suffix. For example:</para>
+<screen>[webservers:vars]


It seems like INI format to me.

lvicoun · 2025-10-23T12:17:36Z

concepts/ansible-inventory-file.xml

+      <varlistentry>
+        <term><emphasis>Group variables</emphasis> </term>
+           <listitem>
+          <para>Variables can be assigned to all hosts within a specific group.


The description is the same as for the INI file, but I don't think there is any :vars suffix in YAML.

lvicoun · 2025-10-23T12:21:02Z

references/ansible-basic-usage.xml

+      <para>
+        Ansible provides ad-hoc commands and several utilities to perform various operation and automation
+        tasks. Ad-hoc commands in Ansible are useful for performing quick and one-off tasks that do not need to be saved for future use.
+        They are single line commands executed directly from the command line. Ad-hoc commands use the <literal>ansible</literal> CLI tool.


These 2 sentences should be better placed in the subsection ad-ho commands. Also consider creating a separate section for playbooks. Those 2 are basically alternatives, right? If so, they deserve the same attention - either 2 subsections, or everything written in the section intro.

lvicoun · 2025-10-23T12:28:12Z

references/ansible-basic-usage.xml

+  <title>Using roles</title>
+  <para>You can use the role in the following ways:</para>
+  <itemizedlist>
+    <listitem><para>At the play level with the <literal>roles</literal>: This is the default way of using roles in a play.</para> </listitem>


Bear in mind that newbie has no idea what a play is.

lvicoun · 2025-10-23T12:29:36Z

references/ansible-basic-usage.xml

+</section>
+<section xml:id="about-variables">
+<title>About variables</title>
+<para>With Ansible, you can run tasks and playbooks with a single command. You can define these variables using standard YAML syntax (including lists and dictionaries) in your playbooks, inventories, roles, or at the command line.


What is a variable should be IMHO mentioned here. I don't know about which variables this is.

Suggested change

<para>With Ansible, you can run tasks and playbooks with a single command. You can define these variables using standard YAML syntax (including lists and dictionaries) in your playbooks, inventories, roles, or at the command line.

<para>You can define these variables using standard YAML syntax (including lists and dictionaries) in your playbooks, inventories, roles, or at the command line.

dariavladykina

Hi Amrita, please see some linguistic things for the content. Also, I couldn't review the DC-SAP-Ansible article as it built the SLES one for me. Thanks!

dariavladykina · 2025-10-23T10:50:37Z

articles/ansible.asm.xml

+<!-- S T R U C T U R E -->
+  <structure renderas="article" xml:id="ansible" xml:lang="en">
+    <merge>
+      <title>Ansible core</title>


I suggest an extended title, e.g. Ansible Core Installation Configuration and Automation Basics

dariavladykina · 2025-10-23T10:53:39Z

articles/ansible.asm.xml

+      </meta>
+
+      <!-- Social Media -->
+      <meta name="title" its:translate="yes">Ansible automation platform</meta>


Suggested change

<meta name="title" its:translate="yes">Ansible automation platform</meta>

<meta name="title" its:translate="yes">Ansible automation platform for IT task automation</meta>

dariavladykina · 2025-10-23T10:54:07Z

articles/ansible.asm.xml

+
+      <!-- Social Media -->
+      <meta name="title" its:translate="yes">Ansible automation platform</meta>
+      <meta name="social-descr" its:translate="yes">Learn how to automate IT tasks using Ansible</meta>


Suggested change

<meta name="social-descr" its:translate="yes">Learn how to automate IT tasks using Ansible</meta>

<meta name="social-descr" its:translate="yes">Learn how to simplify IT tasks and system management using Ansible automation platform</meta>

dariavladykina · 2025-10-23T10:54:40Z

articles/ansible.asm.xml

+      <meta name="social-descr" its:translate="yes">Learn how to automate IT tasks using Ansible</meta>
+
+      <!-- Search -->
+      <meta name="description" its:translate="yes">Save time by using Ansible automation platform.</meta>


Suggested change

<meta name="description" its:translate="yes">Save time by using Ansible automation platform.</meta>

<meta name="description" its:translate="yes">Use Ansible automation platform to efficiently automate IT tasks</meta>

dariavladykina · 2025-10-23T10:57:45Z

articles/ansible.asm.xml

+Learn how to automate IT infrastructure with Ansible; how to install and configure, create
+an inventory file and a playbook.


Suggested change

Learn how to automate IT infrastructure with Ansible; how to install and configure, create

an inventory file and a playbook.

Learn how to automate IT infrastructure with Ansible, from installation and configuration

to creating inventory files and playbooks.

dariavladykina · 2025-10-23T15:27:29Z

references/ansible-support-coverage.xml

+   <important>
+    <itemizedlist>
+      <listitem><para>Python and Ansible versions in the control and managed nodes must be compatible.</para></listitem>
+      <listitem><para>Third party software is not supported.</para></listitem>


Suggested change

<listitem><para>Third party software is not supported.</para></listitem>

<listitem><para>Third-party software is not supported.</para></listitem>

dariavladykina · 2025-10-23T15:28:08Z

references/ansible-support-coverage.xml

+    <itemizedlist>
+      <listitem><para>Python and Ansible versions in the control and managed nodes must be compatible.</para></listitem>
+      <listitem><para>Third party software is not supported.</para></listitem>
+      <listitem><para>Only versions provided in packages which installs into System Python are supported. </para></listitem>


Suggested change

<listitem><para>Only versions provided in packages which installs into System Python are supported. </para></listitem>

<listitem><para>Only versions provided in packages that install into System Python are supported. </para></listitem>

dariavladykina · 2025-10-23T15:30:58Z

glues/ansible-more-info.xml

+  <itemizedlist>
+    <listitem>
+      <para>
+        <link xlink:href="https://docs.ansible.com/ansible-core/devel/index.html">The official source for Ansible core.


Please turn this into a regular sentence as there's only 1 item - too few for a list.

dariavladykina · 2025-10-23T15:36:58Z

tasks/install-sap-playbook-ansible.xml

+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:trans="http://docbook.org/ns/transclusion">
+  <info>
+    <title>Installing and running a &sles4sap; 16 Ansible playbook</title>


I'm not sure but I couldn't see this part in the output when I built DC-SAP-Ansible

dariavladykina · 2025-10-23T15:42:57Z

articles/intro-sap-ansible-automation.asm.xml

+  <!-- S T R U C T U R E -->
+  <structure renderas="article" xml:id="intro-sap-ansible" xml:lang="en">
+    <merge>
+      <title>Introduction to Ansible automation for &sles4sap; 16</title>


I wasn't able to build this DC file for SAP

dariavladykina

Hi Amrita, please see some linguistic things for the content. Also, I couldn't review the DC-SAP-Ansible article as it built the SLES one for me. Thanks!

structure toc

6a3167c

Amrita42 changed the title ~~WIP: PED10891~~ WIP: PED10891-Ansible-basics Sep 26, 2025

Amrita42 self-assigned this Sep 26, 2025

Amrita42 mentioned this pull request Sep 26, 2025

[WIP]PED-10891: Intro-Ansible on SLES-SAP #480

Closed

Amrita42 added 3 commits September 27, 2025 00:54

self review

bc82b88

best practices

9af72c4

final changes

9de3f20

Amrita42 added the WIP Work in progress. Do not merge! label Sep 29, 2025

Amrita42 added 7 commits October 8, 2025 13:24

tech review feedback-1

138e22c

tech feedback-2

eed09e1

tech fdback

ec729d2

tech review-4

5fea0da

self review and support cover aded

8e5fcc2

validate

6c7279b

final review

8a3a931

Amrita42 requested a review from lvicoun October 21, 2025 08:57

Amrita42 added 6 commits October 21, 2025 19:20

tech feedback

d6e80f4

final tech feedback

0e841a0

dc -dap

076bf4d

typo

2851b72

tech review feedback

587e8e0

tech review

37e8b13

Amrita42 requested a review from dariavladykina October 23, 2025 07:07

Amrita42 added 3 commits October 23, 2025 12:39

final tech review

eb38440

tech review

0dbd53a

tfeedback

399ceb7

lvicoun requested changes Oct 23, 2025

View reviewed changes

dariavladykina reviewed Oct 23, 2025

View reviewed changes

	<revision><date>2025-06-19</date>
	<revision><date>2025-11-04</date>

	<productname version="16">&sles;</productname>
	<productname version="16.0" os="sles;sles4sap">&productname;</productname>

	<title>Ansible core</title>
	<title>Introduction to Ansible</title>

	<para>With Ansible, you can run tasks and playbooks with a single command. You can define these variables using standard YAML syntax (including lists and dictionaries) in your playbooks, inventories, roles, or at the command line.
	<para>You can define these variables using standard YAML syntax (including lists and dictionaries) in your playbooks, inventories, roles, or at the command line.

	<meta name="title" its:translate="yes">Ansible automation platform</meta>
	<meta name="title" its:translate="yes">Ansible automation platform for IT task automation</meta>

	<meta name="social-descr" its:translate="yes">Learn how to automate IT tasks using Ansible</meta>
	<meta name="social-descr" its:translate="yes">Learn how to simplify IT tasks and system management using Ansible automation platform</meta>

	<meta name="description" its:translate="yes">Save time by using Ansible automation platform.</meta>
	<meta name="description" its:translate="yes">Use Ansible automation platform to efficiently automate IT tasks</meta>

		Learn how to automate IT infrastructure with Ansible; how to install and configure, create
		an inventory file and a playbook.

	<listitem><para>Third party software is not supported.</para></listitem>
	<listitem><para>Third-party software is not supported.</para></listitem>

	<listitem><para>Only versions provided in packages which installs into System Python are supported. </para></listitem>
	<listitem><para>Only versions provided in packages that install into System Python are supported. </para></listitem>

WIP: PED10891-Ansible-basics #544

Are you sure you want to change the base?

WIP: PED10891-Ansible-basics #544

Uh oh!

Conversation

Amrita42 commented Sep 26, 2025

PR creator: Description

PR creator: Are there any relevant issues/feature requests?

PR reviewer: Checklist for editorial review

Uh oh!

Amrita42 commented Oct 23, 2025

Uh oh!

lvicoun left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dariavladykina left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dariavladykina left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants