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

update generate-docs script #1503

Merged
merged 3 commits into from
Nov 5, 2024
Merged

Conversation

celenechang
Copy link
Contributor

@celenechang celenechang commented Nov 4, 2024

What does this PR do?

Refine generate-docs script so that

  1. Parameter name is not repeated in first word of description for easier readability
  2. Accepts description overrides in a JSON file, for parameters that are not defined in our types file (i.e. imports)

This PR also edits a couple of our internal descriptions based on recommendations from the docs team

Motivation

Improving our documentation

Additional Notes

Anything else we should know when reviewing?

Minimum Agent Versions

Are there minimum versions of the Datadog Agent and/or Cluster Agent required?

  • Agent: vX.Y.Z
  • Cluster Agent: vX.Y.Z

Describe your test plan

Write there any instructions and details you may have to test your PR.

Checklist

  • PR has at least one valid label: bug, enhancement, refactoring, documentation, tooling, and/or dependencies
  • PR has a milestone or the qa/skip-qa label

@celenechang celenechang added documentation Improvements or additions to documentation tooling qa/skip-qa labels Nov 4, 2024
@celenechang celenechang added this to the v1.11.0 milestone Nov 4, 2024
@celenechang celenechang requested review from a team as code owners November 4, 2024 17:52
@codecov-commenter
Copy link

codecov-commenter commented Nov 4, 2024

Codecov Report

Attention: Patch coverage is 0% with 33 lines in your changes missing coverage. Please review.

Project coverage is 48.64%. Comparing base (58f766a) to head (4163ed2).

Files with missing lines Patch % Lines
hack/generate-docs.go 0.00% 33 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1503      +/-   ##
==========================================
- Coverage   48.70%   48.64%   -0.06%     
==========================================
  Files         224      224              
  Lines       19845    19869      +24     
==========================================
  Hits         9666     9666              
- Misses       9670     9694      +24     
  Partials      509      509              
Flag Coverage Δ
unittests 48.64% <0.00%> (-0.06%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
api/datadoghq/v2alpha1/datadogagent_types.go 100.00% <ø> (ø)
hack/generate-docs.go 0.00% <0.00%> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 58f766a...4163ed2. Read the comment docs.

@celenechang celenechang force-pushed the celene/update_generate_docs_script branch from 2335836 to 4163ed2 Compare November 4, 2024 18:01
@celenechang celenechang merged commit 7c7d028 into main Nov 5, 2024
20 checks passed
@celenechang celenechang deleted the celene/update_generate_docs_script branch November 5, 2024 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation qa/skip-qa tooling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants