Skip to content

[dashboards] Add new Dashboard API docs#3924

Merged
l0k0ms merged 15 commits intomasterfrom
rami/add_new_dashboard_api
Feb 14, 2019
Merged

[dashboards] Add new Dashboard API docs#3924
l0k0ms merged 15 commits intomasterfrom
rami/add_new_dashboard_api

Conversation

@enbashi
Copy link
Copy Markdown
Contributor

@enbashi enbashi commented Feb 5, 2019

What does this PR do?

Adds documentation and code examples for the new dashboards API.

Motivation

New API.

Preview link

https://docs-staging.datadoghq.com/rami/add_new_dashboard_api/api/#dashboards

Additional Notes

@enbashi enbashi requested review from a team and mstbbs as code owners February 5, 2019 02:47
@l0k0ms l0k0ms added API Do Not Merge Just do not merge this PR :) labels Feb 5, 2019
Copy link
Copy Markdown
Contributor

@MLaureB MLaureB left a comment

Choose a reason for hiding this comment

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

The docs look good to me!
I have one overall suggestion: I think the Dashboards section should stand right before the Dashboard Lists section (and not at the end).

@@ -0,0 +1,26 @@
{
"dash": {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is an example for the legacy timeboard API: we need to change it with the new one 🙂

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

oops. Thanks for catching that.

@l0k0ms
Copy link
Copy Markdown
Contributor

l0k0ms commented Feb 6, 2019

@MLaureB @enbashi Should we remove the timeboard API doc then since this one replaces it?

@MLaureB
Copy link
Copy Markdown
Contributor

MLaureB commented Feb 6, 2019

@l0k0ms , so we should not remove the timeboard API doc completely as we're gonna still have a bunch of people using it who might want to refer to it, but would that be possible to only show the new Dashboards one (and hide the Timeboards one) and put somewhere a link to the legacy timeboards API, in case people still want to access it?

@l0k0ms
Copy link
Copy Markdown
Contributor

l0k0ms commented Feb 7, 2019

@DataDog/baklava for visibility: this PR now removes the current Timeboard API endpoint doc and replaces it with the new Dashboard endpoint.

It removes the current graphing/dashboard/widget/page and put it into the FAQ section for now. as a freeze.

Next steps are:

1 - Create a new branch to re-introduce the timeboard API as a stand-alone page in the FAQ section in order to keep documentation available in case customers would like to refer to it.

2 - Create a new branch to create a whole widget sub-section in the graphing section that will directly implement the new widget logic, and will be an update on the current widget doc.

@l0k0ms l0k0ms mentioned this pull request Feb 8, 2019
@l0k0ms
Copy link
Copy Markdown
Contributor

l0k0ms commented Feb 8, 2019

PR to introduce timeboard API as a FAQ: #3950 ping @MLaureB

@l0k0ms
Copy link
Copy Markdown
Contributor

l0k0ms commented Feb 8, 2019

PR to introduce the new widget section: #3948

@l0k0ms l0k0ms removed the Do Not Merge Just do not merge this PR :) label Feb 13, 2019
@l0k0ms l0k0ms merged commit 596fdab into master Feb 14, 2019
@l0k0ms l0k0ms deleted the rami/add_new_dashboard_api branch February 14, 2019 12:53
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.

3 participants