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] Add summary page for extensions #622

Merged
merged 17 commits into from
Aug 12, 2024

Conversation

Joseph-Perkins
Copy link
Contributor

@Joseph-Perkins Joseph-Perkins commented Aug 8, 2024

Description

Adding a summary page to the documentation to explain the options for customising Vizro dashboard content

Screenshot

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
    • I have not referenced individuals, products or companies in any commits, directly or indirectly.
    • I have not added data or restricted code in any commits, directly or indirectly.

@huong-li-nguyen huong-li-nguyen changed the title Extensions and customisations summary [Docs] Add summary page for extensions Aug 8, 2024
@huong-li-nguyen
Copy link
Contributor

huong-li-nguyen commented Aug 8, 2024

I've linted the PR for you @Joseph-Perkins - a couple of spelling issues, which were immediately raised by vale 🥳

Also vale doesn't like if you use words such as easily or quickly 😄 I guess because it's too subjective?

@stichbury
Copy link
Contributor

Also vale doesn't like if you use words such as easily or quickly 😄 I guess because it's too subjective?

Exactly, and we don't want them to come across as marketing either.

I've made a start at the copy in a commit, but I really don't have the opportunity to finish this now, so will pick it up later. You can see the kind of language changes I'm making though: we need to remove the developer marketing and stick with facts :)

Also, just as a note, we don't "allow" we "enable" because it's not about permission but about facilitation 💅

@stichbury stichbury self-assigned this Aug 9, 2024
@stichbury
Copy link
Contributor

@Joseph-Perkins @huong-li-nguyen I've made quite a few changes to the copy so have added myself to the PR and probably shouldn't approve it. Please could you check what's there now and make any final changes/tweaks before merging?

Copy link
Contributor

@huong-li-nguyen huong-li-nguyen left a comment

Choose a reason for hiding this comment

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

Looks good to me! I am just wondering whether we should simplify our intro to customisations. What I would like the user to take away is that they can embed any Dash component, Plotly chart or Dash callback into Vizro, even if it's not available in our library as a pre-defined model. So everything they can do with Dash is in theory possible with Vizro.

@stichbury
Copy link
Contributor

Looks good to me! I am just wondering whether we should simplify our intro to customisations. What I would like the user to take away is that they can embed any Dash component, Plotly chart or Dash callback into Vizro, even if it's not available in our library as a pre-defined model. So everything they can do with Dash is in theory possible with Vizro.

@huong-li-nguyen I've had a go at this (see https://vizro--622.org.readthedocs.build/en/622/pages/user-guides/extensions/ for latest) but I don't think I'm going to be the most effective at editing beyond this as I can't be sure I'm grouping the different customisation methods correctly.

Please could you, or @Joseph-Perkins, take a look at the sections you think could be simplified and have a go? I can always reword again if needed, but let's get your expert take on it before I do that!

@Joseph-Perkins Joseph-Perkins merged commit 9d710dc into main Aug 12, 2024
32 checks passed
@Joseph-Perkins Joseph-Perkins deleted the docs/extensions_and_customisations_summary branch August 12, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants