Thanks to visit codestin.com
Credit goes to github.com

Skip to content

multicode examples #12945

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

Merged
merged 18 commits into from
Jun 1, 2022
Merged

multicode examples #12945

merged 18 commits into from
Jun 1, 2022

Conversation

davidejones
Copy link
Member

What does this PR do?

  • Displays multiple request body json examples (in an accordion to switch)
  • Display multiple curl examples using the different request body json examples (in an accordion to switch)

Motivation

Preview

https://docs-staging.datadoghq.com/david.jones/multicode-examples/api/latest/events/#post-an-event
https://docs-staging.datadoghq.com/david.jones/multicode-examples/api/latest/logs/#aggregate-events
https://docs-staging.datadoghq.com/david.jones/multicode-examples/api/latest/synthetics/#create-an-api-test

Lots of examples
https://docs-staging.datadoghq.com/david.jones/multicode-examples/api/latest/dashboards/#create-a-new-dashboard

Additional Notes


Reviewer checklist

  • Review the changed files.
  • Review the URLs listed in the Preview section.
  • Check images for PII
  • Review any mentions of "Contact Datadog support" for internal support documentation.

@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Jan 28, 2022
@davidejones davidejones force-pushed the david.jones/multicode-examples branch 2 times, most recently from 299944b to a9af197 Compare February 1, 2022 14:13
@davidejones davidejones force-pushed the david.jones/multicode-examples branch from a9af197 to 7191877 Compare February 9, 2022 12:47
@davidejones davidejones force-pushed the david.jones/multicode-examples branch 2 times, most recently from 72bd9c6 to f70c0cf Compare April 25, 2022 10:49
@davidejones davidejones force-pushed the david.jones/multicode-examples branch 2 times, most recently from e792437 to f7fbbd9 Compare May 3, 2022 11:25
@davidejones davidejones added the Do Not Merge Just do not merge this PR :) label May 3, 2022
@davidejones davidejones marked this pull request as ready for review May 3, 2022 13:21
@davidejones davidejones requested review from a team as code owners May 3, 2022 13:21
@therve
Copy link
Contributor

therve commented May 4, 2022

Looks great! I noticed that the tab appears sometimes randomly when there is only one example.

https://docs-staging.datadoghq.com/david.jones/multicode-examples/api/latest/dashboards/#get-a-dashboard on python/others but not curl

https://docs-staging.datadoghq.com/david.jones/multicode-examples/api/latest/dashboards/#delete-dashboards on curl but not others.

@davidejones davidejones force-pushed the david.jones/multicode-examples branch from f7fbbd9 to cabd9a3 Compare May 4, 2022 14:52
@davidejones
Copy link
Member Author

Thanks for the feedback, I believe that's fixed now @therve

Copy link
Contributor

@urseberry urseberry left a comment

Choose a reason for hiding this comment

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

Spot checked some pages. Looks good!

@therve
Copy link
Contributor

therve commented May 9, 2022

Thanks David, I'm still seeing some slightly inconsistent tabs I think? It's showing on "Get a dashboard" but not "Update a dashboard" for example. Do we want to show the tab when we have a single example?

@davidejones davidejones force-pushed the david.jones/multicode-examples branch from cb7a8ad to 42e0afd Compare May 18, 2022 14:21
@davidejones davidejones force-pushed the david.jones/multicode-examples branch from 42e0afd to 094126c Compare June 1, 2022 11:34
@davidejones
Copy link
Member Author

@therve I've updated to be more consistent, let me know what you think

Copy link
Contributor

@therve therve left a comment

Choose a reason for hiding this comment

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

Looking great!

@urseberry urseberry merged commit fced4a2 into master Jun 1, 2022
@urseberry urseberry deleted the david.jones/multicode-examples branch June 1, 2022 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend Do Not Merge Just do not merge this PR :)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants