Create an example dashboard for novice/intermediate/advanced users

[stichbury]

This is a good ticket for anyone wanting to learn how to use Vizro. It doesn't require any prior knowledge (having an open "beginners'" mind will be more helpful in fact. The issue mostly needs coding although any docs you write to explain your example will be appreciated.

As part of the drive to create more examples and populate an "awesome-vizro" style portfolio of dashboards, this is an issue that could be delivered many times over. We would like to encourage multiple contributors to create examples that use different datasets and techniques. It's very much open to interpretation.

We need to highlight key features, layouts, components and controls. Ideally we need different levels, or progression from basic to advanced usage. The example would ideally be delivered as a script with some accompanying markdown to document it, but we can take notebooks if you prefer to use those for combining example and documentation together. The example code is our main ideal and documentation is desirable but not essential. If your example is simple enough, it should be relatively self documenting! 😆

I will leave it to the engineering team to highlight the main elements we'd like to see in examples, and there may be some preferred datasets too (see comments below). Check our existing tutorials and how to guides, plus the demo example in the repo, for ideas.

[kaestro]

@stichbury can i get assigned with this issue? I feel like I'm ready to start on using vizro

[stichbury]

Wow, yes please, that would be great. Thanks for volunteering @kaestro! I'll make you a separate issue and add you to it, since this is an ongoing ticket to gather more example dashboards from contributors and team alike.

Do you know what you'll work on? We have just dropped an article about reusable dashboards if you want to use it as a template to build your own example (either take the code or work from scratch!).

[kaestro]

I've read the article and clapped on it. Thanks for writing wonderful post. It gave me an insight on how to work on projects I've been working on nowadays.

I feel sorry for that I haven't used vizro yet, but that's why I'm trying to start with this one.

right now I'm thinking of getting traffic or read the docs data from my blog or so, but if there's some recommended site to get dummy data from it would be of real help

[stichbury]

Thanks @kaestro! You can build dummy data for the Notebook -- there's a script in my repo https://github.com/stichbury/documentation_project which creates a set (if you fiddle around in the notebook you can change the data creation to randomise it if you've more Python skills than me).

[sulphatet]

Hi @stichbury! If more hands might be helpful, I too would like to work on this.

[stichbury]

Please do @sulphatet! We'd love to see any example dashboard you create. We have started a page of examples from our users here https://vizro.readthedocs.io/en/stable/pages/examples/your-examples/ and if you put anything together and share the code on GitHub (or write your own blog post) we'd be happy to review it to assess if it's suitable for inclusion.