ansible/docs/docsite/rst
Tina Müller (tinita) 57d5b8642a Add examples to YAMLSyntax; fix minor issues and improve wording (#35703)
* Add examples to YAMLSyntax; fix minor issues and improve wording

I added proper titles to "Flow Collections" and "Block Scalars", because these
are official YAML Terms, so people can find better help when having issues.

I changed the "ignored newlines" to "folded newlines" because I think ignoring
gives a wrong impression, especially since empty lines (more than one newline)
are not ignored and have a special meaning.

I added an example how to enforce a newline in a folded block scalar.

I fixed the list of characters that are allowed/not allowed in plain and
double quoted scalars.

I added the #yaml channel to the IRC link.

I added links to the YAML Specs. For completeness, I also included YAML 1.2,
although PyYAML and libyaml currently implement 1.1.

* Improve wording

* Add three more characters to forbidden first characters
2018-02-05 13:32:06 -08:00
..
community Formatting and broken links (#35226) 2018-01-25 13:06:03 -08:00
dev_guide Update developing inventory script docs. (#35639) 2018-02-02 02:03:17 -08:00
inventory draft implicit localhost docs (#31840) 2017-11-22 19:13:56 -05:00
modules
plugins Fix typo/link in plugins/cache 2017-11-02 19:40:09 -04:00
roadmap Network Doc status (#35475) 2018-01-31 09:04:06 +00:00
become.rst win_become: another option to support become flags for runas (#34551) 2018-01-19 13:58:10 -08:00
command_line_tools.rst Plugin doc update edits for #30490 (#30889) 2017-09-25 15:37:33 -07:00
committer_guidelines.rst No hardcoding roadmaps (#32981) 2017-11-16 08:03:10 -08:00
common_return_values.rst fix typos in various modules and docsite (#28747) 2017-08-29 17:59:41 +02:00
community.rst Deprecate old community guide (#32266) 2017-10-27 17:49:08 +01:00
conf.py Misc docs fixes 2017-08-22 11:52:30 -07:00
faq.rst use print function (#34013) 2017-12-19 09:31:30 -06:00
galaxy.rst fix ansible-galaxy requirements.yml import_tasks->include in docs (#34519) 2018-01-08 16:18:40 -06:00
glossary.rst move from with_<lookup>: to loop: 2017-10-10 15:43:49 -04:00
guide_aws.rst move from with_<lookup>: to loop: 2017-10-10 15:43:49 -04:00
guide_azure.rst Update guide_azure.rst to include note about running ansible from within azure (#35441) 2018-01-30 17:31:10 -08:00
guide_cloudstack.rst Documentation typo fixes (#32473) 2017-11-02 11:15:53 +00:00
guide_docker.rst Documentation typo fixes (#32473) 2017-11-02 11:15:53 +00:00
guide_gce.rst Add 'datacenter' keyword arg to secrets.py (#24598) 2017-11-22 15:17:29 +00:00
guide_kubernetes.rst
guide_packet.rst Fix Packet guide to comply with latest version of the packet module (#31410) 2018-01-03 19:05:04 -08:00
guide_rax.rst move from with_<lookup>: to loop: 2017-10-10 15:43:49 -04:00
guide_rolling_upgrade.rst Update example syntax (#35670) 2018-02-03 11:28:22 +00:00
guide_vagrant.rst
guide_vmware.rst VMware: Add basic vmware module related guide (#35128) 2018-01-31 09:57:05 -08:00
guides.rst VMware: Add basic vmware module related guide (#35128) 2018-01-31 09:57:05 -08:00
index.rst creates structure for network docs (#35514) 2018-01-31 10:01:55 -08:00
intro.rst creates structure for network docs (#35514) 2018-01-31 10:01:55 -08:00
intro_adhoc.rst become-user example was incorrect 2017-10-29 00:58:26 -04:00
intro_bsd.rst Add a code-smell test for smart quotes and remove smart quotes from all files 2017-09-18 16:49:16 -07:00
intro_configuration.rst Plugin doc update edits for #30490 (#30889) 2017-09-25 15:37:33 -07:00
intro_dynamic_inventory.rst Update places we mention env vars to use :envvar: (#28887) 2017-09-01 14:52:18 -07:00
intro_getting_started.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 2017-11-21 20:14:27 -08:00
intro_installation.rst Add dnf and yum commands in "Installation" section (#33369) 2017-12-01 02:19:08 -08:00
intro_inventory.rst Fix syntax error in intro_inventory yaml example (#34960) 2018-01-16 15:41:17 -06:00
intro_patterns.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 2017-11-21 20:14:27 -08:00
intro_windows.rst update Windows docs (#30783) 2017-10-12 18:40:47 -07:00
modules.rst
modules_intro.rst
modules_support.rst Add a code-smell test for smart quotes and remove smart quotes from all files 2017-09-18 16:49:16 -07:00
network.rst creates structure for network docs (#35514) 2018-01-31 10:01:55 -08:00
network_best_practices_2.5.rst Docs network best 2.5 (#33544) 2018-01-03 05:44:55 -05:00
network_debug_troubleshooting.rst Clarify when and how to enable ANSIBLE_DEBUG (#35220) 2018-01-23 17:10:17 +00:00
network_working_with_command_output.rst Create network_working_with_command_output.rst (#33709) 2017-12-11 13:22:58 +00:00
playbook_pathing.rst Fix trailing space in ec2_vol example, fix 'the the' typos (#28440) 2017-08-19 23:00:51 +02:00
playbooks.rst
playbooks_advanced_syntax.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 2017-11-21 20:14:27 -08:00
playbooks_async.rst [Docs] Fix old YAML style in async docs (#31421) 2017-11-13 18:32:37 -08:00
playbooks_best_practices.rst Update example syntax (#35670) 2018-02-03 11:28:22 +00:00
playbooks_blocks.rst Update some examples to use proper YAML syntax. (#35640) 2018-02-02 18:20:03 +00:00
playbooks_checkmode.rst Update example syntax (#35670) 2018-02-03 11:28:22 +00:00
playbooks_conditionals.rst Update example syntax in playbooks_conditionals.rst (#35673) 2018-02-03 11:29:22 +00:00
playbooks_debugger.rst Provide a way to explicitly invoke the debugger (#34006) 2018-01-09 13:50:07 -06:00
playbooks_delegation.rst Update example syntax in playbooks_delegation.rst. (#35674) 2018-02-03 11:29:40 +00:00
playbooks_environment.rst
playbooks_error_handling.rst Update example syntax in playbooks_error_handling.rst. (#35675) 2018-02-03 11:29:58 +00:00
playbooks_filters.rst Update example syntax in playbooks_filters.rst. (#35676) 2018-02-03 11:30:24 +00:00
playbooks_filters_ipaddr.rst
playbooks_intro.rst Update example syntax in playbooks_intro.rst. (#35677) 2018-02-03 11:30:54 +00:00
playbooks_lookups.rst Update example syntax in playbooks_lookups.rst. (#35678) 2018-02-03 11:31:12 +00:00
playbooks_loops.rst Update example syntax in playbooks_loops.rst. (#35679) 2018-02-03 11:32:11 +00:00
playbooks_prompts.rst Typo on "Prompts" page (#31882) 2017-10-19 10:50:27 +10:00
playbooks_python_version.rst move from with_<lookup>: to loop: 2017-10-10 15:43:49 -04:00
playbooks_reuse.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 2017-11-21 20:14:27 -08:00
playbooks_reuse_includes.rst updated plugin docs (#30490) 2017-09-22 23:19:50 -04:00
playbooks_reuse_roles.rst Documentation typo fixes (#32473) 2017-11-02 11:15:53 +00:00
playbooks_roles.rst
playbooks_special_topics.rst updated plugin docs (#30490) 2017-09-22 23:19:50 -04:00
playbooks_startnstep.rst
playbooks_strategies.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 2017-11-21 20:14:27 -08:00
playbooks_tags.rst Tags on includes only affect the include. FIxes #35729 (#35732) 2018-02-05 09:53:56 -06:00
playbooks_templating.rst
playbooks_tests.rst Update example syntax in playbooks_tests.rst. (#35688) 2018-02-05 14:14:15 +00:00
playbooks_variables.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 2017-11-21 20:14:27 -08:00
playbooks_vault.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 2017-11-21 20:14:27 -08:00
plugin_filtering_config.rst Documentation and changelog for the plugin_filtering config option 2018-01-22 17:13:41 -08:00
plugins.rst Plugin doc update edits for #30490 (#30889) 2017-09-25 15:37:33 -07:00
porting_guide_2.0.rst Add a code-smell test for smart quotes and remove smart quotes from all files 2017-09-18 16:49:16 -07:00
porting_guide_2.3.rst Improve and link Network Proxy docs (#31316) 2017-10-05 18:47:32 +01:00
porting_guide_2.4.rst Add note to 2.4 porting guide about initial playbook relative host/group_vars and inheritance (#34769) 2018-01-15 10:00:59 -08:00
porting_guide_2.5.rst removed panos_nat_policy (#34432) 2018-02-03 11:35:17 +00:00
porting_guides.rst porting_guide_2.5.rst stub (#30311) 2017-09-13 23:20:51 +01:00
python_3_support.rst python_3_support.rst: fix broken links (#33951) 2017-12-15 20:04:53 +00:00
quickstart.rst
release_and_maintenance.rst Update the release doc with ansible-2.4.3 2018-01-31 12:30:11 -08:00
test_strategies.rst Update example syntax in test_strategies.rst, (#35689) 2018-02-05 14:13:00 +00:00
tower.rst
vault.rst Small documentation fix in vault.rst (#35384) 2018-01-26 13:06:40 -08:00
windows.rst update Windows docs (#30783) 2017-10-12 18:40:47 -07:00
windows_dsc.rst win_dsc: update documentation for latest DSC changes (#32581) 2017-11-09 10:02:17 +10:00
windows_faq.rst update Windows docs (#30783) 2017-10-12 18:40:47 -07:00
windows_setup.rst Use TEMP variable instead of hardcoded path (#35380) 2018-01-29 11:47:06 +10:00
windows_usage.rst Fixed up windows command quoting example 2017-12-18 06:26:04 +10:00
windows_winrm.rst typo (#34549) 2018-01-07 20:31:06 +01:00
YAMLSyntax.rst Add examples to YAMLSyntax; fix minor issues and improve wording (#35703) 2018-02-05 13:32:06 -08:00