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

Bootstrap files to document the TAG formation #1086

Merged

Conversation

leonardpahlke
Copy link
Member

This PR adds folders and files to cncf/toc/tags/resources/*** documenting templates and guides used to form TAGs and supporting files used by TAGs to support the TOC.

The files are marked with *tbd* - contributions are welcome!, the contents are added in upcoming PRs. Establishing the structure and stub files should make it easier to collaborate on this effort.

This has been coordinated with the issue #1043 see comment.

cc @TheFoxAtWork

@jberkus
Copy link
Contributor

jberkus commented Jun 17, 2023

Hey, Leo, good first stab at giving this some structure. I'm seeing a lot of documents as "templates" that no current TAG has, and a few that seem duplicative ("contributing" and "roles") for example. I think it would help a lot to outline what content needs to go into each of these documents, or even write it.

It will also help to separate formation templates from how-to-run-a-tag documents (some of which already exist elsewhere, I believe). Smaller PRs are better.

@leonardpahlke
Copy link
Member Author

leonardpahlke commented Jun 19, 2023

👍 good input.

Yes, the idea was to structure the files without adding content just yet. We add and discuss the content and exact wording in the follow-up PRs. By setting the structure first, I try to enable others to share the work.


I think it would help a lot to outline what content needs to go into each of these documents, or even write it.

Yes! It makes sense to discuss the file outline, since it's just mentioned in this comment without a discussion yet. 👍

tag-formation-templates/

The template files are based on existing files (see list below). Does this give a more clear picture?

Templates:

tag-formation-guides/

The guide files are new. Currently, I don't have a reference. I think as a headline, these two files make sense. I need to read up literature, blogs etc. to share a clearer picture of each file outline.

TAG Formation Guides:

  • TAG charter document writing guide (guide-tag-formation-roadmap.md): new file (currently, I don't have an outline to share)
  • TAG formation Road Map (guide-writing-charter.md): new file (currently I don't have an outline to share)

toc-supporting-guides/

As for the TOC-supporting guides, we will cover them in a future issue (see comment). This PR adds the structure already as mentioned in the comment.

You can stub it out as a folder structure with README to encourage TAGs to contribute those kinds of files to that folder and provide some ideas of what kind of things go in there

TOC Supporting Guides:


It will also help to separate formation templates from how-to-run-a-tag documents (some of which already exist elsewhere, I believe)

Right, with the structure proposed in this PR we achieve this.

  • tag-formation-guides/: docs for new TAGs (or TAGs that reinvent their charter)
  • tag-formation-templates/: docs for new TAGs (or TAGs that reinvent their charter)
  • toc-supporting-guides/: docs for "established" TAGs

Would you structure it differently?

@leonardpahlke
Copy link
Member Author

leonardpahlke commented Jun 22, 2023

@jberkus would you prefer to add the content of the subfiles already with this PR? I could do that for the template files tag-formation-templates/.

@leonardpahlke
Copy link
Member Author

@TheFoxAtWork, what do you think about how to proceed with this PR? I would love to wrap it up soon.

Copy link
Contributor

@TheFoxAtWork TheFoxAtWork left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - Thank you for taking the time to stub out this new structure! I look forward to having more content added to assist our current and future TAGs executing their work!

@TheFoxAtWork
Copy link
Contributor

@cncf/cncf-toc Looking for at least one other reviewer. This PR provides a placeholder files and directory structure for guides, templates, and resources to assist our TAGs in performing their work, engaging projects and the community, and will provide guidance for individuals interested in establishing a new TAG.

Copy link
Member

@nikhita nikhita left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LOVE how detailed this is! Thank you so much @leonardpahlke!

LGTM with TOC hat on.

Copy link
Contributor

@RichiH RichiH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@leonardpahlke
Copy link
Member Author

For the looks of it, we can merge this PR. Thanks for taking a look all 👍

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.

5 participants