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
Separate dev docs from user docs #2376
Comments
I'd definitely be keen to see these on the wiki to remove a barrier to contribution that exists for the community (the PR process). |
Only missing bit is https://docs.kedro.org/en/stable/contribution/ |
@astrojuanlu I'm thinking I may come back to this ticket in an upcoming sprint and move most of the contribution section onto the wiki (except for the maintainer list for the TSC process compliance). If you think it's worth exploring further I'll flesh out a set of changes here before I dive in and do them, and we can review. |
Good opportunity to publish our release checklist as well: https://mckinsey.atlassian.net/wiki/spaces/CAI/pages/446826369/Release+step-by-step+checklist+Kedro (internal link) |
I'm removing this from the current sprint as it isn't a high priority for docs right now. |
This is now done (#2667 and related tickets). The only developer documentation outstanding are the TSC page (which has to sit behind a sign-off system for voting purposes) and a landing page for indexing purposes. |
Description
Remove development docs (how to contribute, principles, FAQs, etc) from the user docs (currently living under https://kedro.readthedocs.io/).
Context
Users and contributors are very different user personas and have different needs, and this should be reflected in the documentation. We could be moving the dev docs to a separate Read the Docs site or even GitHub wiki. Benefits:
Possible Implementation
Move dev docs to GitHub wiki.
Possible Alternatives
The text was updated successfully, but these errors were encountered: