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

Clarifying TAG APP Delivery's Artifacts Working group's documentation and repositories #570

Open
6 tasks
riaankleinhans opened this issue Mar 4, 2024 · 1 comment
Assignees

Comments

@riaankleinhans
Copy link
Contributor

Two active repositories being used by TAG APP Delivery's Artifacts Working group

At the moment Artifacts Working Group is maintaining parallel repos, not named exactly the same, in two different Organizations cncf tag-app-delivery - Artifacts-WG & cncf-tags WG Artifacts with duplicate information that is already slightly out of sync with miss matching of README and Charter content across repos.

Ideal State

Working groups are created under Technical Advisory Groups and normally have their folder and documents in an appropriately named folder under the TAG's repository. The README would typically give an overview of the WG, meetings and leadership information, communication channels and link to a WG charter in a separate document in the WG folder.
Other related documents should be organized within the WG folder.

The Github Organization CNCF-TAGS was created for TAGs to host code projects and tooling related to TAGs or Working Groups work. However the main repository for the TAG / WG should stay under the Github CNCF Organisation.

Proposed changes:

  • Consolidate README and Charter information for the Artifacts WG in the cncf/tag-app-delivery/artifacts-wg folder.
  • Consider if the wg-artifacts repo is needed

If wg-artifacts repo is needed for code:

  • Consider renaming wg-artifacts to artifacts-wg to match the naming convention across the cncf repo.
  • Update the README in the cncf-tag / wg-artifacts repo to explain the purpose of the repo and the work being done in the repo. Link back to the cncf/tag-app-delivery/artifacts-wg for README & Charter information related to the WG.
  • Add a hyperlinked section to the main Artifacts Working Group repo README to briefly explain that work in being done in another repo.
  • The repo contain a lot of empty templated files and folders. Consider deleting content that would not be used.
@riaankleinhans
Copy link
Contributor Author

/cc @AloisReitbauer

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🆕 New
Development

No branches or pull requests

3 participants