Geo: Provide better licensing information in Admin Panel
Problem to solve
When navigating to the Geo Panel in the Admin area on a GitLab instance without a GitLab Premium license the following banner is shown:
This information is not actionable for system administrators because it does not contain sufficient information. It does not state what license is required, what license is currently in use, nor does it provide a link to additional information.
Intended users
Further details
- Providing additional information makes it easier to access the licensing information
- Goal is to be transparent and allow a system administrator to investigate further from this page
Proposal
As a system administrator I would like to have access to information regarding my current licence, what license is required to use Geo and a link to access more detailed information.
Potential solution:
Rephrase You need a difference license to use Geo replication
to You are currently on a %{current_GitLab_license}. GitLab is only available for users who have at least %{minium_geo_license}. Find out [how to upgrade](Link to license page)
.
%{} denotes some variable.
Permissions and Security
Documentation
N/A
Testing
Risk is that we need a system to ensure that license information is not hard-coded and becomes stale.
What does success look like, and how can we measure that?
- Track how many users follow the link on that page
- Success is more licensing (How to measure?)
What is the type of buyer?
*Premium
Proposed design
- This alerts appears only the current license is premium+.
-
Reference: Alert component
Links / references
Designs
- Show closed items
- Issue#35247014.81Category:Fuzz Testing GitLab Ultimate Technical Writing UX devops application security testing feature enhancement frontend fuzzing coverage group dynamic analysis section sec tw finished type feature workflow production
- Issue#35246514.81auto updated devops application security testing frontend section sec
- Issue#35207314.8Category:Fuzz Testing GitLab Ultimate backend devops application security testing feature enhancement fuzzing coverage group dynamic analysis section sec type bug workflow verification
- Issue#35163214.8Category:Fuzz Testing GitLab Ultimate devops application security testing feature enhancement frontend fuzzing coverage group dynamic analysis section sec type feature workflow verification
- Issue#35153914.8Category:Fuzz Testing GitLab Ultimate devops application security testing feature enhancement frontend fuzzing coverage group dynamic analysis section sec type feature workflow verification
- Issue#35097514.82Category:Fuzz Testing GitLab Ultimate devops application security testing feature enhancement frontend fuzzing coverage group dynamic analysis section sec type feature workflow verification
- Issue#35097414.82Category:Fuzz Testing GitLab Ultimate devops application security testing feature enhancement frontend fuzzing coverage group dynamic analysis section sec type feature workflow in dev
- Issue#34901414.8Category:Fuzz Testing GitLab Ultimate devops application security testing feature flag frontend fuzzing coverage group dynamic analysis missed:14.7 section sec type feature workflow in dev
- Issue#34748314.7Category:Fuzz Testing GitLab Ultimate devops application security testing feature enhancement frontend fuzzing coverage group dynamic analysis missed:14.6 section sec type bug workflow verification
- Issue#34509014.73Category:Fuzz Testing GitLab Ultimate devops application security testing feature enhancement frontend fuzzing coverage group dynamic analysis section sec type feature workflow verification
- Issue#34508914.73Category:Fuzz Testing auto updated devops application security testing frontend group dynamic analysis section sec workflow verification
- Issue#34508814.63Category:Fuzz Testing GitLab Ultimate devops application security testing feature enhancement frontend fuzzing coverage group dynamic analysis missed:14.5 section sec type feature workflow verification
- Issue#34148614.55Category:Fuzz Testing backend devops application security testing feature addition fuzzing coverage group dynamic analysis section sec type feature
- Issue#34148514.55Category:Fuzz Testing backend devops application security testing feature addition fuzzing coverage group dynamic analysis section sec type feature
- Issue#34148914.82Category:Fuzz Testing Technical Writing backend devops application security testing documentation feature addition fuzzing coverage group dynamic analysis missed:14.6 missed:14.7 section sec tw-weight 8 type feature
- Issue#34148714.65Category:Fuzz Testing backend devops application security testing feature enhancement fuzzing coverage group dynamic analysis section sec type feature
- Issue#34258014.62Category:Fuzz Testing GitLab Ultimate devops application security testing feature enhancement frontend fuzzing coverage group dynamic analysis missed:14.5 section sec type feature workflow verification
- Issue#34258314.82Category:Fuzz Testing GitLab Ultimate devops application security testing feature enhancement frontend fuzzing coverage group dynamic analysis missed:14.6 missed:14.7 section sec type feature workflow verification
- Issue#34243314.63Category:Fuzz Testing GitLab Ultimate devops application security testing feature enhancement frontend fuzzing coverage group dynamic analysis missed:14.5 section sec type feature workflow verification
- Issue#34133814.4automation:ml devops package group package registry section ops
- Issue#34121814.6Category:Package Registry Generic Package Repository auto updated devops package fuzzing coverage group package registry missed:14.4 missed:14.5 section ops
- Epicgitlab-org#668323Dec 18, 2021 – Jan 17, 2022Category:Fuzz Testing backend devops create frontend fuzzing coverage group dynamic analysis missed:14.2 section sec
- Issue#33973214.5Category:Fuzz Testing GitLab Ultimate backend devops application security testing direction fuzzing coverage group dynamic analysis missed:14.3 missed:14.4 section sec type feature workflow in dev
- Epicgitlab-org#640647Jul 18 – Aug 17, 2021Category:Fuzz Testing Deliverable GitLab Ultimate devops application security testing frontend fuzzing coverage group dynamic analysis section sec type feature
- Issue#33494114.7Category:Fuzz Testing Technical Writing backend devops application security testing documentation fuzzing coverage group dynamic analysis missed:14.2 missed:14.3 missed:14.4 missed:14.5 missed:14.6 section sec tw-weight 5 workflow refinement
- Issue#27316914.2Category:Fuzz Testing devops application security testing fuzzing coverage group dynamic analysis missed:13.8 section sec
- Issue#32689513.113Category:Fuzz Testing Deliverable GitLab Ultimate devops application security testing direction frontend fuzzing coverage group dynamic analysis missed-deliverable missed:13.10 section sec type feature workflow in review
- Issue#32689613.112Category:Fuzz Testing Deliverable GitLab Ultimate devops application security testing direction frontend fuzzing coverage group dynamic analysis missed-deliverable missed:13.10 section sec type feature workflow in review
- Issue#32689413.111Category:Fuzz Testing Deliverable GitLab Ultimate devops application security testing direction frontend fuzzing coverage group dynamic analysis missed-deliverable missed:13.10 section sec type feature workflow verification
- Issue#28059213.112Category:Fuzz Testing Deliverable GitLab Ultimate backend devops application security testing direction fuzzing coverage group dynamic analysis section sec type feature workflow in dev
- Issue#32636113.113Category:Fuzz Testing Deliverable GitLab Ultimate backend devops application security testing direction fuzzing coverage group dynamic analysis section sec type feature workflow in dev
- Issue#32636213.112Category:Fuzz Testing Deliverable GitLab Ultimate backend devops application security testing direction fuzzing coverage group dynamic analysis section sec type feature workflow in dev
- Issue#29444413.113Category:Fuzz Testing Deliverable GitLab Ultimate devops application security testing direction frontend fuzzing coverage group dynamic analysis missed-deliverable missed:13.10 section sec type feature workflow verification
- Issue#32161814.3Category:Fuzz Testing backend devops create frontend fuzzing coverage group dynamic analysis missed:14.2 section sec
- Issue#32789714.52Category:Fuzz Testing GitLab Ultimate devops application security testing frontend fuzzing coverage group dynamic analysis section sec type feature workflow production
- Issue#32088613.103Category:Fuzz Testing GitLab Ultimate devops application security testing direction frontend fuzzing coverage group dynamic analysis section sec workflow verification
- Issue#29954413.101Category:Fuzz Testing Deferred UX Deliverable UX devops create frontend group dynamic analysis workflow in dev
- Issue#29442513.92Category:Fuzz Testing GitLab Ultimate backend devops application security testing direction frontend fuzzing coverage group dynamic analysis section sec type feature workflow production
- Issue#28059314.32Category:Fuzz Testing GitLab Ultimate backend devops application security testing direction frontend fuzzing coverage group dynamic analysis section sec type feature workflow production
- Issue#28059013.9Category:Fuzz Testing backend devops application security testing fuzzing coverage group dynamic analysis missed:13.7 section sec type feature workflow ready for development
- Issue#32841814.8Category:Fuzz Testing GitLab Ultimate devops application security testing feature flag frontend fuzzing coverage group dynamic analysis missed:14.7 section sec type feature
- Issue#29074113.10Category:Fuzz Testing Deliverable devops application security testing fuzzing coverage group dynamic analysis missed-deliverable missed:13.8 section sec workflow verification
- Issue#268004Category:Fuzz Testing GitLab Ultimate UX FY21-Q4 backend devops application security testing direction feature enhancement frontend fuzzing coverage group dynamic analysis section sec secure:refinement-backend secure:refinement-frontend type feature workflow refinement
- Issue#32847514.2Category:Fuzz Testing Deliverable GitLab Ultimate devops application security testing frontend fuzzing coverage group dynamic analysis section sec type feature workflow refinement
Relates to
Activity
-
Newest first Oldest first
-
Show all activity Show comments only Show history only
- Fabian Zimmer added typefeature + 1 deleted label
added typefeature + 1 deleted label
- Fabian Zimmer added Geo Administration UI component labels
added Geo Administration UI component labels
- Fabian Zimmer marked this issue as related to #11722 (closed)
marked this issue as related to #11722 (closed)
- Developer
It would definitely be better to provide more licensing information so that users know which license is appropriate here.
In line with Iteration, please could we separate this into two issues:
- change the text and add the link
- add ability to track clicks on the link
- 🤖 GitLab Bot 🤖 mentioned in issue #11773 (closed)
mentioned in issue #11773 (closed)
- Fabian Zimmer changed milestone to %12.2
changed milestone to %12.2
- 🤖 GitLab Bot 🤖 added [deprecated] Accepting merge requests label
added [deprecated] Accepting merge requests label
- Rachel Nienaber added to epic &369 (closed)
added to epic &369 (closed)
- Fabian Zimmer added devopssystems label
added devopssystems label
- Maintainer
Setting groupgeo based on Geo Administration.
- 🤖 GitLab Bot 🤖 added groupgeo label
added groupgeo label
- 🤖 GitLab Bot 🤖 added Enterprise Edition label
added Enterprise Edition label
- Fabian Zimmer removed 1 deleted label
removed 1 deleted label
- Rachel Nienaber added frontend workflowready for development labels
added frontend workflowready for development labels
- Sunjung Park added UX label and removed frontend workflowready for development labels
added UX label and removed frontend workflowready for development labels
- Sunjung Park assigned to @sunjungp
assigned to @sunjungp
- Fabian Zimmer changed milestone to %12.7
changed milestone to %12.7
- Fabian Zimmer added workflowdesign + 1 deleted label
added workflowdesign + 1 deleted label
- Sunjung Park removed workflowdesign label
removed workflowdesign label
- Sunjung Park added workflowdesign label
added workflowdesign label
- Sunjung Park changed the description
Compare with previous version changed the description
- Developer
Proposed Design
This is the proposed design after conducting a quick-preference test with 5 people.
@eread Could you review the copy on the alert?
@zcuddy @fzimmer @rnienaber After the review, I will put the design spec with the updated version.
Collapse replies Looks mainly good. Not sure what the value of
%{current_GitLab_license}
, and if that sentence structure will always work. For example, it might be one of the following:Core
Starter
Premium
-
Ultimate
.
In which case you could end up with
You are currently on a Ultimate
, which isn't the best.You could avoid naming the current license altogether (it's available on another screen) and say:
Geo requires Premium or higher.
The implication is that the prerequisite isn't met, and this sentence will work all the time.
If you definitely want to name the license here, maybe something like:
This GitLab instance is licensed at the `%{current_GitLab_license}` tier. Geo is only...
This would also work, depending on possible values of
%{current_GitLab_license}
.- Author Developer
- Author Developer
The proposed design looks way better than what we had before.
2 - Developer
Agree with @fzimmer!
As far as I remember, the alert disappears when the license is premium+
If it is this case, we can use this version
This GitLab instance is licensed at the `%{current_GitLab_license}` tier. Geo is only...
and the alert will appear with the current license ofcore
orstarter
.But if not, I also vote for the
Geo requires Premium or higher.
- Maintainer
We have access to the license name so this should be pretty straight forward from a technical side
https://docs.gitlab.com/ee/api/license.html
This looks great @sunjungp !
Edited by Zack Cuddy 1 - Developer
Thanks for checking this out @zcuddy!
@fzimmer so before exporting it to the spec, I summarized the discussion below.
The message would be:
This GitLab instance is licensed at the Core tier. Geo is only available for users who have at least a Premium license.
This GitLab instance is licensed at the Starter tier. Geo is only available for users who have at least a Premium license.
If users already have the Premium+ license,
- Let's not show the alert.
OR
- Show the alert with the same design and a different message:
This GitLab instance is licensed at the Premium tier. You can start using Geo now!
Something like this.
We can go for the option two in this case, but I am not so sure about this is a consistent behavior considering other pages.
And the button will lead users to land on the license management page.
- Author Developer
I suggest we don't show any banner if the license already allows using Geo. This will reduce any visual "clutter"
And yes, the messages look correct. Thank you
1 - Developer
- Sunjung Park marked this issue as related to gitlab-design#760 (closed)
marked this issue as related to gitlab-design#760 (closed)
- Evan Read added Technical Writing UI text labels
added Technical Writing UI text labels
- 🤖 GitLab Bot 🤖 removed [deprecated] Accepting merge requests label
removed [deprecated] Accepting merge requests label
- Sunjung Park added 1 deleted label and removed 1 deleted label
added 1 deleted label and removed 1 deleted label
- Sunjung Park added 1 deleted label and removed 1 deleted label
added 1 deleted label and removed 1 deleted label
- Sunjung Park mentioned in commit gitlab-design@b1894041
mentioned in commit gitlab-design@b1894041
- Sunjung Park changed the description
Compare with previous version changed the description
- Developer
Collapse replies - Author Developer
Great work! Looking forward to the implementation :)
1
- Sunjung Park added workflowready for development label and removed workflowdesign label
added workflowready for development label and removed workflowdesign label
- Sunjung Park added 1 deleted label and removed 1 deleted label
added 1 deleted label and removed 1 deleted label
- Fabian Zimmer unassigned @sunjungp
unassigned @sunjungp
- 🤖 GitLab Bot 🤖 added [deprecated] Accepting merge requests label
added [deprecated] Accepting merge requests label
- Zack Cuddy added frontend label
added frontend label
- Zack Cuddy assigned to @zcuddy
assigned to @zcuddy
- Zack Cuddy added workflowin dev label and removed workflowready for development label
added workflowin dev label and removed workflowready for development label
- Zack Cuddy mentioned in merge request !22933 (merged)
mentioned in merge request !22933 (merged)
- 🤖 GitLab Bot 🤖 removed [deprecated] Accepting merge requests label
removed [deprecated] Accepting merge requests label
- Zack Cuddy added workflowblocked label and removed workflowin dev label
added workflowblocked label and removed workflowin dev label
- Maintainer
Blocked behind #197113 (closed)
- 🤖 GitLab Bot 🤖 changed milestone to %12.8
changed milestone to %12.8
- 🤖 GitLab Bot 🤖 added missed:12.7 label
added missed:12.7 label
- Zack Cuddy mentioned in issue #119335 (closed)
mentioned in issue #119335 (closed)
- Michael Kozono mentioned in issue #199090 (closed)
mentioned in issue #199090 (closed)
- Developer
Since the related blocking issue is now closed, I'm going to move this back to ready for development.
- Rachel Nienaber added workflowready for development label and removed workflowblocked label
added workflowready for development label and removed workflowblocked label
- Zack Cuddy added workflowin review label and removed workflowready for development label
added workflowin review label and removed workflowready for development label
- Rémy Coutable closed via merge request !22933 (merged)
closed via merge request !22933 (merged)
- Rémy Coutable mentioned in commit ff168740
mentioned in commit ff168740
- Fabian Zimmer mentioned in merge request gitlab-com/www-gitlab-com!40500 (merged)
mentioned in merge request gitlab-com/www-gitlab-com!40500 (merged)
- Rachel Nienaber added release post item label
added release post item label
- Rachel Nienaber added workflowverification label and removed workflowin review label
added workflowverification label and removed workflowin review label
- Rachel Nienaber reopened
reopened
- Sunjung Park mentioned in issue gitlab-design#760 (closed)
mentioned in issue gitlab-design#760 (closed)
- Rachel Nienaber closed
closed
- Rachel Nienaber removed workflowverification label
removed workflowverification label
- Rachel Nienaber added workflowverification label and removed 1 deleted label
added workflowverification label and removed 1 deleted label
- Rachel Nienaber removed workflowverification label
removed workflowverification label
- Rachel Nienaber mentioned in issue gitlab-org/geo-team/discussions#4863 (closed)
mentioned in issue gitlab-org/geo-team/discussions#4863 (closed)
- Jacki Bauer added UX scorecard-rec label
added UX scorecard-rec label