overview icon indicating copy to clipboard operation
overview copied to clipboard

Docs updates (personas master List)

Open gundalow opened this issue 5 years ago • 1 comments
trafficstars

SUMMARY

It's hopefully easier to track what improvements to the documentation are needed if we break it down by who, then secondly what.

Once we have an understanding of what needs doing we can link to specific PRs from here.

We may move content from https://github.com/ansible-collections/overview/blob/master/README.rst into the main doc site (though we must keep the sections in README.rst as we have given those links out)

Persona: User

  • Installing and using
    • Using Collections alongside ansible-base
    • Updating to a newer version of a Collection

Persona: Contributor

  • Where has my code gone (that was in a/a)
  • What do I do with my a/a issues and PRs
  • I want to contribute to a collection, how can I help
    • FIXME: list of ways they can help (review, docs, etc)
  • How can I download and test a PR

Persona: Maintainer

Persona: Collection Owner

  • How to setup CI

Persona: Proven Packager, Elders, Community Team

ISSUE TYPE
  • Bug Report

gundalow avatar Apr 24 '20 16:04 gundalow

This docsite was recommended as a good model to consider - https://www.rdoproject.org/contribute/

samccann avatar Sep 21 '20 19:09 samccann