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

FIX: Typo in markdown for kedro notebooks docs #2610

Merged
merged 2 commits into from
May 26, 2023

Conversation

debugger24
Copy link
Contributor

@debugger24 debugger24 commented May 25, 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

Development notes

Checklist

  • Read the contributing guidelines
  • 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

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.

Good catch @debugger24! 🥷

Could you signoff the commit to make the DCO bot happy? You can find the instructions if you click the check, you'll have to amend and force push

Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

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

Good spot, thanks for the fix @debugger24 🏆

@debugger24
Copy link
Contributor Author

@astrojuanlu have updated the commit for the DCO check.

@astrojuanlu astrojuanlu requested a review from idanov as a code owner May 26, 2023 09:34
@astrojuanlu astrojuanlu enabled auto-merge (squash) May 26, 2023 09:34
@astrojuanlu astrojuanlu merged commit 2f248a4 into kedro-org:main May 26, 2023
noklam added a commit that referenced this pull request Jun 7, 2023
* Remove unnecessary files and subheaders in documentation (#2563)

Tidying up.

* Leverage PEP-585 (#2540)

Signed-off-by: Merel Theisen <[email protected]>
Co-authored-by: Jannic <[email protected]>

* [READY] Bring deployment docs up-to-date and add new pages for additional targets (#2557)

Ready at last. Still some conversation to be had about how we reflect "confidence" in the plugins we describe (what version they were last tested against) but the text is ready and better than what's there currently, so let's go!

* Remove mentions to `.egg` and stop producing them from `kedro package` (#2568)

* Stop producing `.egg` files from `kedro package`

Fix gh-2273.

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

* Upgrade import-linter

Fix gh-2570.

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

* Partially remove reliance on setup.py for micropackaging

Incomplete effort, see gh-2414.

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

* Revert "Partially remove reliance on setup.py for micropackaging"

This reverts commit fd3efa8.

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

---------

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

* OmegaConfigLoader returns `Dict` instead of `DictConfig`, resolves runtime_params properly (#2467)

* Fix typehint

Signed-off-by: Nok Chan <[email protected]>

* test push

Signed-off-by: Nok Chan <[email protected]>

* POC of fix to solve the runtime param resolution problem

Signed-off-by: Nok Chan <[email protected]>

* Fix OmegaConfigLoadaer - resolve runtime_params early

Signed-off-by: Nok Chan <[email protected]>

* Delegate the intialization of runtime_params to AbstractConfigLoader

Signed-off-by: Nok Chan <[email protected]>

* Add test for interpolated value and globals

Signed-off-by: Nok Chan <[email protected]>

* add more test and linting

Signed-off-by: Nok Chan <[email protected]>

* refactor

Signed-off-by: Nok Chan <[email protected]>

* update release note

Signed-off-by: Nok Chan <[email protected]>

* Apply comments and refactor the test

Signed-off-by: Nok Chan <[email protected]>

* Update RELEASE.md

Co-authored-by: Antony Milne <[email protected]>

---------

Signed-off-by: Nok Chan <[email protected]>
Co-authored-by: Antony Milne <[email protected]>

* Revert special logic handling DictConfig (#2582)

* Partially revert #2378 as OCL no longer returning DictConfig

Signed-off-by: Nok Chan <[email protected]>

* Revert #2176 with special logging handling

Signed-off-by: Nok Chan <[email protected]>

* remove unused import

Signed-off-by: Nok Chan <[email protected]>

---------

Signed-off-by: Nok Chan <[email protected]>

* Re-title and modify introduction to databricks testing guide in contribution section (#2579)

* modify databricks testing guide for contributors

Signed-off-by: Jo Stichbury <[email protected]>

* Update docs/source/contribution/development_for_databricks.md

Co-authored-by: Jannic <[email protected]>

* Update development_for_databricks.md

---------

Signed-off-by: Jo Stichbury <[email protected]>
Co-authored-by: Jannic <[email protected]>

* Quick fix .gitpod.yml (#2585)

* `OmegaConfigLoader` should not show `MissingConfigException` when the file is empty (#2584)

* Allow empty config files

Signed-off-by: Ankita Katiyar <[email protected]>

* Remove condition for empty config

Signed-off-by: Ankita Katiyar <[email protected]>

* Revert "Remove condition for empty config"

This reverts commit 7961155.

* Update release notes

Signed-off-by: Ankita Katiyar <[email protected]>

* Add unit test

Signed-off-by: Ankita Katiyar <[email protected]>

---------

Signed-off-by: Ankita Katiyar <[email protected]>

* Proposal of updated settings.py (#2587)

* Proposal of updated settings.py

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

* Update settings after comment

Signed-off-by: Nok <[email protected]>

---------

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>
Signed-off-by: Nok <[email protected]>

* Collaborative Experiment Tracking Docs  (#2589)

* Add metadata attribute to `kedro.io` datasets (#2537)

* Add metadata attribute to kedro.io datasets

Signed-off-by: Ahdra Merali <[email protected]>

* Update specs in pipeline hooks docstrings (#2598)

* Update pipeline hooks docstrings

Signed-off-by: Tomas Van Pottelbergh <[email protected]>

* Acknowledge community contribution

---------

Signed-off-by: Tomas Van Pottelbergh <[email protected]>
Co-authored-by: Jo Stichbury <[email protected]>
Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

* Miscellaneous hooks improvements (#2596)

* Add debug level logging for hook execution order

Fix gh-1942.

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

* Clarify role of setuptools in hooks

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

* Remove mentions to outdated and unused `pkg_resources`

Fix gh-2391.

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

* Adapt example hook to spec signature

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

* Grammar and style fixes in docs

Co-authored-by: Jo Stichbury <[email protected]>
Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

* Revert "Adapt example hook to spec signature"

This reverts commit ac1b495.

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

---------

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>
Co-authored-by: Jo Stichbury <[email protected]>

* Minor modification to titles of deployment docs to replace "deprecated" with "legacy" (#2606)

* FIX: Typo in markdown for kedro notebooks docs (#2610)

* FIX: Typo in markdown for kedro notebooks docs

Signed-off-by: debugger24 <[email protected]>

* Acknowledge community contribution

---------

Signed-off-by: debugger24 <[email protected]>
Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

* Add the Kedro RichHandler (#2592)

* Add the Kedro RichHandler

Signed-off-by: Nok Chan <[email protected]>

* Clean up imports and comments

Signed-off-by: Nok Chan <[email protected]>

* Map arguments to add flexibility to customize arguments available in RichHandler

Signed-off-by: Nok Chan <[email protected]>

* Clean up rich_logger.py and unused imports

Signed-off-by: Nok Chan <[email protected]>

* Add docs - first iteration

Signed-off-by: Nok Chan <[email protected]>

* Fix imports and small refactoring

Signed-off-by: Nok Chan <[email protected]>

* Improve the doc

Signed-off-by: Nok Chan <[email protected]>

* Update the project's template

Signed-off-by: Nok Chan <[email protected]>

* format docstring

Signed-off-by: Nok Chan <[email protected]>

* Apply Jo's comment on the doc

Signed-off-by: Nok Chan <[email protected]>

* Fix the link with RichHandler

Signed-off-by: Nok Chan <[email protected]>

* Apply suggestions from code review

Co-authored-by: Antony Milne <[email protected]>

* Fix broken doc

Signed-off-by: Nok Chan <[email protected]>

* update template defaults

Signed-off-by: Nok Chan <[email protected]>

* refactoring RichHandler and improve doc

Signed-off-by: Nok Chan <[email protected]>

* Fix broken test due to new default RichHandler

Signed-off-by: Nok Chan <[email protected]>

* Fix doc

Signed-off-by: Nok Chan <[email protected]>

* Move kedro.extras.logging.RichHandler -> kedro.logging.RichHandler

Signed-off-by: Nok Chan <[email protected]>

* add kedro/logging.py and remove the unnecessary import that cause namespace collision

Signed-off-by: Nok Chan <[email protected]>

* Refactor test

Signed-off-by: Nok Chan <[email protected]>

* Add more tests

Signed-off-by: Nok Chan <[email protected]>

* Fix lots of import, docstring

Signed-off-by: Nok Chan <[email protected]>

* Reorder docstring

Signed-off-by: Nok Chan <[email protected]>

* Fix tests

Signed-off-by: Nok Chan <[email protected]>

* Link options to doc

Signed-off-by: Nok Chan <[email protected]>

* Clean up doc and unused logger

Signed-off-by: Nok Chan <[email protected]>

* Fix spelling `customise`

Signed-off-by: Nok Chan <[email protected]>

* Refactor test with fixture

Signed-off-by: Nok Chan <[email protected]>

* Remove unnecessary copy() because it is now a fixture

Signed-off-by: Nok Chan <[email protected]>

* Split up test_rich_traceback_configuration() to smaller tests

Signed-off-by: Nok Chan <[email protected]>

* Add RELEASE.md

Signed-off-by: Nok Chan <[email protected]>

* Update doc

Signed-off-by: Nok Chan <[email protected]>

* Fix template logging

* Mention awesome-kedro in docs (#2620)

* Mention awesome-kedro in docs

See kedro-org/kedro-devrel#40

* Update CONTRIBUTING.md

* Spelling and style fixes

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

Co-authored-by: Jo Stichbury <[email protected]>

---------

Co-authored-by: Jo Stichbury <[email protected]>

* Update SnowparkTableDataSet docs (#2485)

* Update SnowparkTableDataSet docs

* Add missing snowpark dependencies for docs building

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

---------

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>
Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

* Release 0.18.9 (#2619)

* Update __init__.py

* Update release note

Signed-off-by: Nok <[email protected]>

* Update Version Numbers across docs

Signed-off-by: Nok <[email protected]>

* Update RELEASE.md

* Update Release Note

Signed-off-by: Nok <[email protected]>

---------

Signed-off-by: Nok <[email protected]>
Co-authored-by: Jo Stichbury <[email protected]>

* Add documentation for deploying packaged Kedro projects on Databricks (#2595)

* Add deployment workflow page

Signed-off-by: Jannic Holzer <[email protected]>

* Add table of contents, entry point guide, data and conf upload guide

Signed-off-by: Jannic Holzer <[email protected]>

* Add detailed instructions for creating a job on Databricks

Signed-off-by: Jannic Holzer <[email protected]>

* Add images and automated deployment resources

Signed-off-by: Jannic Holzer <[email protected]>

* Remove use of 'allows', add summary

Signed-off-by: Jannic Holzer <[email protected]>

* Remove link to missing image

Signed-off-by: Jannic Holzer <[email protected]>

* Add deployment workflow to toctree

Signed-off-by: Jannic Holzer <[email protected]>

* Lint and fix missing link

Signed-off-by: Jannic Holzer <[email protected]>

* Minor style, syntax and grammar improvements

Signed-off-by: Jannic Holzer <[email protected]>

* Fixes for correctness during validation

Signed-off-by: Jannic Holzer <[email protected]>

* Add instructions for creating log output location

Signed-off-by: Jannic Holzer <[email protected]>

* Lint

Signed-off-by: Jannic Holzer <[email protected]>

* Lint databricks_run

Signed-off-by: Jannic Holzer <[email protected]>

* Minor wording change in reference to logs

Signed-off-by: Jannic Holzer <[email protected]>

* Modify reference to Pyspark-Iris

Signed-off-by: Jannic Holzer <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Fix linter errors to enable docs build for inspection

Signed-off-by: Jo Stichbury <[email protected]>

* Update build-docs.sh

* Fix broken link

Signed-off-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Remove spurious word

Signed-off-by: Jannic Holzer <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Add advantages subheading

Signed-off-by: Jannic Holzer <[email protected]>

* Update docs/source/integrations/databricks_deployment_workflow.md

Co-authored-by: Jo Stichbury <[email protected]>

* Add alternative ways to upload data to DBFS

Signed-off-by: Jannic Holzer <[email protected]>

* Move note on unpackaged config and data

Signed-off-by: Jannic Holzer <[email protected]>

* Fix broken links

Signed-off-by: Jannic Holzer <[email protected]>

* Move databricks back into deployment section

Signed-off-by: Jo Stichbury <[email protected]>

* Remove references to PySpark Iris (pyspark-iris) starter

Signed-off-by: Jannic Holzer <[email protected]>

* Graphics links fixes, revise titles

Signed-off-by: Jo Stichbury <[email protected]>

* Fix broken internal link

Signed-off-by: Jo Stichbury <[email protected]>

* Fix links broken by new folder

Signed-off-by: Jo Stichbury <[email protected]>

* Remove logs directory

Signed-off-by: Jannic Holzer <[email protected]>

* Update image of final job configuration

Signed-off-by: Jannic Holzer <[email protected]>

* Add full stops in list.

Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

* Fix conda environment name.

Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

* Modify wording and image for creating a new job cluster

Signed-off-by: Jannic Holzer <[email protected]>

* Modify wording in guide to create new job cluster

Signed-off-by: Jannic Holzer <[email protected]>

* Remove --upgrade option

Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

* Add both ways of creating a new job

Signed-off-by: Jannic Holzer <[email protected]>

---------

Signed-off-by: Jannic Holzer <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
Co-authored-by: Jo Stichbury <[email protected]>
Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

* Update docs font family to Inter and swap the logo (#2611)

* Update docs font family to Inter

Signed-off-by: Tynan DeBold <[email protected]>

* Match weights to previous Google font

Signed-off-by: Tynan DeBold <[email protected]>

* Update logo images; revert css formatting for easier PR review

Signed-off-by: Tynan DeBold <[email protected]>

* Update text styles

Signed-off-by: Tynan DeBold <[email protected]>

* Add trailing whitespace (?)

Signed-off-by: Tynan DeBold <[email protected]>

* Update Kedro image path

Signed-off-by: Tynan DeBold <[email protected]>

* Update font size

Signed-off-by: Tynan DeBold <[email protected]>

* update font to font-family: 'Inter', sans-serif;

Signed-off-by: huongg <[email protected]>

* testing with important for font-family

Signed-off-by: huongg <[email protected]>

* Make project name lowercase in docs

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

* revert back to kedro/develop

Signed-off-by: huongg <[email protected]>

---------

Signed-off-by: Tynan DeBold <[email protected]>
Signed-off-by: huongg <[email protected]>
Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>
Co-authored-by: Huong Nguyen <[email protected]>
Co-authored-by: huongg <[email protected]>
Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

* Enable variable interpolation for the catalog with `OmegaConfigLoader` (#2621)

* Enable variable interpolation in catalog by escaping _

Signed-off-by: Merel Theisen <[email protected]>

* Add archive link on docs home page (#2636)

Signed-off-by: Jo Stichbury <[email protected]>

* add ravi-kumar-pilla to tsc (#2629)

Signed-off-by: ravi-kumar-pilla <[email protected]>
Co-authored-by: Jo Stichbury <[email protected]>

* Add file for search console verification (#2631)

* add verification file and change to conf

Signed-off-by: Jo Stichbury <[email protected]>

* Fix conf.py so google file is moved to root of docs build

Signed-off-by: Jo Stichbury <[email protected]>

---------

Signed-off-by: Jo Stichbury <[email protected]>

* Chore/update assets for docs (#2625)

* Update docs font family to Inter

Signed-off-by: Tynan DeBold <[email protected]>

* Match weights to previous Google font

Signed-off-by: Tynan DeBold <[email protected]>

* Update logo images; revert css formatting for easier PR review

Signed-off-by: Tynan DeBold <[email protected]>

* Update text styles

Signed-off-by: Tynan DeBold <[email protected]>

* Add trailing whitespace (?)

Signed-off-by: Tynan DeBold <[email protected]>

* Update Kedro image path

Signed-off-by: Tynan DeBold <[email protected]>

* Update font size

Signed-off-by: Tynan DeBold <[email protected]>

* update font to font-family: 'Inter', sans-serif;

Signed-off-by: huongg <[email protected]>

* testing with important for font-family

Signed-off-by: huongg <[email protected]>

* update assets for experiment tracking, docs, pipeline, focus mode, matplotlib and plotly

* update modular pipelines section

Signed-off-by: huongg <[email protected]>

* autoreload

Signed-off-by: huongg <[email protected]>

* reupload autoreload gif

Signed-off-by: huongg <[email protected]>

* revert back to develop branch

Signed-off-by: huongg <[email protected]>

* gif for ET comparison

Signed-off-by: huongg <[email protected]>

* remove jupyter notebook screenshot since its not used anywhere

Signed-off-by: huongg <[email protected]>

* Update databricks viz demo

Signed-off-by: Jannic Holzer <[email protected]>

* pipeline_show_metrics gif

Signed-off-by: huongg <[email protected]>

* update different gif format

Signed-off-by: huongg <[email protected]>

* point to main instead of develop for kedro-banner

Signed-off-by: huongg <[email protected]>

---------

Signed-off-by: Tynan DeBold <[email protected]>
Signed-off-by: huongg <[email protected]>
Signed-off-by: Jannic Holzer <[email protected]>
Co-authored-by: Tynan DeBold <[email protected]>
Co-authored-by: ravi-kumar-pilla <[email protected]>
Co-authored-by: Jo Stichbury <[email protected]>
Co-authored-by: Jannic Holzer <[email protected]>

* Fix the level heading for collab exp tracking so it shows in sidebar (#2647)

Signed-off-by: Jo Stichbury <[email protected]>

* Update Kedro icons in docs with for rebrand (#2652)

Signed-off-by: Tynan DeBold <[email protected]>

* Modify logos (#2651)

Signed-off-by: Jannic Holzer <[email protected]>

* Fix lint

Signed-off-by: Merel Theisen <[email protected]>

* remove the subsection of kedro.extras.extension

Signed-off-by: Nok <[email protected]>

* Fix lint

Signed-off-by: Merel Theisen <[email protected]>
Signed-off-by: Nok <[email protected]>

* remove the subsection of kedro.extras.extension

Signed-off-by: Nok <[email protected]>

---------

Signed-off-by: Merel Theisen <[email protected]>
Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>
Signed-off-by: Nok Chan <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>
Signed-off-by: Nok <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Tomas Van Pottelbergh <[email protected]>
Signed-off-by: debugger24 <[email protected]>
Signed-off-by: Jannic Holzer <[email protected]>
Signed-off-by: Tynan DeBold <[email protected]>
Signed-off-by: huongg <[email protected]>
Signed-off-by: ravi-kumar-pilla <[email protected]>
Co-authored-by: Jo Stichbury <[email protected]>
Co-authored-by: Merel Theisen <[email protected]>
Co-authored-by: Jannic <[email protected]>
Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>
Co-authored-by: Nok Lam Chan <[email protected]>
Co-authored-by: Antony Milne <[email protected]>
Co-authored-by: Ankita Katiyar <[email protected]>
Co-authored-by: rashidakanchwala <[email protected]>
Co-authored-by: Ahdra Merali <[email protected]>
Co-authored-by: Tomas Van Pottelbergh <[email protected]>
Co-authored-by: Rahul Kumar <[email protected]>
Co-authored-by: Tynan DeBold <[email protected]>
Co-authored-by: Huong Nguyen <[email protected]>
Co-authored-by: huongg <[email protected]>
Co-authored-by: Ravi Kumar Pilla <[email protected]>
Co-authored-by: Jannic Holzer <[email protected]>
Co-authored-by: Merel Theisen <[email protected]>
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.

4 participants