search

kiln / flourish-sdk

The SDK for developing Flourish templates
Other
81 stars 16 forks source link

Documentation for new feature in 3.17 allowing cloning published visualisations? #77

Open aendra-rininsland opened 2 years ago

aendra-rininsland commented 2 years ago

I was going through the release notes and noticed how in 3.17.0, the SDK now allows:

...published visualisations to be cloned into the SDK

How does this work? It sounds really interesting, but AFAICT isn't documented anywhere.

I looked through the commit for that version and this was the only thing in it that seemed to be related to that functionality?

oampo commented 2 years ago

Hey @aendrew! Nice spot - this feature is a little bit hidden away, but we're working on a docs update.

The idea behind the feature is to make it easier for template authors to debug issues with visualisations in production by being able to clone the data and settings into the SDK. So if you have a published visualisation for a particular template, you should be able to start the SDK, and then visit http://localhost:1685/#ID (replacing ID with the ID of the visualisation, which you can take from the end of the published URL - for example http://localhost:1685/#12345678). That will go and fetch the data and settings, and copy them over into the SDK without you needing to manually reproduce the settings or edit the data files.

This isn't very well tested yet, so YMMV, but hopefully it's helpful if you need to do some template debugging.

aendra-rininsland commented 2 years ago

@oampo That's really interesting! Thanks for getting back to me!