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

Add tools documentation page #3331

Merged
merged 81 commits into from
Dec 8, 2023
Merged

Add tools documentation page #3331

merged 81 commits into from
Dec 8, 2023

Conversation

AhdraMeraliQB
Copy link
Contributor

@AhdraMeraliQB AhdraMeraliQB commented Nov 22, 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

Populate the page new_project_tools.md with information on the new tools (formerly known as add-ons).

BLOCKERS:

To-Do:

  • Add images to placeholders

Development notes

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

stichbury and others added 26 commits October 30, 2023 15:32
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
@AhdraMeraliQB AhdraMeraliQB removed the request for review from yetudada December 6, 2023 17:36
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.

Some final minor comments from my side, but other than that this looks good to go! 👏 Amazing work @AhdraMeraliQB and @SajidAlamQB 🥳

docs/source/get_started/new_project.md Outdated Show resolved Hide resolved
docs/source/starters/index.md Outdated Show resolved Hide resolved
docs/source/starters/index.md Outdated Show resolved Hide resolved
docs/source/starters/index.md Outdated Show resolved Hide resolved
AhdraMeraliQB and others added 2 commits December 7, 2023 11:37
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
SajidAlamQB and others added 3 commits December 7, 2023 12:41
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
Signed-off-by: Sajid Alam <90610031+SajidAlamQB@users.noreply.github.com>
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
@amandakys
Copy link

amandakys commented Dec 7, 2023

I'm sorry if this is not a very useful to provide doc's feedback 😅 I had the following thoughts:

  • Is it normal to show the CLI as images rather than code snippets, the images are weirdly scaled compared to the rest of the content
  • when we refer to kedro new --help would it be possible to just show the tools related help text? this would be more relevant we could put ... before and after to indicate it's a snippet.
    image
  • when we use commands as titles i feel it is unclear for example
    image
    imageTo me it just seems like the code snippet is strangely large compared to the others. and it's not immediately clear that its a section header. Perhaps we could change to include some normal text too? For example Specify tools configuration using `kedro new --config=
  • for this line in Kedro tools would it be possible to add the in page linking, since we have it set up already from the nav bar. The available tools include: linting, testing, custom logging, documentation, data structure, PySpark, and Kedro-Viz.
    image

Ahdra Merali and others added 8 commits December 7, 2023 14:56
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Copy link

@amandakys amandakys left a comment

Choose a reason for hiding this comment

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

LGTM

@amandakys
Copy link

oh whoops i noticed this

when i click the custom logging short link it does this to the page (with the large whitespace), its not there at first
image

@AhdraMeraliQB
Copy link
Contributor Author

AhdraMeraliQB commented Dec 8, 2023

@amandakys

https://kedro--3331.org.readthedocs.build/en/3331/starters/new_project_tools.html

Just tested - all in-page links do that, perhaps so the navigation is easier to notice? I think it's a Sphinx/markdown quirk

Edit: Same thing happens on pre-existing https://kedro--3331.org.readthedocs.build/en/3331/configuration/advanced_configuration.html#how-to-use-a-custom-configuration-loader so I'll exclude this from this PR context

@noklam noklam self-requested a review December 8, 2023 11:22
Copy link
Contributor

@noklam noklam left a comment

Choose a reason for hiding this comment

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

https://kedro--3331.org.readthedocs.build/en/3331/starters/index.html

The content looks good to me. One question from me is that I found the order of the docs strange. We mentioned kedro new --config very early but this is rarely used, do we need to included this in the index page?

@AhdraMeraliQB
Copy link
Contributor Author

@noklam

https://kedro--3331.org.readthedocs.build/en/3331/starters/index.html

The content looks good to me. One question from me is that I found the order of the docs strange. We mentioned kedro new --config very early but this is rarely used, do we need to included this in the index page?

We didn't want to rule out seeing a spike in kedro new --config with the additional prompts to the project creation flow. Additionally if there was a discovery problem, this should help 😄

@AhdraMeraliQB AhdraMeraliQB merged commit 331839f into develop Dec 8, 2023
36 checks passed
@AhdraMeraliQB AhdraMeraliQB deleted the docs/add-tools-page branch December 8, 2023 11:35
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.

7 participants