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

Revise documentation table of contents #3157

Merged
merged 8 commits into from
Oct 12, 2023
Merged

Conversation

stichbury
Copy link
Contributor

@stichbury stichbury commented Oct 11, 2023

NOTE: Kedro datasets are moving from kedro.extras.datasets to a separate kedro-datasets package in
kedro-plugins repository. Any changes to the dataset implementations
should be done by opening a pull request in that repository.

Description

I created this PR because I realised that the "Kedro projects" section of the ToC has been massively improved (still got nodes & pipelines to do, but the data/config sections have had substantial revision). The only section that hasn't been touched, and is a bit of an anomaly in that section, is the "Kedro project setup" and it's a bit of a mixed bag of content on starters, dependencies, settings and lifecycle management.

Note: I don't actually think that many people use the ToC. We do because we're very familiar with the contents of the docs so we use it to navigate around. I suspect most people look at Get Started or they use search to find what they're looking for. So although this may seem like a seismic shift in terms of layout (for us) it won't be a big deal to most. If I understood how to use Heap I'd get some data to justify this.

Development notes

I've moved the "Kedro project setup" into the "Advanced" section and retitled it as just "Project setup".

You can see the built docs here

The content is still on the list for revision but it doesn't receive significant user attention so isn't the highest priority right now and Nodes & Pipelines will be fixed up first.

The move does NOT impact any links because it's not moved in URL terms, just where it's located in the documentation set (it's shifted down a bit).

ORIGINAL TOC
image

NEW TOC

image

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Oct 11, 2023
@stichbury stichbury self-assigned this Oct 11, 2023
@stichbury stichbury marked this pull request as ready for review October 11, 2023 10:42
Copy link
Member

@merelcht merelcht left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes a lot of sense! 👍

Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One step towards perfection 👍🏽 I agree the "Project setup" page is a bit of a mixed bag, time will come to improve it

@stichbury stichbury enabled auto-merge (squash) October 11, 2023 17:02
@stichbury stichbury merged commit 61472ab into main Oct 12, 2023
63 of 72 checks passed
@stichbury stichbury deleted the revise-toc-move-project-setup branch October 12, 2023 12:02
adamkells pushed a commit to adamkells/kedro that referenced this pull request Oct 30, 2023
* Move project setup to advanced section

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Update index.rst 🤦‍♀️

---------

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Adam Kells <adamjkells93@gmail.com>
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants