-
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
[Ready] Remove FAQ documentation content, fix links #2373
Conversation
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot @stichbury! Left a few comments
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
…into 1985-remove-faqs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With the addition of gh-2377 this PR looks good to me!
I am not going to merge this PR until we have the following in place: * Agreement on general messaging
|
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
…into 1985-remove-faqs
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
…into 1985-remove-faqs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks really good! ⭐ I left one minor comment.
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Fina; push to remove FAQs that are about Kedro and put them on the website, focussing FAQs instead on technical topics (though more are still needed). Signed-off-by: Danny Farah <danny.farah@quantumblack.com>
Fina; push to remove FAQs that are about Kedro and put them on the website, focussing FAQs instead on technical topics (though more are still needed). Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>
Description
Part of #1985, and the milestone to improve the onboarding experience, paying particular attention to FAQs.
The overall plan is to:
Move marketing FAQs to the website
See this website issue for ongoing work.
Add more technical FAQ content in the documentation where it's relevant
We now have a spaceflights FAQ, as one example. As we improve docs we will favour content that is structured to answer typical user questions (in part because SEO).
Why remove a popular page?
My thoughts on the fact that the FAQ page is currently a popular one in the docs are that people are looking for information, used to checking FAQs, so they visit the page.
They're not there to read the page end-to-end and -- I would guess -- they're not really getting much out of the existing content, which is a mixture of marketing copy, a list of names and a few technical details that didn't fit elsewhere.
Some people will also end up on the FAQ through organic search and we need to make sure that the copy (in Box, see note above) is optimised so they get to the Kedro website and find what they need.
I want to prioritise content in the coming weeks that fills any gaps left by the FAQ. So, aside from the website copy, we also need to do the following:
Development notes
conf.py
because the linkcheck doesn't understand anchors and I'm pointing to an anchor in Kedro's READMEChecklist
RELEASE.md
file