Skip to content

General updates and corrections to the Alloy Component docs part 1 #3666

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

Merged
merged 6 commits into from
Jun 2, 2025

Conversation

clayton-cornell
Copy link
Contributor

This PR is part of a series of PRs that aim to catch a few minor typos and errors that have crept into the docs through all the recent refactoring and updates.

Most corrections are minor:

  • fix anchor links in the page
  • fix occasional typos
  • sort out some table formatting that was missed or has shown up from other unrelated edits
  • remove some extra spaces at the start/end of lines

This PR also includes validating the args etc. against the source files (as a double check to make sure everything matches).

Copy link
Contributor

github-actions bot commented May 22, 2025

💻 Deploy preview deleted.

@clayton-cornell clayton-cornell changed the title General updates and corrections to the Alloy Component docs General updates and corrections to the Alloy Component docs part 1 May 22, 2025
@clayton-cornell clayton-cornell marked this pull request as draft May 23, 2025 23:03
@clayton-cornell clayton-cornell marked this pull request as ready for review May 26, 2025 23:16
Copy link
Contributor

@dehaansa dehaansa left a comment

Choose a reason for hiding this comment

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

LGTM

@clayton-cornell clayton-cornell merged commit 9265dcd into main Jun 2, 2025
44 checks passed
@clayton-cornell clayton-cornell deleted the docs/validate_component_docs_part1 branch June 2, 2025 19:40
Copy link
Contributor

github-actions bot commented Jun 2, 2025

The backport to release/v1.6 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-3666-to-release/v1.6 origin/release/v1.6
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 9265dcd5c3b70048fcfe622eb146434262e2d506
# Push it to GitHub
git push --set-upstream origin backport-3666-to-release/v1.6
git switch main
# Remove the local backport branch
git branch -D backport-3666-to-release/v1.6

Then, create a pull request where the base branch is release/v1.6 and the compare/head branch is backport-3666-to-release/v1.6.

Copy link
Contributor

github-actions bot commented Jun 2, 2025

The backport to release/v1.7 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-3666-to-release/v1.7 origin/release/v1.7
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 9265dcd5c3b70048fcfe622eb146434262e2d506
# Push it to GitHub
git push --set-upstream origin backport-3666-to-release/v1.7
git switch main
# Remove the local backport branch
git branch -D backport-3666-to-release/v1.7

Then, create a pull request where the base branch is release/v1.7 and the compare/head branch is backport-3666-to-release/v1.7.

Copy link
Contributor

github-actions bot commented Jun 2, 2025

The backport to release/v1.8 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-3666-to-release/v1.8 origin/release/v1.8
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 9265dcd5c3b70048fcfe622eb146434262e2d506
# Push it to GitHub
git push --set-upstream origin backport-3666-to-release/v1.8
git switch main
# Remove the local backport branch
git branch -D backport-3666-to-release/v1.8

Then, create a pull request where the base branch is release/v1.8 and the compare/head branch is backport-3666-to-release/v1.8.

Copy link
Contributor

github-actions bot commented Jun 2, 2025

The backport to release/v1.9 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-3666-to-release/v1.9 origin/release/v1.9
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 9265dcd5c3b70048fcfe622eb146434262e2d506
# Push it to GitHub
git push --set-upstream origin backport-3666-to-release/v1.9
git switch main
# Remove the local backport branch
git branch -D backport-3666-to-release/v1.9

Then, create a pull request where the base branch is release/v1.9 and the compare/head branch is backport-3666-to-release/v1.9.

clayton-cornell added a commit that referenced this pull request Jun 2, 2025
…3666)

* Minor updates to fix typos and catch data type mistakes

* General updates and corrections

* Fix some double quoting

* Fix quoting on duration datatype defaults

* Fix string quoting

* One more pass for consistency

(cherry picked from commit 9265dcd)
clayton-cornell added a commit that referenced this pull request Jun 2, 2025
…3666)

* Minor updates to fix typos and catch data type mistakes

* General updates and corrections

* Fix some double quoting

* Fix quoting on duration datatype defaults

* Fix string quoting

* One more pass for consistency

(cherry picked from commit 9265dcd)
clayton-cornell added a commit that referenced this pull request Jun 2, 2025
…3666)

* Minor updates to fix typos and catch data type mistakes

* General updates and corrections

* Fix some double quoting

* Fix quoting on duration datatype defaults

* Fix string quoting

* One more pass for consistency

(cherry picked from commit 9265dcd)
@clayton-cornell
Copy link
Contributor Author

Removed backport to v1.6 - limiting backports for these fixes to just 3 releases back per Grafana standard

clayton-cornell added a commit that referenced this pull request Jun 3, 2025
…3666) (#3739)

* Minor updates to fix typos and catch data type mistakes

* General updates and corrections

* Fix some double quoting

* Fix quoting on duration datatype defaults

* Fix string quoting

* One more pass for consistency

(cherry picked from commit 9265dcd)
clayton-cornell added a commit that referenced this pull request Jun 3, 2025
…3666) (#3740)

* Minor updates to fix typos and catch data type mistakes

* General updates and corrections

* Fix some double quoting

* Fix quoting on duration datatype defaults

* Fix string quoting

* One more pass for consistency

(cherry picked from commit 9265dcd)
clayton-cornell added a commit that referenced this pull request Jun 3, 2025
…3666) (#3741)

* Minor updates to fix typos and catch data type mistakes

* General updates and corrections

* Fix some double quoting

* Fix quoting on duration datatype defaults

* Fix string quoting

* One more pass for consistency

(cherry picked from commit 9265dcd)
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.

2 participants