Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove most mentions of Core license from docs #19001

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rmloveland
Copy link
Contributor

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

Copy link

netlify bot commented Oct 10, 2024

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 7e276d6
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/6707e989abdfa60008dd206e

Copy link

netlify bot commented Oct 10, 2024

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 7e276d6
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/6707e989d5514500092f3d9d

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 rmloveland force-pushed the 20241009-DOC-10665-remove-mention-of-core-license branch from b846378 to 7e276d6 Compare October 10, 2024 14:49
Copy link

netlify bot commented Oct 10, 2024

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...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

netlify bot commented Oct 10, 2024

Netlify Preview

Name Link
🔨 Latest commit 7e276d6
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/6707e989e2bebc0008b16fe0
😎 Deploy Preview https://deploy-preview-19001--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
Copy link
Contributor Author

@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

Copy link
Contributor

@kathancox kathancox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@@ -9,12 +9,6 @@ docs_area: reference.sql

For more information about creating, managing, monitoring, and restoring from a scheduled backup, see [Manage a Backup Schedule]({% link {{ page.version.version }}/manage-a-backup-schedule.md %}).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is also a reference to Enterprise licenses in the Parameters table under FULL BACKUP crontab.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"If you do not have an Enterprise license then you can only take full backups."

@@ -32,7 +32,7 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO

## Considerations

- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). You can also use [CockroachDB {{ site.data.products.advanced }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup), which runs [full backups daily and incremental backups hourly]({% link cockroachcloud/managed-backups.md %}).
If you use [CockroachDB {{ site.data.products.advanced }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup), it runs [full backups daily and incremental backups hourly]({% link cockroachcloud/managed-backups.md %}).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should just remove this bullet point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants