Remove most mentions of Core license from docs #19001

rmloveland · 2024-10-10T14:42:27Z

Addresses DOC-10665

Summary of changes:

Review and remove all mentions of Core license from docs, with the following exceptions (which will be later work):
- Licensing FAQs page, which will be updated via DOC-11203
- Mentions of Core Changefeeds, about which the method of removal from docs is TBD

github-actions · 2024-10-10T14:42:54Z

Files changed:

src/current/_includes/v24.3/cdc/examples-license-workload.md:

src/current/v24.3/changefeed-examples.md

src/current/_includes/v24.3/cdc/sql-cluster-settings-example.md:

src/current/v24.3/changefeed-examples.md

src/current/_includes/v24.3/essential-alerts.md:

src/current/_includes/v24.3/misc/install-next-steps.html:

src/current/_includes/v24.3/prod-deployment/secure-start-nodes.md:

netlify · 2024-10-10T14:42:59Z

✅ Deploy Preview for cockroachdb-api-docs canceled.

Name	Link
🔨 Latest commit	`0418c3a`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-api-docs/deploys/6711273ae8051f00083560ae

netlify · 2024-10-10T14:43:02Z

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name	Link
🔨 Latest commit	`0418c3a`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/6711273aa303a80008b90db1

netlify · 2024-10-10T14:49:55Z

✅ Netlify Preview

Name	Link
🔨 Latest commit	`b846378`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-docs/deploys/6707e7d66af01300083ca83a
😎 Deploy Preview	https://deploy-preview-19001--cockroachdb-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

netlify · 2024-10-10T14:56:53Z

✅ Netlify Preview

Name	Link
🔨 Latest commit	`0418c3a`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-docs/deploys/6711273a11136e000899e4a7
😎 Deploy Preview	https://deploy-preview-19001--cockroachdb-docs.netlify.app
📱 Preview on mobile	Toggle 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 · 2024-10-10T16:10:28Z

@kathancox can you please look at my (hopefully minimal) changes to the backup docs in this PR? to make sure i'm not making a huge mess in your product area? 🙇

also as noted in the description i have completely left out core changefeeds while we work towards a decision there -

@taroface for you this is a general review request pls 🫡

ofc feel free to opine on the backup changes as well from a writerly POV

kathancox

Few comments, not sure if it is necessary to remove references of "This is an Enterprise-only feature".. if we do need to. Each of the Backup feature pages, like locality aware, encrypted etc. include a note saying this. Also, instances like this: https://www.cockroachlabs.com/docs/v24.2/backup-and-restore-overview#backup-and-restore-support (I'm not sure if the third column needs to change.)

And, instances like this "You do not need an Enterprise license to run any of the backup validation tools described on this page."

Let me know if there is anything I can do here to help. Also, I've sent a message out re Core changefeeds, will keep you up to date.

src/current/v24.3/create-schedule-for-backup.md

src/current/v24.3/backup.md

taroface

Blocking here mostly for the Dedicated mention that slipped through. I have a longer comment on a separate change; sorry if you already have an upcoming plan for the things I raised! Otherwise I can raise it in Slack.

src/current/v24.3/security-reference/security-overview.md

src/current/v24.3/sso-sql.md

src/current/v24.3/ui-overview.md

rmloveland · 2024-10-15T19:36:15Z

Few comments, not sure if it is necessary to remove references of "This is an Enterprise-only feature".. if we do need to. Each of the Backup feature pages, like locality aware, encrypted etc. include a note saying this. Also, instances like this: https://www.cockroachlabs.com/docs/v24.2/backup-and-restore-overview#backup-and-restore-support (I'm not sure if the third column needs to change.)

thanks @kathancox ! I have upscoped this PR to remove (almost) all such mentions of enterprise-only this and that. Basically 99% of things that link to enterprise-licensing.md are now removed - the few that remain will be removed when I complete #19002 which will follow this

there's a lot of changed files but the changes are mostly trivial deletions of sentences like "This is an Enterprise feature [LINK]" etc.

And, instances like this "You do not need an Enterprise license to run any of the backup validation tools described on this page."

Removed all of those as well!

Let me know if there is anything I can do here to help. Also, I've sent a message out re Core changefeeds, will keep you up to date.

awesome thanks! PTAL at the latest commit called Update with kathancox feedback (1) which includes updates based on all of your feedback

Addresses DOC-10665 Summary of changes: - Review and remove all mentions of Core license from docs, with the following exceptions (which will be later work): - Licensing FAQs page, which will be updated via DOC-11203 - Mentions of Core Changefeeds, about which the method of removal from docs is TBD

rmloveland · 2024-10-15T20:09:54Z

Blocking here mostly for the Dedicated mention that slipped through. I have a longer comment on a separate change; sorry if you already have an upcoming plan for the things I raised! Otherwise I can raise it in Slack.

Thanks @taroface ! I have addressed your specific changes in the commit Update with taroface feedback (1) - PTAL!

Re: the longer comment on a separate change / stuff we discussed in Slack earlier this week, I would like to address all those things too but I think for this specific "core deprecation" work those improvements will have to happen separately

src/current/v24.3/sso-sql.md

taroface

LGTM, just a minor suggestion!

rmloveland · 2024-10-16T19:29:13Z

@jaiayu FYI this is the "remove mention of Core and Enterprise from docs" PR I mentioned in today's weekly FYI

it does not talk about the new licensing, rather, it's the "rip out ~all the Core / Enterprise mentions" kind of pre-work PR

mdlinville

Since I was mentioned, I took a look at the includes and pages for deployment (install, orchestration, start commands, etc) and security / authentication, and they look great to me. Thank you so much. (the build failure is a handful of newly-broken anchors)

rmloveland · 2024-10-17T14:29:05Z

synced with @kathancox offline and she's good with this merging

i will now fix a couple broken anchors and merge

…cense

Addresses DOC-10665 Followup to #19001

rmloveland force-pushed the 20241009-DOC-10665-remove-mention-of-core-license branch from b846378 to 7e276d6 Compare October 10, 2024 14:49

rmloveland requested review from kathancox and taroface October 10, 2024 16:07

kathancox reviewed Oct 10, 2024

View reviewed changes

src/current/v24.3/create-schedule-for-backup.md Show resolved Hide resolved

src/current/v24.3/backup.md Outdated Show resolved Hide resolved

taroface requested changes Oct 14, 2024

View reviewed changes

src/current/v24.3/security-reference/security-overview.md Outdated Show resolved Hide resolved

src/current/v24.3/sso-sql.md Outdated Show resolved Hide resolved

src/current/v24.3/ui-overview.md Outdated Show resolved Hide resolved

rmloveland added 2 commits October 15, 2024 15:44

Update with kathancox feedback (1)

6bad1ba

rmloveland force-pushed the 20241009-DOC-10665-remove-mention-of-core-license branch from 816dab6 to 6bad1ba Compare October 15, 2024 19:50

Update with taroface feedback (1)

faf5dcd

rmloveland requested review from kathancox and taroface October 15, 2024 20:10

taroface reviewed Oct 15, 2024

View reviewed changes

src/current/v24.3/sso-sql.md Outdated Show resolved Hide resolved

taroface approved these changes Oct 15, 2024

View reviewed changes

mdlinville approved these changes Oct 16, 2024

View reviewed changes

Update with taroface feedback (2)

7560895

rmloveland added 2 commits October 17, 2024 10:51

Fix busted anchor links

74adecb

Merge branch 'main' into 20241009-DOC-10665-remove-mention-of-core-li…

0418c3a

…cense

rmloveland enabled auto-merge (squash) October 17, 2024 15:04

rmloveland merged commit 5df409b into main Oct 17, 2024
7 checks passed

rmloveland deleted the 20241009-DOC-10665-remove-mention-of-core-license branch October 17, 2024 15:10

rmloveland added a commit that referenced this pull request Oct 21, 2024

Remove more dangling 'enterprise license' refs

0a299f6

Addresses DOC-10665 Followup to #19001

rmloveland mentioned this pull request Oct 21, 2024

Remove more dangling 'enterprise license' refs #19031

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove most mentions of Core license from docs #19001

Remove most mentions of Core license from docs #19001

rmloveland commented Oct 10, 2024

github-actions bot commented Oct 10, 2024 •

edited

Loading

netlify bot commented Oct 10, 2024 •

edited

Loading

netlify bot commented Oct 10, 2024 •

edited

Loading

netlify bot commented Oct 10, 2024

netlify bot commented Oct 10, 2024 •

edited

Loading

rmloveland commented Oct 10, 2024

kathancox left a comment •

edited

Loading

taroface left a comment

rmloveland commented Oct 15, 2024 •

edited

Loading

rmloveland commented Oct 15, 2024

taroface left a comment

rmloveland commented Oct 16, 2024

mdlinville left a comment •

edited

Loading

rmloveland commented Oct 17, 2024

Remove most mentions of Core license from docs #19001

Remove most mentions of Core license from docs #19001

Conversation

rmloveland commented Oct 10, 2024

github-actions bot commented Oct 10, 2024 • edited Loading

Files changed:

netlify bot commented Oct 10, 2024 • edited Loading

✅ Deploy Preview for cockroachdb-api-docs canceled.

netlify bot commented Oct 10, 2024 • edited Loading

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

netlify bot commented Oct 10, 2024

✅ Netlify Preview

netlify bot commented Oct 10, 2024 • edited Loading

✅ Netlify Preview

rmloveland commented Oct 10, 2024

kathancox left a comment • edited Loading

Choose a reason for hiding this comment

taroface left a comment

Choose a reason for hiding this comment

rmloveland commented Oct 15, 2024 • edited Loading

rmloveland commented Oct 15, 2024

taroface left a comment

Choose a reason for hiding this comment

rmloveland commented Oct 16, 2024

mdlinville left a comment • edited Loading

Choose a reason for hiding this comment

rmloveland commented Oct 17, 2024

github-actions bot commented Oct 10, 2024 •

edited

Loading

netlify bot commented Oct 10, 2024 •

edited

Loading

netlify bot commented Oct 10, 2024 •

edited

Loading

netlify bot commented Oct 10, 2024 •

edited

Loading

kathancox left a comment •

edited

Loading

rmloveland commented Oct 15, 2024 •

edited

Loading

mdlinville left a comment •

edited

Loading