fix: Fix incorrect feature state in Topology Aware hints page

[sergeyshevch]

Ref: #36825
Fixed Incorrect feature state in Topology Aware hints documentation.

I'm currently unsure, maybe it will be better to completely remove this note or make enabled word not bold. Which style will be preferable in this case?

[k8s-ci-robot]

Welcome @sergeyshevch!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[sergeyshevch]

@mehabhalodiya @robscott
Please note that it also needs to be backported to 1.24 docs.
More info in related issue

[sftim]

Suggested change

	{{< note >}}
	The "topology-aware hints" feature is at Beta stage and it is **NOT** enabled
	by default. To try out this feature, you have to enable the `TopologyAwareHints`
	[feature gate](/docs/reference/command-line-tools-reference/feature-gates/).
	The "topology-aware hints" feature is at Beta stage, and it is **ENABLED**
	by default.
	{{< /note >}}

I'd omit the entire note. Alternatively, focus the note on what people should do if they are running Kubernetes v1.23 or earlier; my usual advice is “switch to the same page in the documentation for your actual Kubernetes version” (there is a version picker top-right).

[sergeyshevch]

Updated and force pushed

[netlify]

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	259239f
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/632309f26589690008455e9f
😎 Deploy Preview	https://deploy-preview-36828--kubernetes-io-main-staging.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 settings.

[robscott]

Not sure what the standard is here, but maybe we should clarify that the feature graduated to beta in 1.23 and the feature gate was enabled by default on 1.24+. Note that even when the feature gate is enabled, users still need to set the annotation to enable the feature on a Service.

[sftim]

The shortcode we have doesn't capture a separate “enabled by default from release” value. Something we could add, or track as an enhancement.

[sergeyshevch]

@robscott I guess information about annotation should be added here #36830
@sftim I can also make PR to fix this

[sergeyshevch]

About “enabled by default from release”
I guess that it is very useful information. But it should be tracked separately (I also will be happy to work on it)

[sftim]

After this change, the website is less wrong. It's progress!

/lgtm
/approve

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: df7c22c77859a47a50124f315c39f74d241a46b8

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

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:

• content/en/OWNERS [sftim]

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

[sergeyshevch]

@sftim Can you proceed with backporting this to 1.24? Or there are something that should be done from my side

[robscott]

I think we also have to be very careful about the "enabled by default" terminology here. Although the feature gate is enabled by default, that just allows you to opt-in Services with an annotation. Users may get confused that "enabled by default" could mean the feature is enabled on all Services by default starting in 1.24. I think there may be other features with this same pattern.

[sergeyshevch]

@robscott I guess its clearly described on https://kubernetes.io/docs/concepts/services-networking/topology-aware-hints/#using-topology-aware-hints section

You can activate Topology Aware Hints for a Service by setting the service.kubernetes.io/topology-aware-hints annotation to auto.

But we also we can add more examples here

[sftim]

backports

Our policy given the number and mean age of issues against main is only to backport high-priority fixes. We'll consider review but it's not something that SIG Docs would particularly staff.

[sergeyshevch]

For now, it's really unclear about this feature gate enablement. So I guess that backporting this to the 1.24 version can be really useful. At least for managed k8s users.

I hope that we will get 1.24 by end of the year. But the release cycle of managed k8s is really delayed against k8s upstream.

If it will be additional work for you, you can just give something like a guide and I will make it