Docs: Feature state labels are unclear in certain contexts (we should change '@' to 'since')

Created on 26 Aug 2020  路  2Comments  路  Source: knative/docs


Expected Behavior

  1. On pages such as https://knative.dev/docs/install/any-kubernetes-cluster/#installing-the-serving-component, the Serving link should not be suffixed by "stable @ v0.9" in the opening paragraph, because to at least one reader (hi! 馃憢) this looks like we're suggesting the current stable version is 0.9.
  2. It's fine to have "stable @ v0.9" when this is preceded by "Feature State:" since this makes it clear what the '@' means, but:
  3. Even better (imo) would be just to use "stable since v0.9" throughout, since this is clear in all contexts

Actual Behavior

  1. The opposite of the above.

Steps to Reproduce the Problem

  1. Visit https://knative.dev/docs/install/any-kubernetes-cluster/#installing-the-serving-component
  2. Read the opening paragraph
  3. Observe "Serving stable @ v0.9 provides an abstraction for stateless request-based scale-to-zero services." rather than something like "Serving stable since v0.9 provides an abstraction for stateless request-based scale-to-zero services."
  4. Repeat throughout docs.

/assign @abrennan89

kinbug

Most helpful comment

Totally agree, but tbh I question in general to show this information in introductory documents like the installation guide. See #2858 because I got confused about this information. My feeling is that nobody really cares that Knative is stable since 0.9.0 (considering we are already at 0.17) or whether it was in 0.8.0 or 0.10.0. All those versions are not supported anymore anyway.

I would just remove those labels.

All 2 comments

Totally agree, but tbh I question in general to show this information in introductory documents like the installation guide. See #2858 because I got confused about this information. My feeling is that nobody really cares that Knative is stable since 0.9.0 (considering we are already at 0.17) or whether it was in 0.8.0 or 0.10.0. All those versions are not supported anymore anyway.

I would just remove those labels.

+1 to remove the labels from intro and installation docs.
I also always confuse about what does this @ means and also think I'm looking at a very old version of the docs installing old versions.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

steren picture steren  路  8Comments

yangyunfeng007 picture yangyunfeng007  路  4Comments

Abhishek-kumar09 picture Abhishek-kumar09  路  5Comments

richterdavid picture richterdavid  路  6Comments

erandiganepola picture erandiganepola  路  5Comments