Repository navigation
Update license key docs to match the Product license page - #2073
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Direct preview links to pages changed in this PR: |
938a4c7 to
c8a2069
Compare
c8a2069 to
382a5f0
Compare
| 1. Go to **Administration → Configuration → Product license** (`/admin/license`). | ||
| 2. Under **Update license key**, paste the new key into the **License key** field. | ||
| 3. Click **Validate & apply license key**. Sourcegraph checks the key and rejects one that is invalid or expired. | ||
| 4. In the **Confirm license update** dialog, compare the current license with the new one (customer, plan, seat count, and expiry date), then click **Confirm & apply license**. |
There was a problem hiding this comment.
I feel like out of these 4 steps, only the first one is really needed right? Once you get to the page the rest should be self-explanatory
There was a problem hiding this comment.
What about:
1. Go to **Administration → Configuration → Product license** (`/admin/license`).
2. Under **Update license key**, paste the new key into the **License key** field. You will be taken through a series of steps to validate and confirm the new license before applying to the instance
There was a problem hiding this comment.
Mainly that I want it to be clear there are some steps after you input the license key and that these should be checked. Open to suggestions though
There was a problem hiding this comment.
My suggestion would be something like:
Go to Administration → Configuration → Product license (
/admin/license). Here, you can update your license key, view details of your current license, and more.
There was a problem hiding this comment.
If you land on that page and can't figure out how to update the key we probably have a problem 😆
There was a problem hiding this comment.
Fair, shortened things here.
|
|
||
| Any current Administrator can update your license key by going to Administration -> [Advanced configuration](/admin/config/site-config) | ||
| <Callout type="note"> | ||
| On [Sourcegraph Cloud](/cloud/#how-do-we-update-our-license-key), Sourcegraph manages your license key and the **Product license** page doesn't show the **Update license key** form. To apply a new or renewed license, contact your Sourcegraph account team or [[email protected]](mailto:[email protected]). |
There was a problem hiding this comment.
| On [Sourcegraph Cloud](/cloud/#how-do-we-update-our-license-key), Sourcegraph manages your license key and the **Product license** page doesn't show the **Update license key** form. To apply a new or renewed license, contact your Sourcegraph account team or [[email protected]](mailto:[email protected]). | |
| On [Sourcegraph Cloud](/cloud/#how-do-we-update-our-license-key), Sourcegraph manages your license key. To apply a new or renewed license, contact your Sourcegraph account team or [[email protected]](mailto:[email protected]). |
| Sourcegraph's Kubernetes deployment [requires an Enterprise license key](https://about.sourcegraph.com/pricing). | ||
|
|
||
| Once you have a license key, add it to your [advanced configuration](/admin/config/site-config). | ||
| Once you have a license key, add it on the **Product license** page. See [How can we update our license key?](/admin/licensing#how-can-we-update-our-license-key) |
There was a problem hiding this comment.
| Once you have a license key, add it on the **Product license** page. See [How can we update our license key?](/admin/licensing#how-can-we-update-our-license-key) | |
| Once you have a license key, configure it in **Administration → Configuration → Product license** (`/admin/license`). See [How can we update our license key?](/admin/licensing#how-can-we-update-our-license-key) |
Replace the outdated Site configuration steps with the Product license page flow, correct what happens when a license expires, and explain that Sourcegraph manages license keys on Sourcegraph Cloud. Co-authored-by: Amp <[email protected]> Amp-Thread-ID: https://ampcode.com/threads/T-2198952b-2156-4c41-95b8-3d5b5c963010
Amp-Thread-ID: https://ampcode.com/threads/T-2198952b-2156-4c41-95b8-3d5b5c963010 Co-authored-by: Amp <[email protected]>
c18de6c to
b286a1f
Compare
Applies two review suggestions from @bobheadxi on #2073 that came in after it merged: - `admin/licensing`: shorten the Sourcegraph Cloud note to say Sourcegraph manages the license key, without describing the hidden form ([comment](#2073 (comment))). - `self-hosted/deploy/kubernetes/configure`: name the exact page, **Administration → Configuration → Product license** (`/admin/license`) ([comment](#2073 (comment))). Amp thread: https://ampcode.com/threads/T-2198952b-2156-4c41-95b8-3d5b5c963010 Co-authored-by: Amp <[email protected]>
Customer feedback: the license key docs were out of date. They said to edit
licenseKeyunder Site admin > Configuration > Site configuration, which no longer exists. On Sourcegraph Cloud, the Product license page has no way to update the key, so the customer ended up editing Advanced configuration by hand.Changes:
admin/licensing: replace the old steps with a pointer to the Product license page, and drop the "takes 10-15 minutes, restart the frontend" note: the change applies on save. Correct the FAQ on expired licenses: only users who are not site admins are blocked. Note that on Cloud, Sourcegraph manages the license key (the form is hidden on Cloud), and point Cloud customers to their account team or [email protected]. Note that the form is disabled whenSITE_CONFIGorSITE_CONFIG_FILEis set.admin/subscriptions: link to the licensing FAQ instead of repeating the outdated steps.cloud: add an FAQ entry on license keys for Cloud.self-hosted/deploy/kubernetes/configure: point "Add license key" to the Product license page.Checks:
pnpm run check links --check-anchors --check-self-linksreports no new findings (266 before and after), and CSpell found no issues in the changed pages.Amp thread: https://ampcode.com/threads/T-2198952b-2156-4c41-95b8-3d5b5c963010