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 and lint discovery.azure to discovery.dockerswarm #2403

Merged
merged 11 commits into from
Jan 22, 2025

Conversation

clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented Jan 14, 2025

PR Description

Splitting Discovery updates into multiple PRs to make reviews a bit easier.

Changes include:

  • Pretty print tables
  • Sort table rows alphabetically - required first, then all optional
  • Sort blocks alphabetically
  • Fix block heading hierarchy
  • Add badge for Required blocks
  • Remove block from heading text
  • Remove extra spaces and extra CR/LFs
  • Fix capitalization
  • Tidy markdown - spaces around lists, indentation, etc.
  • Reduce the passive voice

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

Copy link
Contributor

github-actions bot commented Jan 14, 2025

💻 Deploy preview deleted.

@clayton-cornell
Copy link
Contributor Author

Related issue #2411

@clayton-cornell clayton-cornell changed the title Update and lint discover topics Update and lint discovery topics Jan 15, 2025
@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Jan 15, 2025
@clayton-cornell clayton-cornell marked this pull request as ready for review January 15, 2025 23:36
@clayton-cornell clayton-cornell requested a review from a team January 15, 2025 23:36
@clayton-cornell
Copy link
Contributor Author

clayton-cornell commented Jan 21, 2025

@dehaansa There's been quite a few changes since you last checked this. Might be worth a re-check.

I've noticed inconsistent use of double quotes in the Usage sections. I'm not sure if this is intentional or not.

For example in discovery.docker it is:

discovery.docker "<LABEL>" {
  host = <DOCKER_ENGINE_HOST>
}

and in discovery.dockerswarm it is:

discovery.dockerswarm "<LABEL>" {
  host = "<DOCKER_DAEMON_HOST>"
  role = "<SWARM_ROLE>"
}

@clayton-cornell clayton-cornell changed the title Update and lint discovery topics Update and lint discovery.azure to discovery.dockerswarm Jan 21, 2025
@clayton-cornell clayton-cornell force-pushed the docs/update_component_docs_part_3 branch from 7ea0e3f to 5d245a3 Compare January 21, 2025 17:48
Copy link
Contributor

@thampiotr thampiotr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the better use of space in the tables, thanks!

@thampiotr
Copy link
Contributor

@dehaansa There's been quite a few changes since you last checked this. Might be worth a re-check.

I've noticed inconsistent use of double quotes in the Usage sections. I'm not sure if this is intentional or not.

I think the second example is preferrable - when working with strings, we should always use "" syntax.

@clayton-cornell
Copy link
Contributor Author

when working with strings, we should always use "" syntax.

I'll do a pass through the Usage and Examples to check for this and update.

@clayton-cornell clayton-cornell merged commit 63ba016 into main Jan 22, 2025
24 checks passed
@clayton-cornell clayton-cornell deleted the docs/update_component_docs_part_3 branch January 22, 2025 18:37
github-actions bot pushed a commit that referenced this pull request Jan 22, 2025
* Update discover azure and consul topics

* Update dogitalocean, dns, and docker topics

* Additional style cleanup

* Linting updates and edits

* Syntax and mardown cleanup

* Minor updates from review

* Add missing descriptions and add OSS badge

* Fix a typo and two sentences

* Simplify link definitions

* Fix typo and remove duplicated frontmatter

* Fix literal string quoting in examples

(cherry picked from commit 63ba016)
github-actions bot pushed a commit that referenced this pull request Jan 22, 2025
* Update discover azure and consul topics

* Update dogitalocean, dns, and docker topics

* Additional style cleanup

* Linting updates and edits

* Syntax and mardown cleanup

* Minor updates from review

* Add missing descriptions and add OSS badge

* Fix a typo and two sentences

* Simplify link definitions

* Fix typo and remove duplicated frontmatter

* Fix literal string quoting in examples

(cherry picked from commit 63ba016)
github-actions bot pushed a commit that referenced this pull request Jan 22, 2025
* Update discover azure and consul topics

* Update dogitalocean, dns, and docker topics

* Additional style cleanup

* Linting updates and edits

* Syntax and mardown cleanup

* Minor updates from review

* Add missing descriptions and add OSS badge

* Fix a typo and two sentences

* Simplify link definitions

* Fix typo and remove duplicated frontmatter

* Fix literal string quoting in examples

(cherry picked from commit 63ba016)
github-actions bot pushed a commit that referenced this pull request Jan 22, 2025
* Update discover azure and consul topics

* Update dogitalocean, dns, and docker topics

* Additional style cleanup

* Linting updates and edits

* Syntax and mardown cleanup

* Minor updates from review

* Add missing descriptions and add OSS badge

* Fix a typo and two sentences

* Simplify link definitions

* Fix typo and remove duplicated frontmatter

* Fix literal string quoting in examples

(cherry picked from commit 63ba016)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants