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

Update spaceflights tutorial documentation #3117

Conversation

laizaparizotto
Copy link
Contributor

Description

Upon encountering the recently raised issue (#3111) initiated by @merelcht, about enhancing the tutorials documentation, I took it upon myself to perform the tutorial run the spaceflights.

I was able to follow the steps and successfully complete the tutorial. But, I did observe that the requirements.txt example file now lists additional libraries.

I aligned the requirements.txt with the current state of the project by incorporating the updated libraries.

Development notes

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

Kedro and others added 30 commits November 17, 2022 13:22
[AUTO-MERGE] Merge main into develop via merge-main-to-develop
[AUTO-MERGE] Merge main into develop via merge-main-to-develop
* Modify comma in default node names to semicolon

Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>

* Update tests for new node naming

Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>

* Update release notes for 0.19.0

Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>

Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>
Kedro and others added 22 commits September 19, 2023 17:56
* Remove nbstripout

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* remove build-reqs

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* remove build-docs

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* remove kedro lint

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* remove kedro test

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* remove kedro jupyter convert

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* remove jupyter convert e2e

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Remove test TestActivateNbstripoutCommand

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Remove KedroTestCommand

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Remove KedroLintCommand

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Remove test KedroBuildDoc

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Remove TestKedroBuildReq

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Remove TestConvertNotebookCommand:

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Clean up leftover from removed test

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Remove TestExportNodes

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Lint

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Remove leftover

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* remove build_doc e2e

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* remove kedro test e2e

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Remove kedro build-reqs e2e

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Remove activate_nbstripout.feature

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Remove build-reqs e2e

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Clean up cli reference in commands_reference.md

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* remove node convertion session

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* update reference to CLI command

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Fix unit tests

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* remove link from faq

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

---------

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
* release note

Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com>

* remove datasets tests

Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com>

* Remove kedro.extras.datasets and kedro.extras

Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com>

* Update `kedro.extas.datasets` -> `kedro_datasets` for tests

Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com>

* remove extras.datasets from importlinter

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* lint

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Update base type

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* suppress coverage temporarily

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* update importlinter

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Remove kedro.extras from the .rst source

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

---------

Signed-off-by: Nok Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
…-org#3069)

* Replace imports

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

* Fix version

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

* Fix typo

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

* Isolate docs change

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

* Isolate docs change pt2

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

* Isolate docs change pt3

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

* Shot in the dark

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

* Fix broken link

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

* Fix broken link pt2

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

* Fix broken link pt3

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

---------

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
* remove 3.7 from CI

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Update reference Python 3.7 to Python 3.8 as minimum pin.

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* Clean up depedencies with Python 3.7

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* fix pluggy patch

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* udpate dependencies for test

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* add pluggy dependency

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

---------

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
)

* clean up datasets related makefile command

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* remove pytable installation

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

---------

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
[AUTO-MERGE] Merge main into develop via merge-main-to-develop
… `pyproject.toml` (kedro-org#3078)

* Remove some requirements from setup.py

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Comment out dependencies

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Try fixing tests

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Add s3fs back

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Add pyarrow back

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Fix test

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Try fixing test

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Fix e2e test

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Fix unit test?

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Move requirements from setup.py to pyproject.toml

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Revert cloud version test

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Add package data to pyproject.toml

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Revert to setup.py

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Try fixing unit test

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Fix unit test

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Revert changes from individual e2e test and change environment.py

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Remove jupyter upper bounds

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Pandas version

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Pin fsspec version in test requirements

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* lint

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

---------

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>
I just ran the spaceflight tutorial and this part of the documentation seems to be outdated.
@astrojuanlu
Copy link
Member

Hi @laizaparizotto , thanks for this PR! There's seems to be something wrong with it though, it contains lots of unrelated commits. I suspect you started from the develop branch instead of the main branch, maybe you can either cherry-pick your commit on a new branch departing from main and open a new pull request:

$ git switch main
$ # Make sure the remote is all right
$ git remote show upstream
* remote upstream
  Fetch URL: https://github.com/kedro-org/kedro.git
...
$ git fetch -p upstream
$ git branch --set-upstream-to=upstream/main
$ git switch -c update_spaceflights_documentation-take-2
$ git cherry-pick update_spaceflights_documentation
$ git push -u origin update_spaceflights_documentation-take-2

@laizaparizotto
Copy link
Contributor Author

laizaparizotto commented Oct 4, 2023

Thank you @astrojuanlu, so sorry for the mistake, I will open a new PR for that.
I just checked that at main the documentation is more updated, the PR will include only a detail.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants