-
Notifications
You must be signed in to change notification settings - Fork 915
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
Documentation: Revise FAQs in docs in preparation for a move to the kedro.org website #1985
Labels
Component: Documentation 📄
Issue/PR for markdown and API documentation
Milestone
Comments
stichbury
added
the
Component: Documentation 📄
Issue/PR for markdown and API documentation
label
Oct 27, 2022
stichbury
changed the title
Documentation: Revise FAQs in docs and move to the kedro.org website
Documentation: Revise FAQs in docs in preparation for a move to the kedro.org website
Nov 14, 2022
There are two elements to this work (at least)
I'm working on the first portion right now. |
The marketing FAQs are now ready for review over on Box. I'm looking at how to update the remaining FAQs to include them in the docs (either in a shortened page or indeed by removing that page and adding the FAQ content where it's most relevant within the other docs pages). |
4 tasks
stichbury
added this to the Individual documentation enhancements to improve overall usability/quality milestone
Feb 23, 2023
This was referenced Feb 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Introduction
Most of the FAQs in the documentation should be moved to a more obvious location on the kedro.org website because they are mostly about the project itself (or the philosophy). There should be a useful way to find the FAQs on the website from the docs (because they are popular, although I suspect that people looking for FAQs do not find what they are seeking in our current set of FAQs, because they're non-technical)
There are a few of the existing that should be relocated within the docs ("How do I upgrade Kedro?" and "How do I use a development version of Kedro?")
If there are technical commonly asked questions, we should work out which are common and answer them appropriately in the docs (or solve the issue)
Background
This is part of a concerted effort to reduce the volume of docs and make the user journey more straightforward and obvious for different user types.
The text was updated successfully, but these errors were encountered: