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

Separate dev docs from user docs #2376

Closed
astrojuanlu opened this issue Mar 1, 2023 · 6 comments
Closed

Separate dev docs from user docs #2376

astrojuanlu opened this issue Mar 1, 2023 · 6 comments
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Feature Request New feature or improvement to existing feature

Comments

@astrojuanlu
Copy link
Member

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:

  • Surface area of the user docs is smaller.
  • Search results are more meaningful.
  • Dev docs don't need to be versioned, since they usually contain policies and procedures that don't change a lot over time and it's not important to see how they looked like in a past version.
  • Dev docs could live closer to the source code (for example on GitHub wiki).

Possible Implementation

Move dev docs to GitHub wiki.

Possible Alternatives

  • Move dev docs to a separate Read the Docs site. There are tricks to have 2 RtD projects under the same repository, but they are quite hacky (see Docs: split user and dev docs readthedocs/readthedocs.org#8751 for example). Alternatively it could be a separate repository. Sounds too much of a hassle for something like this.
  • Don't do anything. This would be very much less than ideal.
@astrojuanlu astrojuanlu added Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Feature Request New feature or improvement to existing feature labels Mar 1, 2023
@stichbury
Copy link
Contributor

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).

@astrojuanlu
Copy link
Member Author

Only missing bit is https://docs.kedro.org/en/stable/contribution/

@stichbury
Copy link
Contributor

@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.

@astrojuanlu
Copy link
Member Author

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)

@stichbury
Copy link
Contributor

I'm removing this from the current sprint as it isn't a high priority for docs right now.

@stichbury
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Feature Request New feature or improvement to existing feature
Projects
Status: Done
Development

No branches or pull requests

2 participants