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

Docs for Kedro-Viz CLI #2044

Merged
merged 7 commits into from
Aug 19, 2024
Merged

Docs for Kedro-Viz CLI #2044

merged 7 commits into from
Aug 19, 2024

Conversation

rashidakanchwala
Copy link
Contributor

@rashidakanchwala rashidakanchwala commented Aug 19, 2024

Description

Resolves #1705

Development notes

QA 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 new entries to the RELEASE.md file
  • Added tests to cover my changes

Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>
Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>
Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>
Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>
@rashidakanchwala rashidakanchwala self-assigned this Aug 19, 2024
@rashidakanchwala rashidakanchwala marked this pull request as ready for review August 19, 2024 11:32
Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>
Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>
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.

Much better than not having anything ❤️

@rashidakanchwala Did you look at https://sphinx-click.readthedocs.io/en/latest/ ? (Instead of writing the docs manually)

@rashidakanchwala
Copy link
Contributor Author

Much better than not having anything ❤️

@rashidakanchwala Did you look at https://sphinx-click.readthedocs.io/en/latest/ ? (Instead of writing the docs manually)

Nicee, technically I didn't write it. ChatGPT did, i just cleaned it up :) -- but I will look at the above.

Co-authored-by: Ravi Kumar Pilla <ravi_kumar_pilla@mckinsey.com>
Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com>
- TCP port that Kedro Viz will listen to. Defaults to `4141`.

- `--browser / --no-browser`
- Whether to open the Kedro Viz interface in the default browser. The browser will open if the host is `localhost`. Defaults to `True`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need this here ? - The browser will open if the host is localhost

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, i got it from the docs. Maybe we can reword it in cli, and then change it here.

Copy link
Contributor

@ravi-kumar-pilla ravi-kumar-pilla left a comment

Choose a reason for hiding this comment

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

Left a minor comment. LGTM 👍 ... thank you @rashidakanchwala

@rashidakanchwala rashidakanchwala merged commit 7e15c70 into main Aug 19, 2024
10 checks passed
@rashidakanchwala rashidakanchwala deleted the docs-cli branch August 19, 2024 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add CLI reference
3 participants