Tutorial documentation (Spaceflights) improvements #1967
Conversation
Mostly removing text and simplifying FTW Signed-off-by: Jo Stichbury <jo.stichbury@quantumblack.com>
stichbury
changed the title
|
This is now ready for review 💃 CHANGELOG
There's probably more but really, the main TL;DR is that it's shorter, simpler and quicker to get running. Once this is sorted, I plan to go back to Get started/Iris/Hello Kedro pages and sort those out before I work on the later pages. Ticketed here OK cc-ing @yetudada and @datajoely for review if possible please! You can see the built HTML to make the review easier here I won't be able to merge this PR until I update the Spaceflights starter and merge that too, so take your time with review and I'll get some other PRs prepared. |
Co-authored-by: Ankita Katiyar <110245118+ankatiyar@users.noreply.github.com>
….com/kedro-org/kedro into kedro-1874-spaceflights-improvements
stichbury
changed the title
|
Can I push that the "Get started" section should push people towards spaceflights rather than the Hello Kedro bit |
Co-authored-by: Joel <35801847+datajoely@users.noreply.github.com>
Co-authored-by: Yetunde Dada <43755008+yetudada@users.noreply.github.com>
|
I have made a chunk of changes to the PR to update it following useful feedback. Thank you all 🙇 All is now ready for re-review @datajoely and sign off. The latest version is up on https://stichbury.github.io/ PR is blocked until we release 18.4. |
Co-authored-by: Joel <35801847+datajoely@users.noreply.github.com>
….com/kedro-org/kedro into kedro-1874-spaceflights-improvements
stichbury
added
the
Component: Documentation 📄
* Stripped out most of the visualisation sections and created a separate section outside the tutorial. This hasn't yet been revised so there will be another issue & PR for them in due course. (Ticketed here) * Reduced the complexity of the namespaces/modular pipelines section. I will also need to go back to the modular pipelines page itself and see how that reads since this is important to Kedro but currently quite hard to parse. (Ticketed here) * Revised each page of the spaceflights tutorial to improve readability and ease the reader through faster. I've clarified what needs copying & pasting and ensured each step has an anchor. I've also reinforced the option to use the starter to prepopulate the tutorial because I think it helps with reader confidence. I would still like to investigate the use of a small graphic or indicator to make it even clearer where the copy/paste is needed but have set that aside right now. * Split the pipelines page in two * Added some sections as "Optional" so the reader can skip on first pass through. Code in those isn't included in the starter so there's a clear separation. I tested multiple times on windows and MacOS to ensure it's working and created a FAQ page of common errors, although I think this could do with some work. (Ticketed here) I fixed some errors in the packaging section. A couple of page renames Signed-off-by: Luiz Otavio V. B. Oliveira <luiz.vbo@gmail.com>
Description
Closes #1874
Development notes
This is now ready for review 💃
I stripped out most of the visualisation sections and created a separate section outside the tutorial. This hasn't yet been revised so there will be another issue & PR for them in due course. (Ticketed here)
I reduced the complexity of the namespaces/modular pipelines section. I will also need to go back to the modular pipelines page itself and see how that reads since this is important to Kedro but currently quite hard to parse. (Ticketed here)
I revised each page of the spaceflights tutorial to improve readability and ease the reader through faster. I've clarified what needs copying & pasting and ensured each step has an anchor. I've also reinforced the option to use the starter to prepopulate the tutorial because I think it helps with reader confidence. I would still like to investigate the use of a small graphic or indicator to make it even clearer where the copy/paste is needed but have set that aside right now.
I split the pipelines page in two
I added some sections as "Optional" so the reader can skip on first pass through. Code in those isn't included in the starter so there's a clear separation.
I tested multiple times on windows and MacOS to ensure it's working and created a FAQ page of common errors, although I think this could do with some work. (Ticketed here)
I fixed some errors in the packaging section.
A couple of page renames. I have ticketed to ensure that I add redirects on readthedocs.
There's probably more but really, the main TL;DR is that it's shorter, simpler and quicker to get running.
Once this is sorted, I plan to go back to Get started/Iris/Hello Kedro pages and sort those out before I work on the later pages. Ticketed here
OK cc-ing @yetudada and @datajoely for review if possible please!
You can see the built HTML to make the review easier here
I won't be able to merge this PR until I update the Spaceflights starter and merge that too, so take your time with review and I'll get some other PRs prepared.
Checklist
RELEASE.mdfile