Skip to content

Improve feature name readability in conformance reports #3564

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

Merged
merged 1 commit into from
May 15, 2025

Conversation

08volt
Copy link
Contributor

@08volt 08volt commented Jan 22, 2025

/kind documentation

What this PR does / why we need it:

Add feature name processing to remove redundant prefixes and improve readability in conformance comparison tables. Changes include:

  • Split camelCase words into space-separated words
  • Add process_feature_name() function for consistent text processing
  • Update generate_profiles_report() to use processed feature names

This makes the conformance reports easier to read

Which issue(s) this PR fixes:
Fixes #

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 22, 2025
@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 22, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @08volt. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Copy link
Member

@mlavacca mlavacca left a comment

Choose a reason for hiding this comment

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

Thanks for this PR, @08volt!

I appreciate the effort of making our implementation table better, but I have a couple of comments after having looked at the preview https://deploy-preview-3564--kubernetes-sigs-gateway-api.netlify.app/implementations/v1.2:

  • The prefixes Gateway and HTTPRoute still make sense to be included in the feature name, as it's useful to understand whether the feature is related to the Gateway or the Route object.
  • Capitalized words (e.g., HTTP) now include a weird spacing (HTTP -> H T T P)

@08volt 08volt force-pushed the generate-conformance-doc branch from ce5c24b to 106299e Compare January 22, 2025 14:49
@08volt
Copy link
Contributor Author

08volt commented Jan 22, 2025

Thanks for this PR, Enrico!

I appreciate the effort of making our implementation table better, but I have a couple of comments after having looked at the preview https://deploy-preview-3564--kubernetes-sigs-gateway-api.netlify.app/implementations/v1.2:

  • The prefixes Gateway and HTTPRoute still make sense to be included in the feature name, as it's useful to understand whether the feature is related to the Gateway or the Route object.
  • Capitalized words (e.g., HTTP) now include a weird spacing (HTTP -> H T T P)

Nice catch, I improved the regex to keep the capital consecutive letters together.

Copy link
Member

@mlavacca mlavacca left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this. Some words still have a weird spacing though, such as H2C -> H 2 C. Could you also put back the Gateway and HTTPRoute prefixes, please?

/cc @xtineskim

as you might be interested in this change.

@mlavacca
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 23, 2025
Copy link
Contributor

@xtineskim xtineskim 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 for adding this in 😁
if you mkdcos serve in this pr, you can apply the changes to the tables 👍

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 23, 2025
@08volt 08volt force-pushed the generate-conformance-doc branch from 106299e to 78914f6 Compare April 25, 2025 13:16
@k8s-ci-robot k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Apr 25, 2025
Add feature name processing to remove redundant prefixes and improve
readability in conformance comparison tables. Changes include:

- Remove "HTTPRoute" and "Gateway" prefixes from feature names
- Split camelCase words into space-separated words
- Add process_feature_name() function for consistent text processing
- Update generate_profiles_report() to use processed feature names

This makes the conformance reports easier to read
@08volt 08volt force-pushed the generate-conformance-doc branch from 78914f6 to 762df6a Compare April 25, 2025 13:18
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 25, 2025
@08volt 08volt force-pushed the generate-conformance-doc branch from 762df6a to f93c680 Compare April 25, 2025 13:19
@k8s-ci-robot k8s-ci-robot removed the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Apr 25, 2025
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 25, 2025
@08volt
Copy link
Contributor Author

08volt commented Apr 25, 2025

Thanks @mlavacca @xtineskim , it looks better now!

@08volt
Copy link
Contributor Author

08volt commented May 14, 2025

@robscott

@robscott
Copy link
Member

Thanks @08volt! Sorry I'd missed this one earlier, this is a great improvement!

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 15, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 08volt, robscott, xtineskim

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 15, 2025
@k8s-ci-robot k8s-ci-robot merged commit 6fbbd90 into kubernetes-sigs:main May 15, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants