-
Notifications
You must be signed in to change notification settings - Fork 906
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
stichbury
added
the
Component: Documentation 📄
Issue/PR for markdown and API documentation
label
Oct 11, 2023
stichbury
requested review from
deepyaman,
merelcht,
AhdraMeraliQB,
ankatiyar and
amandakys
October 11, 2023 10:43
merelcht
approved these changes
Oct 11, 2023
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.
That makes a lot of sense! 👍
astrojuanlu
approved these changes
Oct 11, 2023
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.
One step towards perfection 👍🏽 I agree the "Project setup" page is a bit of a mixed bag, time will come to improve it
ankatiyar
approved these changes
Oct 11, 2023
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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
NEW TOC
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
RELEASE.md
file