cockroachdb / docs

CockroachDB user documentation
https://cockroachlabs.com/docs
Creative Commons Attribution 4.0 International
190 stars 460 forks source link

Update Licensing FAQs for v24.3 release #19002

Closed rmloveland closed 2 weeks ago

rmloveland commented 1 month ago

Addresses:

Summary of changes:

Rendered previews:

NB. These changes only apply to v24.3 docs right now, but once reviewed and approved, these changes will also be backported to v23.1+ docs and sit on a branch awaiting the relevant point releases of those versions in November.

github-actions[bot] commented 1 month ago

Files changed:

netlify[bot] commented 1 month ago

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
Latest commit baabc60e2b8d2c91c6764aa608456093c10a2d63
Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/673666b5251a1e000862501f
netlify[bot] commented 1 month ago

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
Latest commit baabc60e2b8d2c91c6764aa608456093c10a2d63
Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/673666b537140b00085f2abc
netlify[bot] commented 1 month ago

Deploy Preview for cockroachdb-docs failed. Why did it fail? →

Name Link
Latest commit 01e6c092110fe22336a82f1da8f3557206def983
Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/6707f9dd2b59a200080844f7
netlify[bot] commented 1 month ago

Netlify Preview

Name Link
Latest commit baabc60e2b8d2c91c6764aa608456093c10a2d63
Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/673666b5a63a530008ea1c9d
Deploy Preview https://deploy-preview-19002--cockroachdb-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

rmloveland commented 1 month ago

@jaiayu could use your feedback on basically this whole PR. This is a first step; next I'll plan to add an 'Enterprise Licensing Workflows' page which contains the self-serve license info as well for easier finding / sharing, probably with more info too. Also a 'Telemetry' page. But this at least gets the basic instructions and info written down (I hope) - but please let me know if you see something wrong or missing

@spilchen please look at the stuff about throttling and developer single-node clusters and let me know if anything is wrong or missing

@dhartunian please look at the changes to the 'DB Console Overview > License expiration message', I've updated it to match the telemetry notices/warnings shown in DB Console based on some screenshots you shared a while back. I'm adding it here so folks can search for the exact strings in docs. Please let me know if the text of the messages has changed. Also i'm open to any other feedback re: stuff that is wrong or missing

Thank you!

rmloveland commented 1 month ago

@dhartunian :

DB Console text LGTM.

yayyy thanks

We will enforce the sending of telemetry within the DB if the customer has a Free/Trial license (they can't disable via the cluster setting), so if they get a telemetry send error, it will be due to a firewall configuration or a network issue. Is it worth mentioning that somewhere?

I added a line to reference this in the 'Types of Licenses' section, PTAL

Clusters with Enterprise Free or Enterprise Trial licenses cannot disable telemetry; if such a cluster signals a telemetry sending error, it will be due to firewall configuration or a network issue.

rmloveland commented 4 weeks ago

finished providing feedback to this version. Let me know if you have any questions.

thanks for the review @jaiayu

I have made updates that hopefully address all of your feedback in the latest commit named Update with jaiayu feedback (1), PTAL and let me know what you think!

rmloveland commented 3 weeks ago

I reviewed the latest version and resolved most of my open comments. Added new comments for a couple of small things.

np @jaiayu, thanks for looking - made updates based on the new comments, PTAL!

EDIT: also went back and made small updates based on some earlier unresolved comments. Also asked about status on some comments that I think could be resolved if you were good with the changes I made for those comments

rmloveland commented 2 weeks ago

@taroface FYI this has completed legal review and is 100% ready for your review

i know i have 1000000 things in your queue, but this is the number 1 thing i'd say