kedro-org / kedro-viz

Visualise your Kedro data and machine-learning pipelines and track your experiments.
https://demo.kedro.org
Apache License 2.0
662 stars 110 forks source link

Shareableviz Docs for Azure and GCP #1748

Closed ravi-kumar-pilla closed 6 months ago

ravi-kumar-pilla commented 6 months ago

Description

Development notes

QA notes

Checklist

rashidakanchwala commented 6 months ago

I would have the layout of this page as :

NeroOkwa commented 6 months ago

I would have the layout of this page as :

  • Publish and Share Kedro-viz

    • Platform-agnostic publish and share

    • Publish and share automatically via cloud providers

    • Publish and share via AWS

    • Publish and share via Azure Blob Storage

    • Publish and share via GCS

i would keep platform-agnostic via kedro viz build as the default way of sharing but if you want to deploy automatically, then we support the following cloud platforms

@rashidakanchwala I agree with this, much better information architecture. Maybe 'Publish and share via Azure' instead.

merelcht commented 6 months ago

Agreed with the layout proposed by @rashidakanchwala. I'd also suggest adding a introduction section or page (a bit similar to https://docs.kedro.org/en/stable/notebooks_and_ipython/index.html) where you describe both approaches in short and link to the relevant sections. That way users don't have to scroll all the way through the page to find out what ways of publishing Viz exist.

rashidakanchwala commented 6 months ago

I suggest creating separate pages for each Publish and Share option:

I believe consolidating all options onto one page could lead to confusion. As a user, when opting for a particular cloud provider, I would prefer straightforward steps tailored to that provider. This structure will provide clarity and ease of navigation.

ravi-kumar-pilla commented 6 months ago

Hi @NeroOkwa , I tried fixing the build issue and addressed PR comments from Rashida. I moved the content around and created new files. I made few modifications to the content but most of it is intact (docs still need refinement). Please have a look and let me know if there is any issue. Thank you

ravi-kumar-pilla commented 6 months ago

Hi Rashida, The docs look crisp and really nice to follow. I have left some comments but most of them are non-blocking for release. Great work !!