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

CDS dashboard tutorial #52

Merged
merged 50 commits into from
Jun 24, 2022
Merged

CDS dashboard tutorial #52

merged 50 commits into from
Jun 24, 2022

Conversation

sayantikabanik
Copy link
Contributor

@sayantikabanik sayantikabanik commented Jun 20, 2022

resolves #13

Currently I have added a self contained example (without using any external dataset). Happy to add advance examples if required.

This is my first attempt to create documentation using diataxis framework. Open this PR to gather feedback and update accordingly.

@netlify
Copy link

netlify bot commented Jun 20, 2022

Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit ce18ce9
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/62b5e8103e2f1f0009ec1a46
😎 Deploy Preview https://deploy-preview-52--nebari-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@sayantikabanik sayantikabanik changed the title [WIP] CDS dashboard tutorial CDS dashboard tutorial Jun 20, 2022
Copy link
Contributor

@kcpevey kcpevey left a comment

Choose a reason for hiding this comment

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

Thanks @sayantikabanik ! This is a great start. I'd also like to see this page appear in the document itself. I think adding it here should do the trick.

Once you've worked through my comments here and have this page displayed as part of the docs, I'll review again.

docs/docs/tutorials/creating-cds-dashboard.md Outdated Show resolved Hide resolved
docs/docs/tutorials/creating-cds-dashboard.md Outdated Show resolved Hide resolved
docs/docs/tutorials/creating-cds-dashboard.md Outdated Show resolved Hide resolved
docs/docs/tutorials/creating-cds-dashboard.md Outdated Show resolved Hide resolved
docs/docs/tutorials/creating-cds-dashboard.md Outdated Show resolved Hide resolved
docs/docs/tutorials/creating-cds-dashboard.md Outdated Show resolved Hide resolved
docs/docs/tutorials/creating-cds-dashboard.md Outdated Show resolved Hide resolved
docs/docs/tutorials/creating-cds-dashboard.md Outdated Show resolved Hide resolved
docs/docs/tutorials/creating-cds-dashboard.md Outdated Show resolved Hide resolved
docs/docs/tutorials/creating-cds-dashboard.md Outdated Show resolved Hide resolved
sayantikabanik and others added 18 commits June 21, 2022 09:07
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
@sayantikabanik
Copy link
Contributor Author

sayantikabanik commented Jun 21, 2022

Thank you @kcpevey. I have incorporated the suggestions and I'm able to render the document under tutorials

sayantikabanik and others added 18 commits June 22, 2022 08:16
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
@iameskild
Copy link
Member

This is looking great @sayantikabanik and @kcpevey! I like the tree dataset ;)

This made me think of the tree dataset we added to the quansight.qhub.dev intake catalog a few weeks ago. Perhaps at some later date we could integrate those datasets into our tutorials in general.

I created this issue to track the general idea: nebari-dev/nebari#56

@kcpevey
Copy link
Contributor

kcpevey commented Jun 23, 2022

@iameskild that is a good point. I want to use that intake catalog as a basis for all our demos. We started out creating a little package for it, but work for that dropped off. I'll comment on the issue you created.

I will give this one last review sometime today.

Copy link
Member

@iameskild iameskild left a comment

Choose a reason for hiding this comment

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

@sayantikabanik I made a few small edits to the instance (profile) section. Once those changes are, feel free to merge :)

docs/docs/tutorials/creating-cds-dashboard.md Outdated Show resolved Hide resolved
docs/docs/tutorials/creating-cds-dashboard.md Outdated Show resolved Hide resolved
docs/docs/tutorials/creating-cds-dashboard.md Outdated Show resolved Hide resolved
sayantikabanik and others added 3 commits June 24, 2022 07:11
Co-authored-by: eskild <42120229+iameskild@users.noreply.github.com>
Co-authored-by: eskild <42120229+iameskild@users.noreply.github.com>
Co-authored-by: eskild <42120229+iameskild@users.noreply.github.com>
@sayantikabanik
Copy link
Contributor Author

Thanks, @iameskild for me it shows merging is blocked. Could you please check this from your end?

@kcpevey kcpevey merged commit 9a7dd7a into main Jun 24, 2022
@kcpevey kcpevey deleted the cds_tutorial branch June 24, 2022 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done 💪🏾
Development

Successfully merging this pull request may close these issues.

[DOC] Tutorial on using CDS Dashboards
4 participants