[go: up one dir, main page]

Scope needed docs work for project templates repos

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Problem to solve

The sub-groups in https://gitlab.com/gitlab-org/project-templates are owned by groupsource code, and they all have READMEs explaining them. Amy can't determine if they're out of date / wrong, but she CAN determine they're inconsistent and need cleanup + polish. Let's determine and scope out what needs doing; Amy can work in parallel with engineers but can't finish the work without their knowledge.

Further details

Some items we should consider before diving in:

  • https://docs.gitlab.com/ee/user/project/working_with_projects.html belongs to ~"group::workspace" and Amy should tread lightly here. However, we should make sure this page stays in sync with whatever we do.
  • Should Amy get maintainer access to the individual projects, so she can approve docs changes? (Similar to gitlab-com/www-gitlab-com!113589 (merged))
  • Should Amy add a CODEOWNERS entry for herself for the READMEs?
  • Before we start, should we create a meta-template for the READMEs, or should we assume their needs are different enough to make a common structure invalid? (If yes, Amy can help!)
  • Should we create an epic (then one child issue per repo) to track the cleanup work, or should we just make a set of issues?

Proposal

Talk with @sean_carroll and @tlinz to figure out what the plan is.

Who can address the issue

Other links/references

Edited by 🤖 GitLab Bot 🤖