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

docs: add readme #39

Merged
merged 1 commit into from
Feb 18, 2024
Merged

docs: add readme #39

merged 1 commit into from
Feb 18, 2024

Conversation

sbaerlocher
Copy link
Member

@sbaerlocher sbaerlocher commented Feb 18, 2024

Changed

  • Enhanced Documentation in Environment Role:

    • Environment Role README Update (roles/environment/README.md):
      • Updated the README to include a link to the Arillso System Guide for detailed information and advanced usage. This change aims to provide users with a direct reference to comprehensive documentation.
  • New MOTD Role Documentation:

    • MOTD Role README Added (roles/motd/README.md):
      • Introduced a new README for the MOTD (Message of the Day) role. This documentation covers requirements, role variables, dependencies, and includes an example playbook. It serves as a guide for managing MOTD configuration, including creation, modification, and deletion of MOTD content on systems.

      • Highlights include:

        • Requirements: Specifies the minimum Ansible version and access rights needed.
        • Role Variables: Describes variables for customizing the MOTD, such as header text, FQDN, operating system distribution, virtualization details, and more.
        • Dependencies: Clarifies that the role is standalone and does not require other roles.
        • Documentation Link: Provides a link to the Arillso System Guide for further details and advanced usage.
        • Example Playbook: Offers an example playbook demonstrating how to use the arillso.system.motd role with custom variables.

@sbaerlocher sbaerlocher merged commit 30330a3 into main Feb 18, 2024
13 checks passed
@sbaerlocher sbaerlocher deleted the docs/readme branch February 18, 2024 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant