diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..359cb75 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,18 @@ +--- +stages: + - docs + - deploy + +include: + - project: shared/gitlab/docs-as-gitlab-pages + ref: main + file: + - update-static-docs.yml + +update-static-docs: + only: + - main + +pages: + only: + - main diff --git a/README.md b/README.md index f31856d..988b1ba 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ A collection of good and bad Ansible code examples. -* [Name your tasks](good_and_bad_practices/name_your_tasks.md) -* [Use Modules before run-commands](good_and_bad_practices/use_modules_before_run_commands.md) -* [Use native yaml syntax](good_and_bad_practices/use_native_yaml_syntax.md) -* [Use the copy- or template-module instead of lineinfile-module](good_and_bad_practices/use_copy_template_instead_of_lineinfile.md) +* [Name your tasks](docs/name_your_tasks.md) +* [Use Modules before run-commands](docs/use_modules_before_run_commands.md) +* [Use native yaml syntax](docs/use_native_yaml_syntax.md) +* [Use the copy- or template-module instead of lineinfile-module](docs/use_copy_template_instead_of_lineinfile.md) ## Contributing diff --git a/good_and_bad_practices/.gitkeep b/docs/.gitkeep similarity index 100% rename from good_and_bad_practices/.gitkeep rename to docs/.gitkeep diff --git a/good_and_bad_practices/name_your_tasks.md b/docs/name_your_tasks.md similarity index 100% rename from good_and_bad_practices/name_your_tasks.md rename to docs/name_your_tasks.md diff --git a/good_and_bad_practices/use_copy_template_instead_of_lineinfile.md b/docs/use_copy_template_instead_of_lineinfile.md similarity index 100% rename from good_and_bad_practices/use_copy_template_instead_of_lineinfile.md rename to docs/use_copy_template_instead_of_lineinfile.md diff --git a/good_and_bad_practices/use_modules_before_run_commands.md b/docs/use_modules_before_run_commands.md similarity index 100% rename from good_and_bad_practices/use_modules_before_run_commands.md rename to docs/use_modules_before_run_commands.md diff --git a/good_and_bad_practices/use_native_yaml_syntax.md b/docs/use_native_yaml_syntax.md similarity index 100% rename from good_and_bad_practices/use_native_yaml_syntax.md rename to docs/use_native_yaml_syntax.md diff --git a/mkdocs.yaml b/mkdocs.yaml new file mode 100644 index 0000000..2f29f4d --- /dev/null +++ b/mkdocs.yaml @@ -0,0 +1 @@ +site_name: Ansible - Good and Bad Practices