-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Add developer docs #6623
Add developer docs #6623
Conversation
Codecov Report
|
* Generate ddev cli docs automatically * Use github version directly * Use new plugin format
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is so much great stuff in here 🎉
But it also covers so much ground - it might be helpful to break it down into separate PRs for docs-only, and doc generation code ..
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm that's interesting. I'm not sure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New browser opening in docs serve
works fab 💯
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔥 * 💯 !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🏅
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/