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

[DPE-6046] Update terminology regarding Apache Kafka trademarks #280

Merged
merged 15 commits into from
Dec 19, 2024

Conversation

github-actions[bot]
Copy link
Contributor

This pull request was autogenerated by discourse-gatekeeper to migrate existing documentation from server to the git repository.

…cs/how-to/h-enable-monitoring.md,docs/reference/r-contacts.md,docs/how-to/h-backup-restore-configuration.md,docs/explanation/e-hardening.md,docs/how-to/h-upgrade.md,docs/reference/r-listeners.md,docs/reference/r-file-system-paths.md,docs/how-to/h-create-mtls-client-credentials.md,docs/how-to/h-manage-app.md,docs/how-to/h-deploy.md,docs/explanation/e-cluster-configuration.md,docs/index.md,docs/reference/r-releases/r-rev156_136.md,docs/how-to/h-enable-encryption.md,docs/reference/r-releases/r-rev156_126.md,docs/explanation/e-security.md,docs/tutorial/t-setup-environment.md,docs/how-to/h-enable-oauth.md,docs/reference/r-snap-entrypoints.md,docs/reference/r-statuses.md,docs/how-to/h-cluster-migration.md,docs/how-to/h-integrate-alerts-dashboards.md,docs/tutorial/t-cleanup-environment.md,docs/reference/r-performance-tuning.md,docs/reference/r-requirements.md,docs/tutorial/t-enable-encryption.md,docs/tutorial/t-manage-passwords.md,docs/tutorial/t-overview.md,docs/tutorial/t-relate-kafka.md'
@izmalk izmalk changed the title [discourse-gatekeeper] Migrate charm docs [discourse-gatekeeper] Renaming Kafka to Apache Kafka Nov 30, 2024
@izmalk izmalk self-assigned this Nov 30, 2024
discourse-gatekeeper-docs-bot added 3 commits November 30, 2024 20:57
…nitoring.md,docs/how-to/h-enable-encryption.md,docs/how-to/h-deploy.md,docs/explanation/e-hardening.md,docs/index.md,docs/explanation/e-security.md'
@izmalk izmalk requested a review from grobbie December 2, 2024 09:35
@izmalk izmalk changed the title [discourse-gatekeeper] Renaming Kafka to Apache Kafka [discourse-gatekeeper] Rename Kafka to Apache Kafka Dec 2, 2024
Copy link
Contributor

@deusebio deusebio left a comment

Choose a reason for hiding this comment

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

Given the scope of this PR, I have been extra picky to get the names correct based on the context (I believe we have not been very picky in the past, but given the changes here and the better precision of the term we are aiming for, it may be sane to be a bit more picky on this for now on).

The rule that I have applied is:

  • Use Apache Kafka when talking about the workload or the software (like the general features) coming from the upstream apache project
  • Charmed Apache Kafka when talking about our solution, which bundles Charmed Apache Snap and Charmed Apache Operator
  • I generally refer to Charmed Apache Kafka, unless it is sensible to better specify Charmed Apache Kafka Snap or Charmed Apache Kafka Operator

So for instance, whenever we relate, we are not relating to Apache Kafka, but to Charmed Apache Kafka (I saw this in a number of places). Feel free to disagree or change also other places that I may have missed.

docs/explanation/e-hardening.md Outdated Show resolved Hide resolved
docs/explanation/e-hardening.md Outdated Show resolved Hide resolved
docs/how-to/h-cluster-migration.md Outdated Show resolved Hide resolved
docs/how-to/h-cluster-migration.md Outdated Show resolved Hide resolved
docs/explanation/e-cluster-configuration.md Outdated Show resolved Hide resolved
docs/tutorial/t-relate-kafka.md Outdated Show resolved Hide resolved
docs/tutorial/t-relate-kafka.md Outdated Show resolved Hide resolved
docs/tutorial/t-relate-kafka.md Outdated Show resolved Hide resolved
docs/tutorial/t-setup-environment.md Outdated Show resolved Hide resolved
docs/tutorial/t-setup-environment.md Outdated Show resolved Hide resolved
docs/explanation/e-security.md Outdated Show resolved Hide resolved
docs/how-to/h-upgrade.md Outdated Show resolved Hide resolved
docs/how-to/h-upgrade.md Outdated Show resolved Hide resolved
docs/how-to/h-upgrade.md Outdated Show resolved Hide resolved
discourse-gatekeeper-docs-bot and others added 6 commits December 6, 2024 20:24
…cs/explanation/e-cluster-configuration.md,docs/explanation/e-hardening.md,docs/tutorial/t-setup-environment.md'
…uning.md,docs/how-to/h-deploy-azure.md,docs/explanation/e-cluster-configuration.md,docs/how-to/h-kraft-mode.md,docs/how-to/h-manage-units.md,docs/how-to/h-cluster-migration.md,docs/how-to/h-upgrade.md,docs/reference/r-listeners.md'
This reverts commit 1ef2953.
…cs/how-to/h-enable-monitoring.md,docs/how-to/h-cluster-migration.md,docs/tutorial/t-manage-passwords.md,docs/reference/r-releases/r-rev156_126.md,docs/how-to/h-upgrade.md,docs/how-to/h-manage-units.md,docs/tutorial/t-enable-encryption.md,docs/how-to/h-deploy.md,docs/reference/r-statuses.md,docs/tutorial/t-overview.md,docs/tutorial/t-relate-kafka.md,docs/how-to/h-backup-restore-configuration.md'
@izmalk izmalk requested a review from deusebio December 12, 2024 20:24
Copy link
Contributor

@deusebio deusebio left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks!

docs/explanation/e-cluster-configuration.md Outdated Show resolved Hide resolved
docs/explanation/e-hardening.md Outdated Show resolved Hide resolved
docs/explanation/e-security.md Outdated Show resolved Hide resolved
docs/explanation/e-security.md Outdated Show resolved Hide resolved
docs/how-to/h-deploy-aws.md Outdated Show resolved Hide resolved
docs/how-to/h-deploy-azure.md Outdated Show resolved Hide resolved
docs/how-to/h-deploy.md Show resolved Hide resolved
docs/how-to/h-enable-encryption.md Show resolved Hide resolved
docs/reference/r-listeners.md Outdated Show resolved Hide resolved
docs/reference/r-performance-tuning.md Outdated Show resolved Hide resolved
@izmalk izmalk changed the title [discourse-gatekeeper] Rename Kafka to Apache Kafka [DPE-6046] Update terminology regarding Apache Kafka trademarks Dec 19, 2024
@izmalk izmalk merged commit 9ca899a into main Dec 19, 2024
2 checks passed
@izmalk izmalk deleted the discourse-gatekeeper/migrate branch December 19, 2024 14:23
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.

3 participants