Add developer docs #6623
Add developer docs #6623
Conversation
Codecov Report
|
* Generate ddev cli docs automatically * Use github version directly * Use new plugin format
Co-authored-by: Mike Garabedian <[email protected]>
Co-Authored-By: Julia <[email protected]>
* Add SNMP documentation * Address formatting feedback * Document metric types, explain how to recognize symbol metrics * Add note on choosing tag sources * Fix explanation about index tags * Address nits
There was a problem hiding this comment.
Congratulations on this humongous bag of work :)
As Mike said there's a lot of great stuff and new stuff in this. Definitely going to be helpful. (But tbh, wondering how long until a substantial part of this becomes outdated, he! IMO we should aim for a wiki-like edit experience, and the auto-deploy-on-push-edit workflow will definitely help there.)
Holding off onto my ✅ because I have a few nits and questions, but this LGTM.
datadog_checks_dev/datadog_checks/dev/tooling/commands/docs/serve.py
Outdated
Show resolved
Hide resolved
datadog_checks_dev/datadog_checks/dev/tooling/commands/docs/deploy.py
Outdated
Show resolved
Hide resolved
datadog_checks_dev/datadog_checks/dev/tooling/commands/docs/deploy.py
Outdated
Show resolved
Hide resolved
| result = run_or_abort( | ||
| f'git commit -m "build docs at {latest_commit_hash}"', capture=True, ignore_exit_code=True | ||
| ) |
There was a problem hiding this comment.
Just a heads up FYI: I have my git setup to commit with my DD account and GPG keys inside ~/dd, and my personal account (and keys) elsewhere, and this command makes git use my personal account.
I'm not sure why. Obviously we're not inside ~/dd at this point (but in a random tmp dir), but the git config setup done above should override my ~/.gitconfig-*, right? I also tried passing git commit --author "{git_user} <{git_email}>" but it doesn't take it into account either.
Not a big issue but if you have any clues I'd be interested. :)
There was a problem hiding this comment.
Hmm that's interesting. I'm not sure
What does this PR do?
https://datadoghq.dev/integrations-core/
Motivation
Better docs for a better world.
Additional Notes
For implementation details, see https://datadoghq.dev/integrations-core/meta/docs/