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

Change some messages and documentation to Welkin, as part of our rebranding #2424

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

cristiklein
Copy link
Contributor

Warning

This is a public repository, ensure not to disclose:

  • personal data beyond what is necessary for interacting with this pull request, nor
  • business confidential information, such as customer names.

What kind of PR is this?

Required: Mark one of the following that is applicable:

  • kind/feature
  • kind/improvement
  • kind/deprecation
  • kind/documentation
  • kind/clean-up
  • kind/bug
  • kind/other

Optional: Mark one or more of the following that are applicable:

Important

Breaking changes should be marked kind/admin-change or kind/dev-change depending on type
Critical security fixes should be marked with kind/security

  • kind/admin-change
  • kind/dev-change
  • kind/security
  • [kind/adr](set-me)

Release notes

Change some messages and documentation to Welkin, as part of our rebranding

What does this PR do / why do we need this PR?

The purpose of this PR is for me to test how simple it is to use the instructions in DEVELOPMENT.md to make a simple improvement to Welkin.

As a side-effect, I decided to actually contribute. 😄

  • Fixes #

Information to reviewers

image

Checklist

  • Proper commit message prefix on all commits
  • Change checks:
    • [] The change is transparent
    • The change is disruptive
    • The change requires no migration steps
    • The change requires migration steps
    • The change updates CRDs
    • The change updates the config and the schema
  • Documentation checks:
  • Metrics checks:
    • The metrics are still exposed and present in Grafana after the change
    • The metrics names didn't change (Grafana dashboards and Prometheus alerts required no updates)
    • The metrics names did change (Grafana dashboards and Prometheus alerts required an update)
  • Logs checks:
    • The logs do not show any errors after the change
  • PodSecurityPolicy checks:
    • Any changed Pod is covered by Kubernetes Pod Security Standards
    • Any changed Pod is covered by Gatekeeper Pod Security Policies
    • The change does not cause any Pods to be blocked by Pod Security Standards or Policies
  • NetworkPolicy checks:
    • Any changed Pod is covered by Network Policies
    • The change does not cause any dropped packets in the NetworkPolicy Dashboard
  • Audit checks:
    • The change does not cause any unnecessary Kubernetes audit events
    • The change requires changes to Kubernetes audit policy
  • Falco checks:
    • The change does not cause any alerts to be generated by Falco
  • Bug checks:
    • The bug fix is covered by regression tests

@cristiklein cristiklein requested review from a team as code owners February 3, 2025 15:39
Copy link

@llarsson llarsson left a comment

Choose a reason for hiding this comment

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

Good changes so stuff works without redirects!

I see the addition of the Registered Trademark symbol. If we use that, we ought to ensure that we always write it as "Elastisys Welkin®", because our registered trademark is actually for those two words -- the Elastisys part is required as well.

Edit: is it possible to set something like that up using the "vale" or whatever the not-a-spellchecker-but-almost tool is called?

@cristiklein cristiklein requested review from a team as code owners February 4, 2025 08:23
@cristiklein
Copy link
Contributor Author

Good changes so stuff works without redirects!

Thanks!

I see the addition of the Registered Trademark symbol. If we use that, we ought to ensure that we always write it as "Elastisys Welkin®", because our registered trademark is actually for those two words -- the Elastisys part is required as well.

Nice catch. Fixed!

Edit: is it possible to set something like that up using the "vale" or whatever the not-a-spellchecker-but-almost tool is called?

In my experience, Vale is rather bad at "multi-word" spellchecking. I added a custom pre-commit hook.

@cristiklein cristiklein force-pushed the ck/rename-to-welkin-in-guardrails branch from d1b4626 to 1eb238f Compare February 4, 2025 08:26
Copy link
Contributor

@linus-astrom linus-astrom left a comment

Choose a reason for hiding this comment

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

LGTM

migration/v0.41/README.md Outdated Show resolved Hide resolved
migration/v0.41/README.md Outdated Show resolved Hide resolved
@cristiklein cristiklein self-assigned this Feb 4, 2025
@cristiklein cristiklein requested a review from llarsson February 4, 2025 15:12
.pre-commit-config.yaml Outdated Show resolved Hide resolved
.pre-commit-config.yaml Outdated Show resolved Hide resolved
.pre-commit-config.yaml Outdated Show resolved Hide resolved
.pre-commit-config.yaml Outdated Show resolved Hide resolved
@cristiklein cristiklein requested a review from a team as a code owner February 5, 2025 10:35
@cristiklein cristiklein requested a review from aarnq February 5, 2025 10:36
Copy link
Contributor

@aarnq aarnq left a comment

Choose a reason for hiding this comment

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

LGTM, nice to see more of the branding being updated 👍

Copy link

@llarsson llarsson left a comment

Choose a reason for hiding this comment

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

Nice, a lot of really good changes that are also visible to Application Developers! Love it!

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.

4 participants