Spike: Information organization and discoverability for new contributors
Summary
New contributors and Distribution team members have a few places to go looking for information. It is confusing.
Background
We have been adding documentation over many years to various places in the handbook and our projects. Due to this, it is difficult to discover information about how to contribute to Distribution team projects.
We added a self service framework page in gitlab-org/omnibus-gitlab#6195 (closed), however, even with that in place the landing page is difficult to find/navigate.
Expected outcomes
- Identify each location where Distribution contributor information is located today in the handbook and across all projects
- Create a new spike that contains the proposed contributor concepts that will become sub/epics or sub tasks of the main epic for discussion by team and technical writing
- Create any new issues that may be needed as identified during this spike
Deliverables
- Locations containing Distribution Contributor Information
- Handbook
- Main Docs site
- Charts Development
- Omnibus GitLab
- Package Licensing as part of the install section
- Install section
- Code Repositories
- Packaged GitLab
- Components used to build GitLab packages
- Team Tools
- List of concepts and tasks to document for review by Distribution, contributors, and technical writing
- Issues to address topics out of scope that appeared during this spike
- Spike: Information Organization and discoverability for installation and configuration
- [Spike: Determine where to place the Distribution Contributor Main Landing Page for Discoverability]
- there are more stakeholders on this issue than previously anticipated, so this is now branched off to ensure it has clear discussion separate from the content discussion
Edited by Robert Marshall