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.

Sign up for GitHub

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

Jump to bottom

Docs: Enable users to disable preview for all when publishing Kedro-Viz #1925

Merged
merged 18 commits into from
Jun 12, 2024
Merged

Docs: Enable users to disable preview for all when publishing Kedro-Viz #1925

merged 18 commits into from
Jun 12, 2024

Conversation

jitu5
Copy link
Contributor

@jitu5 jitu5 commented May 23, 2024

Description

Docs added for disabled preview for all datasets under the Publish and share & Preview datasets.

Note: I have not updated the gif for publish popup, as some design changes is pending, I will update it later in this PR.

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

jitu5 and others added 3 commits May 23, 2024 11:56
@jitu5 jitu5 self-assigned this May 23, 2024
@jitu5 jitu5 marked this pull request as ready for review May 29, 2024 09:57
@jitu5 jitu5 requested review from ravi-kumar-pilla, astrojuanlu and rashidakanchwala and removed request for astrojuanlu and rashidakanchwala May 29, 2024 09:57
astrojuanlu
astrojuanlu approved these changes May 29, 2024
View reviewed 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.

💯

@astrojuanlu
Copy link
Member

Rendered result:

https://kedro--1925.org.readthedocs.build/projects/kedro-viz/en/1925/platform_agnostic_sharing_with_kedro_viz.html

https://kedro--1925.org.readthedocs.build/projects/kedro-viz/en/1925/preview_datasets.html

@astrojuanlu
Copy link
Member

Anything missing here @jitu5 ? Or just approvals?

@jitu5
Copy link
Contributor Author

jitu5 commented Jun 4, 2024 •
edited
Loading

Anything missing here @jitu5 ? Or just approvals?

@astrojuanlu Yes, need to update gif for publish popup with disable preview toggle button.

@ravi-kumar-pilla
Copy link
Contributor

ravi-kumar-pilla commented Jun 4, 2024 •
edited
Loading

Hi @jitu5 , I have left few suggestions on the docs. Apart from these, we also need to update the README.md file to have the new option --include-preview in the CLI commands usage documentation. Thank you

jitu5 and others added 2 commits June 5, 2024 09:26
@jitu5 @ravi-kumar-pilla
Update docs/source/platform_agnostic_sharing_with_kedro_viz.md
c05a170 
Co-authored-by: Ravi Kumar Pilla <[email protected]>
Signed-off-by: Jitendra Gundaniya <[email protected]>
@jitu5 @ravi-kumar-pilla
Update docs/source/publish_and_share_kedro_viz_on_azure.md
1de4242 
Co-authored-by: Ravi Kumar Pilla <[email protected]>
Signed-off-by: Jitendra Gundaniya <[email protected]>
jitu5 and others added 3 commits June 5, 2024 09:26
@jitu5 @ravi-kumar-pilla
Update docs/source/publish_and_share_kedro_viz_on_gcp.md
bfec3d7 
Co-authored-by: Ravi Kumar Pilla <[email protected]>
Signed-off-by: Jitendra Gundaniya <[email protected]>
@jitu5 @ravi-kumar-pilla
Update docs/source/publish_and_share_kedro_viz_on_aws.md
32dbadf 
Co-authored-by: Ravi Kumar Pilla <[email protected]>
Signed-off-by: Jitendra Gundaniya <[email protected]>
@jitu5
Readme updated for CLI
d2b33c5 
Signed-off-by: Jitendra Gundaniya <[email protected]>
@jitu5
Copy link
Contributor Author

jitu5 commented Jun 5, 2024

Hi @jitu5 , I have left few suggestions on the docs. Apart from these, we also need to update the README.md file to have the new option --include-preview in the CLI commands usage documentation. Thank you

@ravi-kumar-pilla Updated, Thanks.

ravi-kumar-pilla
ravi-kumar-pilla reviewed Jun 5, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
ravi-kumar-pilla
ravi-kumar-pilla reviewed Jun 5, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@jitu5 @ravi-kumar-pilla
Update README.md
9e8263e 
Co-authored-by: Ravi Kumar Pilla <[email protected]>
Signed-off-by: Jitendra Gundaniya <[email protected]>
ravi-kumar-pilla
ravi-kumar-pilla approved these changes Jun 6, 2024
View reviewed changes
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.

LGTM. Thank you @jitu5

@jitu5 jitu5 merged commit db22b96 into main Jun 12, 2024
25 checks passed
@jitu5 jitu5 deleted the docs/disable-preview branch June 12, 2024 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rashidakanchwala rashidakanchwala rashidakanchwala left review comments

@ravi-kumar-pilla ravi-kumar-pilla ravi-kumar-pilla approved these changes

@astrojuanlu astrojuanlu astrojuanlu approved these changes

Assignees

@jitu5 jitu5

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jitu5 @astrojuanlu @ravi-kumar-pilla @rashidakanchwala