Update adding_metadata.md #24196
Open
Update adding_metadata.md #24196
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Preview links (active after the
|
|
Created DOCS-8475 for Docs Team review. |
domalessi
requested changes
Jul 23, 2024
|
|
||
| [17]: http://json-schema.org/ | ||
| [18]: https://www.schemastore.org/json/ | ||
| [19]: https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/version.schema.json |
There was a problem hiding this comment.
This link seems to be broken? I'm getting a 404.
There was a problem hiding this comment.
Is this the right link: https://github.com/DataDog/schema/blob/main/service-catalog/service.schema.json ??
|
|
||
| Datadog provides a [JSON Schema][17] for service definitions so that when you are editing a service definition in a [supporting IDE][18], features such as autocomplete and validation are provided. The [JSON schema for Datadog service definitions][19] is registered with the open source [Schema Store][18]. | ||
|
|
||
| The plugin supports the new v3.0 schema and includes information that will tell your IDEs which filenames it applies to—specifically, the files entity.datadog.yaml, entity.datadog.yml, and entity.datadog.json to quickly and accurately complete your entity definition file without referencing documentation. In the example below, the IDE automatically creates keys as you fill out the entity definition. |
There was a problem hiding this comment.
We say "plugin" here (and "plugin" is in the title as well), but it's unclear to me what exactly this refers to. Is the Datadog JSON Schema a plugin? I would suggest using plugin everywhere or using some other word like "integration". Whatever you think is best, and just stay consistent.
There was a problem hiding this comment.
Also, I'm not sure how much value-add it is to include "supports the new v3.0 schema"? If you do think this is important, then I'd ask you to clarify what this refers to -- is v3.0 the version for JSON Schema or for Datadog's JSON Schemas? (Let me know if my question doesn't make sense.)
|
|
||
| Datadog provides a [JSON Schema][17] for service definitions so that when you are editing a service definition in a [supporting IDE][18], features such as autocomplete and validation are provided. The [JSON schema for Datadog service definitions][19] is registered with the open source [Schema Store][18]. | ||
|
|
||
| The plugin supports the new v3.0 schema and includes information that will tell your IDEs which filenames it applies to—specifically, the files entity.datadog.yaml, entity.datadog.yml, and entity.datadog.json to quickly and accurately complete your entity definition file without referencing documentation. In the example below, the IDE automatically creates keys as you fill out the entity definition. |
There was a problem hiding this comment.
Suggested change
| The plugin supports the new v3.0 schema and includes information that will tell your IDEs which filenames it applies to—specifically, the files entity.datadog.yaml, entity.datadog.yml, and entity.datadog.json to quickly and accurately complete your entity definition file without referencing documentation. In the example below, the IDE automatically creates keys as you fill out the entity definition. | |
| The plugin informs your IDE about the applicable files—namely, `entity.datadog.yaml`, `entity.datadog.yml`, and `entity.datadog.json`—so you can complete your entity definition file without referencing documentation. In the following example, the IDE automatically creates keys as you fill out the entity definition. |
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Moves a section in service catalog docs and adds a short gif. Replaces image in software templates sub-page. Adds a blog link to software templates sub-page
Merge instructions
Additional notes