-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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 "FAQ" to the knative.dev website #4668
Comments
Please comment with questions and answers you want to see on the website, once we have enough of them we can create a PR |
|
Good ones @pmbanugo |
|
/assign |
Another question to add.
|
This issue is stale because it has been open for 90 days with no |
What was the reasoning for adding an FAQ rather than just improving the docs to be more useful? I feel as if FAQs are a cheap way of avoiding deeper docs issues and there's no real good way to decide on what's in or outside of scope. Adding things indefinitely to an FAQ IMO doesn't make it more useful, it will just become another cluttered page where it's hard to find the info you're actually looking for. How would a user even know to look in the FAQ to begin with for this info? I think the bot is right, mark this stale and let it die 🤷🏻 |
FAQ that many websites have, and it seems useful, and many users share the same questions when they are new to the project/technology The FAQ should not be a replacement for proper docs, and FAQ can point to specific sections of the docs for a complete answer. |
@csantanapr this article explains my perspective on it as a tech writer https://idratherbewriting.com/2017/06/23/why-tech-writers-hate-faqs/ |
We discussed this in the Docs WG call today. Jist as follows:
I am closing this issue and will be opening an Epic that includes the new issues discussed here, as well as some other topics we talked about on the call today. cc @snneji in case there's anything you'd like to add. |
We want to add a FAQ page to help users.
Here is the initial set provided by the contractor Lionsway we worked with.
Frequently Asked Questions (FAQ)
What is Knative?
Knative is a system that works on top of Kubernetes. It helps development teams manage, monitor, and operate Kubernetes in a way that requires less technical knowledge and time. Knative is open-source, finding support and growth through a combination of individual contributors and industry-leading companies.
What's the difference between Knative Serving and Knative Eventing?
Knative has two main elements named Knative Serving and Knative Eventing. While they manage different tasks and outcomes and can operate independently, together, they help make Knative a powerful tool for dev teams and IT professionals.
Where do I find documentation?
There are two forms of documentation for Knative. First, for end-user and high-level information, you can explore this website. For more granular information, you can see the documents for Knative's three main repositories, serving, eventing, and client.
How do I find help?
As an open-source project, you can find help by exploring the Knative documentation or reaching out to our community through GitHub, using the tag 'knative' on stackoverflow, and in the community Slack community using channels
serving-questions
andeventing-questions
. The community is very active, and most questions are answered quickly.How do I meet the Knative Community?
The community is very active on GitHub. There is also an active Knative Slack community where people swap ideas, talk about improvement, and get help.
How do I contribute to Knative?
Follow the knative contributor guide to get started. You can contribute in many forms like discussions, testing, reporting bugs, code changes, and documentation.
Do I need to use Istio?
You do not need to use Istio. Knative works with a variety of networking layers. You can find directions here.
The text was updated successfully, but these errors were encountered: