Clarify "GitLab Team Member License request" issues description requestor steps
Request for comments
Need
We need to update the Requestor section of the license request section to accurately address next steps once the license is received depending on license / environment.
The current template created for GitLab Team Member License requests can be confusing for people setting up a new environment. At this time, installing a local version of GitLab through Omnibus and applying the internal licenses with no further action will result in an error that your license key is invalid. The current Requestor section of the description focuses on this issue for GDK installations only. These steps seem to be out of date and do not apply for non-GDK installations.
I'm not sure of the extent of license types generated through these requests, so looking for feedback on other licensing situations and which documentation to point at.
These are the currently documented steps for applying licenses that I've run into:
Approach
Update Requestor text to...
### Requestor:
After your license has been generated, search for the subject `Your GitLab License File` in your e-mail.
Ensure that you have the correct environment variables set for the license type to avoid an error that your license key is invalid
- [Staging License](https://docs.gitlab.com/omnibus/development/setup.html#use-customers-portal-staging-in-gitlab)
- [GDK](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/index.md#configure-developer-license-in-gdk)
To add the new license to your instance follow these [docs](https://docs.gitlab.com/ee/user/admin_area/license_file.html)
Benefit
- We'll be linking to SSOT rather than documenting troubleshooting steps directly in the issue template
- More accurate instructions since the current steps for GDK are not accurate.
- Less time wasted by people troubleshooting issues with their license during initial installs.
Competition / Alternatives
- Leave description as is. The number of users who would be setting up an initial installation without the right configs is low, but are generally new hires, so it can be a frustrating experience. Then again...
- Remove the Requestor section and leave it to the current comment information from Ops when the work is completed. This comment does not address the licensing error however, so people could still end up confused.