ansible-community / community-website

Ansible Community website (WIP)

Creative Commons Attribution Share Alike 4.0 International

14 stars 25 forks source link

Follows up on #300

A number of migrated blog posts contain weird formatting as a result of the conversion process. The purpose of this task is to inspect the markdown files and manually clean them up where needed.

Here is the list of suspected markdown files:

[ ] ansible-and-infoblox-roles-deep-dive.md
[ ] automating-a-rhel-8-installation-using-the-vmware-rest-ansible-collection.md
[ ] automation-at-the-edge-summit-2022.md
[ ] command-module-deep-dive-for-networks.md
[ ] configure-network-cards-by-pci-address-with-ansible-facts.md
[ ] continuous-detection-and-mitigation-cdm.md
[ ] creating-custom-event-driven-ansible-source-plugins.md
[ ] creating-custom-rules-for-ansible-lint.md
[ ] deep-dive-acl-configuration-management-using-ansible-network-automation-resource-modules.md
[ ] deep-dive-into-trend-micro-deep-security-integration-modules.md
[ ] deep-dive-on-ansible-vscode-extension.md
[ ] deep-dive-on-vlans-resource-modules-for-network-automation.md
[ ] enable-self-healing-applications-with-ansible-and-dynatrace.md
[ ] exploring-new-possibilities-with-the-aws-cloud-control-collection.md
[ ] getting-started-with-ansible-and-check-point.md
[ ] getting-started-with-ansible.utils-collection-for-playbook-creators-part-2.md
[ ] getting-started-with-ospfv2-resource-modules.md
[ ] getting-started-workflow-job-templates.md
[ ] infoblox-integration-in-ansible-2.5.md
[ ] introducing-the-vmware-rest-ansible-content-collection.md
[ ] introduction-to-ansible-builder.md
[ ] introduction-to-ansible-test.md
[ ] kubernetes-operators-ansible-deep-dive-part-1.md
[ ] kubernetes-operators-ansible-deep-dive-part-2.md
[ ] learn-about-edge-automation-at-red-hat-summit-and-ansiblefest-2023.md
[ ] learn-about-event-driven-ansible-at-red-hat-summit-and-ansiblefest-2023.md
[ ] managing-a-vmware-template-lifecycle-with-ansible.md
[ ] migrating-from-python-virtual-environments-to-automation-execution-environments-in-ansible-automation-platform-2.md
[ ] monitoring-as-code-with-sensu-ansible.md
[ ] new-libssh-connection-plugin-for-ansible-network.md
[ ] providing-terraform-with-that-ansible-magic.md
[ ] the-anatomy-of-automation-execution-environments.md
[ ] two-simple-ways-automation-can-save-money-on-aws.md
[ ] using-netbox-for-ansible-source-of-truth.md
[ ] using-vmware-vcenter-tags-in-a-red-hat-ansible-tower-dynamic-inventory.md
[ ] welcome-to-the-ansible-lightspeed-technical-preview.md
[ ] whats-new-cloud-automation-with-amazon.aws-6.0.0.md

Examples

Here are some examples of things that need to be fixed.

Backslash characters

The conversion process inserted several backslash characters \ that get rendered in the output and prevent line breaks so paragraphs get globbed together.

Here is an example from the command-module-deep-dive-for-networks.md file.

Before

be automated. Ansible is more than configuration management, it allows
network operators the freedom to decouple themselves from routine tasks
and save themselves time.\
\
There are command modules for a variety of platforms, including all the

This renders as:

After

be automated. Ansible is more than configuration management, it allows
network operators the freedom to decouple themselves from routine tasks
and save themselves time.

There are command modules for a variety of platforms, including all the

This renders as:

Square brackets

In several files text is wrapped in square brackets [] and has inline CSS like this:

[\
Basic Command Module
Usage]{style="color: inherit; font-size: 30px; background-color: transparent;"}

The solution here is to remove the brackets so that it's just plain text with whatever the appropriate markdown formatting might be.

For example, this would create a second level heading:

## Basic Command Module

Here is another example in the ansible-and-infoblox-roles-deep-dive.md file:

records based on a user-supplied
[host_count]{style="font-family: 'courier new', courier;"} value. This
demo shows the power of

This is a pretty straightforward fix:

records based on a user-supplied
`host_count` value. This
demo shows the power of