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

Add clarification for what we mean by "supported" in the tech docs #493

Open
bburt-rh opened this issue Jun 26, 2024 · 2 comments
Open

Add clarification for what we mean by "supported" in the tech docs #493

bburt-rh opened this issue Jun 26, 2024 · 2 comments
Assignees
Labels
Glossary entry Topics that add or modify glossary entries

Comments

@bburt-rh
Copy link
Contributor

bburt-rh commented Jun 26, 2024

Per a recent discussion in the CCS channel in the RH company Slack, it became clear that RH technical docs use the word "supported" in at least two different senses that might lead to confusion for users and customers.

In Slack, @bredamc summed up the issue best when she said that "You also have to be careful about distinguishing between what the product does not support (that is, not technically possible) and what Red Hat does not support (that is, might be technically possible but RH doesn't support you doing it".

We often use "supported/not supported" in our docs for both of these meanings. Unfortunately, users tend to conflate the two meanings. Users will assume that if we say that a feature is "supported" (meaning that "technically, it will work") that RH will also provide technical support for that feature, which, as @jseseCCS noted in the same Slack thread, is not always true.

I am raising this issue to propose that we add a glossary entry for the word "supported" with information about how to use the term in ways that are not potentially confusing to users/customers.

@bburt-rh bburt-rh added the Glossary entry Topics that add or modify glossary entries label Jun 26, 2024
@dfitzmau
Copy link
Contributor

@bergerhoffer
Copy link
Collaborator

Discussed at the 31 July SSG meeting. We mainly agreed that we should only be using "supported" to mean something that is supported by Red Hat. We should not use "supported" to mean something that is technically possible with the product, but not supported by Red Hat. We were a little bit divided though on whether it was necessary to clarify a different when saying that something is "unsupported", whether it means unsupported by Red Hat, or just technically impossible. At the very least, we agreed that we should add an entry to state that "supported" should only be used in the context of supported by Red Hat.

But either way, we thought that we should involve the Legal team before moving forward with an update. @bburt-rh to reach out to Legal to start the conversation. We should also get this in front of the support team for review as well.

@bburt-rh bburt-rh self-assigned this Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Glossary entry Topics that add or modify glossary entries
Projects
None yet
Development

No branches or pull requests

3 participants