Majic Projects
Majic Ansible Roles
Go to the previous open issue
Go to the previous issue (open or closed)
star_faded.png
Please log in to bookmark issues
icon_project.png Majic Ansible Roles / Open Enhancement MAR-203 Simplify usage instructions testing and maintenance
Go to the next issue (open or closed)
Go to the next open issue
Issue basics
  • Type of issue
    Enhancement
  • Category
    Documentation
  • Targetted for
    Not determined
  • Status
    New
  • Progress
  • Priority
    Not determined
User pain
  • Type of bug
    Not triaged
  • Likelihood
    Not triaged
  • Effect
    Not triaged
Affected by this issue (0)
There are no items
People involved
Times and dates
  • Posted at
  • Last updated
  • Estimated time
    8 hours
  • Time spent
    No time spent
    Click here to see time logged against this issue
Issue details
Attachments (0)
There is nothing attached to this issue
Duplicate issues (0)
This issue does not have any duplicates
Description

Currently the usage instructions can be a bit cumbersome to keep up-to-date, and there is also a couple of missing features in terms of testing the rolled-out sample project.

The following should be done:

  • Update usage instructions.
    • Consider moving-out code snippets into individual files. This should make indentation mistakes less likely, and allow for use of proper code-highlighting.
    • Install more helper tools on controller and managed servers for testing purposes (like Swaks, mcabber, or mutt).
    • Provide ready-to-use configuration files for CLI tools such as mcabber and mutt.
    • Take into account possibility of automating some of this testing if possible (not sure how that would look like).
  • Thoroughly test the usage instructions.
  • Update role reference documentation.
  • Update release notes.
Todos (0 / 0)
There are no comments