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

feat(docs): add notices for "deprecated" fields and variables #6792

Open
bshaffer opened this issue Nov 15, 2023 · 0 comments
Open

feat(docs): add notices for "deprecated" fields and variables #6792

bshaffer opened this issue Nov 15, 2023 · 0 comments

Comments

@bshaffer
Copy link
Contributor

We can now add handy notices for parameters. This is done through the notice_type and notice_content fields in the DocFX YAML:

syntax:
  parameters:
  - id: data
    var_type: array
    description: description
    notice_type: deprecated
    notice_content: 'This description will be added to the deprecated note.'

This can be applied to "deprecated" fields, but could be applied to other fields in the future. We can start by adding support for deprecated fields!

See go/cloud-rad-devsite-notices

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

No branches or pull requests

1 participant