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

[Feature Anywhere] [Meta] Add documentation for Feature Anywhere #3383

Closed
6 tasks done
Tracked by #2880
ohltyler opened this issue Feb 4, 2023 · 0 comments · Fixed by #4361 or #4527
Closed
6 tasks done
Tracked by #2880

[Feature Anywhere] [Meta] Add documentation for Feature Anywhere #3383

ohltyler opened this issue Feb 4, 2023 · 0 comments · Fixed by #4361 or #4527
Assignees
Labels
docs Improvements or additions to documentation feature-anywhere v2.9.0

Comments

@ohltyler
Copy link
Member

ohltyler commented Feb 4, 2023

Coming from #2880

We will want to have clear documentation in READMEs to show the following:

  • purpose of the vis_augmenter plugin and how it works
  • examples of each added data model (a VisLayer, a PluginResource, an augment-vis saved object, a vis_layer expressions function)
  • detailed steps on how to onboard a plugin. This should live in the vis_augmenter README, as well as a standalone blog. It may reference plugin documentation with examples
  • examples, usage, & purpose of the new vis_augmenter/stats API
  • limitations / gotchas of the feature (e.g., default limit of 10 resources per vis)
  • the loose coupling, such as freedom to make visualizations ineligible, add plugin resources that are unrelated to the vis, etc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation feature-anywhere v2.9.0
Projects
None yet
2 participants