Document URL: https://docs.openshift.com/container-platform/4.5/nodes/clusters/nodes-cluster-enabling-features.html Section Number and Name: all Describe the issue: Comparing the doc page with the source code of the API (https://github.com/openshift/api/blob/master/config/v1/types_feature.go) shows that half of the API is not documented: - we have 4 feature sets. One is only documented. - it is completely lacking how to actually enable the listed feature gates. - it is not explained what a feature set is. - it is not explained how features and feature sets relate. Suggestions for improvement: Rewrite most of it explaining what the concepts are. Give examples for sets and custom features. Make it complete. Additional information:
I would remove the entire page. This setting is only useful in the sense of trying to enable a specific profile like latencysensitive or ipv6dualstack. Seems like you would document the featuregate settings where you talk about how to accomplish the goal of "I want to run applications that require colocation", or "I want ipv6dualstack without the ability to upgrade". The customnoupgrade setting is really only useful to developers, so it seems like swagger satisfies them. I'm not sure why we have this page at all.
David -- I like your idea of referencing the feature sets with the appropriate features. Not sure which topics require the info. The Topology Manager topic does mention the latencysensitive feature set [1]. In my opinion, we shouldn't remove the topic, as it is a feature and in both the CLI and the console. But not my decision to make. Michael [1] https://docs.openshift.com/container-platform/4.5/scalability_and_performance/using-topology-manager.html#seting_up_topology_manager_using-topology-manager
New docs PR: https://github.com/openshift/openshift-docs/pull/24132
Xiaoli -- Can you please assign this BZ to a QE resource for review? Thank you very much. Michael
Hi, Michael Burke I comment on pr: https://github.com/openshift/openshift-docs/pull/24132 , please take a look.
Changes are live: https://docs.openshift.com/container-platform/4.6/nodes/clusters/nodes-cluster-enabling-features.html#nodes-cluster-enabling-features-console_nodes-cluster-enabling
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 500 days