Discussion: Improve Handling

dschier-wtd commented 6 years ago

Type of Report

Feature Request /Discussion

Actual behaviour

Currently a lot of workarounds are needed to get this thing going. The content is in the root directory of the repo.

Expected behaviour

A rel-ayouting and some minor work can improve the handling:

README.md                  # The description/README.md for this repo
.editorconfig                   # The repo specific .editorconfig
.gitignore                        # The repo specific .gitignore

docs                               # The regular docs will be placed here
tests                               # The tests for this exact repository will be placed here

dist                                 # The skeleton (distributed) will be placed here
   README.md.j2           # Readme.md template for new roles
  .editorconfig                 # The editorconfig for new roles
  .gitignore                      # .gitignore for new repos
  .travis.yml.j2                # Template for new travis files

  docs                             # The docs for new roles will be placed here
  tests                             # Templates for tests
  meta
  tasks

I think you got the idea ^^

What do you think about this? From my perspective it will remove the workarounds, allow tests for the repo itself (including a simulated ansible-galaxy init) and can help to keep it up-to-date. One problem will be there. Updating the repository can cause a lot of copy-pasting, because it can happen that multiple files must be touched.

dschier-wtd commented 6 years ago

If the above is ok from your side, I'll start the work and open a PR

donvipre commented 6 years ago

I like the idea, should be easier to maintain the content. Please proceed :)

dschier-wtd commented 6 years ago

starting with this in https://github.com/while-true-do/ansible-galaxy-skeleton/tree/fb-daniel-wtd

while-true-do / ansible-skeleton