Docs: Update tier badges to reflect Dedicated and GitLab.com
In this issue we had a lengthy discussion about how to update our existing badges to account for the separation between the GitLab.com, GitLab Dedicated, and self-managed offerings.
We have since re-done our tier badges. That work is in progress and should be complete by Friday, Jan 26. Details of the change are here.
After this work is complete, we will work to tag pages as either .com or Dedicated.
Which topics to update
In this spreadsheet I've started a list of pages to review. If a page has the SaaS tier badge, we'll need to review if the page also applies to Dedicated. Yellow means I'm not sure.
This spreadsheet needs assistance from someone on the product team.
https://docs.google.com/spreadsheets/d/138WQy98AM9UJLk0KmZ6oJjyDwyvMeyiQMoh40FpYTkk/edit?usp=sharing
Designs
- Show closed items
Relates to
Activity
-
Newest first Oldest first
-
Show all activity Show comments only Show history only
- Suzanne Selhorn changed milestone to %16.10
changed milestone to %16.10
- Suzanne Selhorn assigned to @sselhorn
assigned to @sselhorn
- Suzanne Selhorn added Technical Writing label
added Technical Writing label
- Maintainer
@sselhorn - please see the following guidance and update this issue.1 Error Please add typebug typefeature, typemaintenance and optionally a subtype label to this issue. If you do not feel the purpose of this issue matches one of the types, you may apply the typeignore label to exclude it from type tracking metrics and future prompts.
This message was generated automatically. You're welcome to improve it.
- Suzanne Selhorn changed the description
Compare with previous version changed the description
- Suzanne Selhorn mentioned in issue gitlab-docs#1751 (closed)
mentioned in issue gitlab-docs#1751 (closed)
- Suzanne Selhorn added maintenancerefactor typemaintenance labels
added maintenancerefactor typemaintenance labels
- Author Maintainer
@fzimmer I started a spreadsheet (linked above) in which I'm trying to determine which pages apply to SaaS but not Dedicated. I'm not quite done yet--probably can't get to this until Friday/Monday--but if you'd like, maybe you can have a look? I can help with updating the docs pages, but I need some help from a subject matter expert. Thanks.
- Suzanne Selhorn assigned to @fzimmer
assigned to @fzimmer
- Suzanne Selhorn added groupdedicated label
added groupdedicated label
added Category:GitLab Dedicated devopsplatforms sectionplatforms labels
- Author Maintainer
@fzimmer This issue is ready for your review. I created a spreadsheet and I need your help. I can make all the changes to the docs, but I need some guidance.
If you can update the spreadsheet with answers to questions, I can proceed with the work. Thanks!
Collapse replies - Developer
Thanks @sselhorn. It will take me until next week to get to this. I'll keep you posted.
1 - Author Maintainer
I would also like your help clarifying things again. I think I've lost track a bit.
When we update the docs in bulk, we will have three main changes.
Change 1: All offerings
Change any badge that has:
**Offering:** SaaS, self-managed
To:
**Offering:** GitLab.com, Self-managed, GitLab Dedicated
Change 2: SaaS to GitLab.com
Change any badge that has:
**Offering:** SaaS
To:
**Offering:** GitLab.com
Change 3: Self-managed to Self-managed and Dedicated
Change any badge that has:
**Offering:** Self-managed
To:
**Offering:** Self-managed, GitLab Dedicated
Does this sound like the correct action for the bulk of pages? Then we can deal with the specific pages in the spreadsheet separately.
Edited by Suzanne Selhorn - Developer
@sselhorn I'm not Fabian, but I can try to answer the questions.
I believe Change 3 is the only thing that might be more of a "it depends". Certainly anything regarding instance-level "admin panel" settings (basically anything where we say you need an admin user) apply to Dedicated as well. However, anything related to setting up self-managed GitLab (install, upgrades, reference architecture, etc.) would not.
- Author Maintainer
@cynthia So we don't end up with a mix of incorrect or inconsistent badges, I'd like to get the questions in the spreadsheet answered.
I asked @susantacker if we should:
- Proceed with a bulk change, knowing that some pages will have incorrect information. Or
- Wait until we hear from someone on the Dedicated team.
We agreed that neither option is ideal, but decided to wait for now. We decided that vague/no information is better than incorrect information.
1 - Developer
@sselhorn agreed, better not to have it. I've added notes where I know at least a partial answer. There are still a few items where for Dedicated it depends on how they're configured, so unsure.
1 - Developer
Apologies @sselhorn for the delay. I went through the spreadhseet and commented on every item.
@sselhorn I'm not Fabian, but I can try to answer the questions.
Even as Fabian I try to do the same
. Clearly, here I was too slow.The three changes sound correct.
Change 1 and Change 3 will need to be checked for Dedicated but that is in the table now. If MRs are being raised, happy to approve each one.
Edited by Fabian Zimmer
- Fiona Neill mentioned in merge request !143053 (merged)
mentioned in merge request !143053 (merged)
- Suzanne Selhorn mentioned in commit dcdc8707
mentioned in commit dcdc8707
- Suzanne Selhorn mentioned in merge request !143843 (closed)
mentioned in merge request !143843 (closed)
- Suzanne Selhorn changed the description
Compare with previous version changed the description
- Suzanne Selhorn mentioned in merge request !144999 (merged)
mentioned in merge request !144999 (merged)
- Suzanne Selhorn mentioned in merge request !144950 (merged)
mentioned in merge request !144950 (merged)
- Developer
@sselhorn I just reviewed the spreadsheet and left a few comments on my thoughts. In each, I suggest a PM that'd be good to follow-up with to confirm.
1 - Fiona Neill mentioned in merge request !145620 (merged)
mentioned in merge request !145620 (merged)
- Suzanne Selhorn mentioned in commit 2ffcca68
mentioned in commit 2ffcca68
- Suzanne Selhorn mentioned in merge request !145850 (merged)
mentioned in merge request !145850 (merged)
- Suzanne Selhorn mentioned in merge request !145854 (merged)
mentioned in merge request !145854 (merged)
- Suzanne Selhorn mentioned in commit 522d638b
mentioned in commit 522d638b
- Suzanne Selhorn mentioned in commit f3d81cd2
mentioned in commit f3d81cd2
- Suzanne Selhorn mentioned in commit ff384c9c
mentioned in commit ff384c9c
- Suzanne Selhorn mentioned in commit 35346a2c
mentioned in commit 35346a2c
- Suzanne Selhorn mentioned in merge request !145856 (merged)
mentioned in merge request !145856 (merged)
- Suzanne Selhorn mentioned in merge request !145857 (merged)
mentioned in merge request !145857 (merged)
- Suzanne Selhorn mentioned in merge request !145858 (merged)
mentioned in merge request !145858 (merged)
- Suzanne Selhorn mentioned in commit a8e64496
mentioned in commit a8e64496
- Suzanne Selhorn mentioned in commit 5eb9739d
mentioned in commit 5eb9739d
- Suzanne Selhorn mentioned in commit b4c0d4e3
mentioned in commit b4c0d4e3
- Suzanne Selhorn mentioned in commit bf77ed02
mentioned in commit bf77ed02
- Suzanne Selhorn mentioned in commit c1dae6f8
mentioned in commit c1dae6f8
- Suzanne Selhorn mentioned in commit 62ec53e0
mentioned in commit 62ec53e0
- Marcel Amirault mentioned in merge request !145832 (merged)
mentioned in merge request !145832 (merged)
- Suzanne Selhorn mentioned in commit ec5f6d92
mentioned in commit ec5f6d92
- Suzanne Selhorn mentioned in merge request !145952 (merged)
mentioned in merge request !145952 (merged)
- Suzanne Selhorn mentioned in commit 53252d06
mentioned in commit 53252d06
- Suzanne Selhorn mentioned in commit 2f25d592
mentioned in commit 2f25d592
- Suzanne Selhorn mentioned in merge request !145953 (merged)
mentioned in merge request !145953 (merged)
- Suzanne Selhorn mentioned in merge request !145955 (merged)
mentioned in merge request !145955 (merged)
- Suzanne Selhorn mentioned in commit 6603153f
mentioned in commit 6603153f
- Suzanne Selhorn mentioned in commit 75eadca5
mentioned in commit 75eadca5
- Suzanne Selhorn mentioned in merge request !145974 (merged)
mentioned in merge request !145974 (merged)
- Suzanne Selhorn mentioned in commit 2418a445
mentioned in commit 2418a445
- Suzanne Selhorn mentioned in merge request !145977 (merged)
mentioned in merge request !145977 (merged)
- Suzanne Selhorn mentioned in commit 32cb53ad
mentioned in commit 32cb53ad
- Suzanne Selhorn mentioned in merge request !145979 (merged)
mentioned in merge request !145979 (merged)
- Suzanne Selhorn mentioned in merge request !145982 (merged)
mentioned in merge request !145982 (merged)
- Suzanne Selhorn mentioned in commit 38faedc9
mentioned in commit 38faedc9
- Suzanne Selhorn mentioned in merge request !145983 (merged)
mentioned in merge request !145983 (merged)
- Suzanne Selhorn mentioned in commit 59adfc4f
mentioned in commit 59adfc4f
- Suzanne Selhorn mentioned in merge request !145985 (merged)
mentioned in merge request !145985 (merged)
- Suzanne Selhorn mentioned in commit c55cf4fd
mentioned in commit c55cf4fd
- Suzanne Selhorn mentioned in merge request !145987 (merged)
mentioned in merge request !145987 (merged)
- Author Maintainer
@fzimmer @cynthia I have updated all the tier information to the best of my ability.
For now, all of the pages under Install and Administer in the left nav are marked as Self-managed only. We can always add Dedicated back if it makes sense.
Here is a spreadsheet of all the pages and all the badges. It would be a huge help to me if you could take a look and see if anything stands out to you as incorrect. I did the best I could with the info I had.
Specifically, please confirm that these pages actually do apply to Dedicated, because we don't want to over-promise:
Self-managed, GitLab Dedicated
GitLab.com, Self-managed, GitLab Dedicated
@bcarranza @weimeng-gtlb I know you had both asked for this work to be done, so you might want to also review the spreadsheet.
All--if you see a page with the wrong badges, please open an MR or note it in the spreadsheet.
Thank you!
Collapse replies - Developer
@sselhorn I have not checked all the links in the spreadsheet but we've had a few GitLab Dedicated customers asking if they can have certain feature flags enabled. I believe this is partly due to the newly added
GitLab Dedicated
tier badges on the relevant docs pages.Would it be possible to make sure we do not add the
GitLab Dedicated
tier badge to any docs page that refers to any of the current feature flags as we do not support these on GitLab Dedicated (https://docs.gitlab.com/ee/subscriptions/gitlab_dedicated/index.html#gitlab-application-features)? - Developer
@ahergenhan We do not support feature flags in Dedicated, so you are correct that we have to go the extra mile here and remove Dedicated from features that are behind feature flags.
- Author Maintainer
@fzimmer Is there anyone on your team who can help with this work? I am assuming I'll have to manually search for the word
flag
and figure out which pages this applies to... - Author Maintainer
I've started some of this work in this MR: !146105 (diffs)
- Author Maintainer
@ahergenhan @fzimmer Should all topics that have feature flag information be listed as not available on Dedicated? Or is it only features where the flag is disabled on self-managed? (
On self-managed GitLab, by default this feature is not available.
)Many topics list feature flags, but the feature is available/the flag enabled.
Edited by Suzanne Selhorn - Author Maintainer
Update: I opened this MR: !146136 (merged) which does the following:
- If a feature flag is disabled for self-managed, I said it's disabled for Dedicated.
- Developer
@fzimmer Is there anyone on your team who can help with this work? I am assuming I'll have to manually search for the word
flag
and figure out which pages this applies to...I am doing what I can but as I said before we are unfortunately at capacity.
- Developer
If a feature flag is disabled for self-managed, I said it's disabled for Dedicated.
Any feature flag that is off by default and would need to be manually enabled is not available.
1
- 🤖 GitLab Bot 🤖 added customer label
added customer label
- Suzanne Selhorn mentioned in commit ef0baac6
mentioned in commit ef0baac6
- Suzanne Selhorn mentioned in merge request !146105 (merged)
mentioned in merge request !146105 (merged)
- Suzanne Selhorn mentioned in commit ed8c5b4c
mentioned in commit ed8c5b4c
- Marcin Sedlak-Jakubowski mentioned in merge request !146111 (merged)
mentioned in merge request !146111 (merged)
- Suzanne Selhorn mentioned in commit 03a092e1
mentioned in commit 03a092e1
- Suzanne Selhorn mentioned in merge request !146119 (merged)
mentioned in merge request !146119 (merged)
- Author Maintainer
Pages/topics in question - drafting list--
Page/topic Stage/group Question Confirmed/fixed Group Releases API Deploy/Environments It says GitLab.com but the flag info doesn't mention .com. Is it just self-managed of does it include GitLab.com? (It can't be dedicated because the flag is off.) yes GitGuardian Create/Source Code Is this feature available on Dedicated? The flag is on, so I would think yes? If so we need to update the flag. yes Group SSH Certs Create/Source Code Flag says not avail for .com, Offering says .com. I assume it's disabled everywhere and not available for Dedicated or self? yes Sourcegraph Create/Source Code The flag text should specify what's up with Dedicated, but I wasn't sure if I should say it's available now. Integrations - Google Package/Container Registry Flag says not avail for .com, Offering says .com. Also on same page, topic called Google Cloud Identity and Access Management yes Member roles Govern/Auth I changed to be SM only, but not 100% sure if that was right yes Identity verification Govern/Anti-Abuse The flag doesn't mention SaaS, so I'm not sure if the offerings are correct. For now I removed .com. Need to confirm that it is SM only. I think it likely is. Yes Analytics API Monitor/Product Analytics I changed to be SM only, but not 100% sure. yes Tracing Monitor/Observability This flag doesn't mention if the feature is available for .com or Dedicated. (If it is, the tier badge needs to be updated.) Dashboards Monitor/Product Analytics Is the FLAG note correct? If it's available for SM, it should be available for Dedicated, and we should add Dedicated to the offering list. yes Markdown API Plan/Project Mgmt I assume this feature is available on Dedicated because it's available on SM. Is that right? (I updated it to add the Dedicated info.) yes DORA panel Plan/Optimize The FLAG says it's available on self-managed, so I added yes for Dedicated too. OKRs Plan/Product Planning Are the offerings and flags listed on this page correct? Specifically this one topic, but others too. Is Dedicated supported? yes Import from remote storage Manage/Import and integrate I assume this topic applies to all. I wonder if the flag status is still accurate. Edited by Lorena Ciutacu Collapse replies - Maintainer
@sselhorn I've started asking about some of these:
-
doc/api/group_releases.md
: #443760 (comment 1794556919) -
doc/api/group_ssh_certificates.md
: #443760 (comment 1794557884)
Edited by Marcel Amirault -
- Developer
@msedlakjakubowski @lciutacu @jglassman1 @eread @phillipwells Can you take a look at the pages for your areas that @sselhorn has listed above and help confirm/answer the questions about Dedicated support for these features?
2 - Maintainer
Thanks, I asked about the Plan features in Slack.
- Maintainer
https://docs.gitlab.com/ee/user/project/integrations/git_guardian.html now has correct info: !146111 (merged)
1 - Maintainer
@sselhorn https://docs.gitlab.com/ee/api/markdown.html is correct - available for Dedicated.
1 - Maintainer
https://docs.gitlab.com/ee/user/okrs.html#linked-items-in-okrs - Amanda Rueda confirms it:
Yep, it's my understanding that OKRs are behind a feature flag on dedicated as well.
1 - Maintainer
I asked the PM/EM of groupproduct analytics for confirmation.
1 I've asked the PM and EM of groupimport and integrate for confirmation.
1
- Suzanne Selhorn mentioned in commit 2b981ad1
mentioned in commit 2b981ad1
- Suzanne Selhorn mentioned in merge request !146126 (merged)
mentioned in merge request !146126 (merged)
- Suzanne Selhorn mentioned in commit 5b2d8a2a
mentioned in commit 5b2d8a2a
- Suzanne Selhorn mentioned in merge request !146136 (merged)
mentioned in merge request !146136 (merged)
- Marcel Amirault mentioned in issue #443760 (closed)
mentioned in issue #443760 (closed)
- Suzanne Selhorn mentioned in commit 3a14f861
mentioned in commit 3a14f861
- Marcel Amirault marked this issue as related to #443760 (closed)
marked this issue as related to #443760 (closed)
- Maintainer
@mcbabin @andr3 Hi! Suzanne is confirming features available for Dedicated. Could you confirm whether Sourcegraph is? https://docs.gitlab.com/ee/integration/sourcegraph.html
The flag text should specify what's up with Dedicated, but she wasn't sure if she should say it's available now.
- Maintainer
@sselhorn For https://docs.gitlab.com/ee/api/member_roles.html, @alexbuijs has confirmed that it is available for both self-managed and GitLab.com (thank you Alex). So, this needs amending. Are you doing any changes as part of one MR, or are we good to change it ourselves?
Collapse replies - Author Maintainer
@jglassman1 Would you open an MR for this update please?
1 - Maintainer
- Jon Glassman mentioned in merge request !146219 (merged)
mentioned in merge request !146219 (merged)
- Phillip Wells mentioned in merge request !146222 (merged)
mentioned in merge request !146222 (merged)
- MaintainerResolved by Suzanne Selhorn
Creating a thread to track my MRs.
9 replies Last reply by Phillip Wells
- Suzanne Selhorn mentioned in merge request !146229 (merged)
mentioned in merge request !146229 (merged)
- Phillip Wells mentioned in merge request !146232 (merged)
mentioned in merge request !146232 (merged)
- Suzanne Selhorn mentioned in commit a191abbc
mentioned in commit a191abbc
- Suzanne Selhorn mentioned in merge request !146371 (merged)
mentioned in merge request !146371 (merged)
- Author Maintainer
@fzimmer @cynthia Do either of you know--if an API requires admin access, does that mean it doesn't apply to Dedicated?
I'm going through the spreadsheet I created and I think there are likely inaccuracies, but I'm struggling to figure out which API apply to Dedicated and which don't.
Should I mark all API as not Dedicated for now? I'd rather have no information than incorrect information.
Collapse replies - Developer
Dedicated allows admins so the admin APIs are available on GitLab Dedicated.
- Developer
That's correct.
- Suzanne Selhorn mentioned in commit 421204fe
mentioned in commit 421204fe
- Suzanne Selhorn mentioned in commit 0d2bf833
mentioned in commit 0d2bf833
- Suzanne Selhorn mentioned in merge request !146381 (merged)
mentioned in merge request !146381 (merged)
- Suzanne Selhorn mentioned in commit bc7f8929
mentioned in commit bc7f8929
- Suzanne Selhorn mentioned in merge request !146391 (merged)
mentioned in merge request !146391 (merged)
- Suzanne Selhorn mentioned in commit gitlab-runner@fc717c8f
mentioned in commit gitlab-runner@fc717c8f
- Suzanne Selhorn mentioned in merge request gitlab-runner!4666 (merged)
mentioned in merge request gitlab-runner!4666 (merged)
- Author Maintainer
Note to self:
- Runner MR here: gitlab-runner!4666 (merged)
- Charts is all about installing GitLab, so I'm going to assume it's self-managed only.
- Operator is also about installing GitLab, so I'm going to assume it's self-managed only.
- Omnibus, same.
So this should cover all the repos other than the main GitLab one.
I haven't enabled the Vale rule in any repos other than the main one yet. Still need to do.
- Suzanne Selhorn mentioned in commit d786dcda
mentioned in commit d786dcda
- Suzanne Selhorn mentioned in commit gitlab-runner@ac01f52e
mentioned in commit gitlab-runner@ac01f52e
- Suzanne Selhorn mentioned in merge request gitlab-runner!4671 (merged)
mentioned in merge request gitlab-runner!4671 (merged)