Skip to content
This repository has been archived by the owner on Apr 8, 2024. It is now read-only.

collection_creator_path: add a doc #64

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

Andersson007
Copy link
Contributor

@Andersson007 Andersson007 commented Sep 11, 2023

We have a bunch of collection-related docs spread across docs.ansible.com
but we lack a consistent collection creator journey.

I'm afraid currently newcomers struggle with putting all the pieces together.

So the goal of this doc is to provide a consistent path that will give newcomers a good understanding of the journey and a step-by-step guidance on the "what to do with all the stuff I wrote" question.

The paragraphs will contain a brief explanation + links to related docs

The question I'd like to ask you to help me figure out are:

  1. How about the idea of having this doc in general?
  2. Where to put it? Options I see are:
  1. How about the paragraphs? My view is that each paragraph will reflect each stage of the journey. Any changes/additions?

Please help figure out;)

@Andersson007
Copy link
Contributor Author

@oraNod @felixfontein @samccann @mariolenz please take a look at the description and share your thoughts

@oraNod
Copy link
Contributor

oraNod commented Sep 11, 2023

@Andersson007

  1. In general I think this doc is an great idea.
  2. What if we put this in the same place as the EE getting started guide? I've been pushing for a more cross-project ecosystem doc and am keen to make use of some of the dev tools user guide material. I know this isn't necessarily cross-project but there is overlap with the dev tools content creator journeys. That content would live in a docsite on ansible.readthedocs.

I guess with 2. it depends on what will go into this doc. Will we have new task-based content or will this be more of an FAQ style with links to relevant existing docs?

@Andersson007
Copy link
Contributor Author

@Andersson007

  1. In general I think this doc is an great idea.
  2. What if we put this in the same place as the EE getting started guide? I've been pushing for a more cross-project ecosystem doc and am keen to make use of some of the dev tools user guide material. I know this isn't necessarily cross-project but there is overlap with the dev tools content creator journeys. That content would live in a docsite on ansible.readthedocs.

I guess with 2. it depends on what will go into this doc. Will we have new task-based content or will this be more of an FAQ style with links to relevant existing docs?

@oraNod thanks for the reply

  • my intention is to have very brief explanations there + links to pages on docs.ansible.com
  • how about a separate section on the left bar, like "paths" or whatever? BTW we also have the Ansible contributor path, not sure if it fits though.

@Andersson007
Copy link
Contributor Author

@felixfontein @briantist @mariolenz as you're super experienced in collection development and maintenance, it would be great to hear your feedback on this doc. Is it worth having? Is anything missed?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants