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

docs: order configuration template fileds alphabetically #12771

Merged
merged 2 commits into from
Apr 24, 2024

Conversation

trevorwhitney
Copy link
Collaborator

What this PR does / why we need it:

Alphabetizes the order of fields in our auto-generated config doc.

@trevorwhitney trevorwhitney requested a review from a team as a code owner April 23, 2024 22:02
@trevorwhitney trevorwhitney added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Apr 23, 2024
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[Docs team] LGTM
<3

@trevorwhitney trevorwhitney force-pushed the alphabetize-config-template branch from 049356d to 268ec34 Compare April 24, 2024 20:16
@trevorwhitney trevorwhitney merged commit 4404f7d into main Apr 24, 2024
59 checks passed
@trevorwhitney trevorwhitney deleted the alphabetize-config-template branch April 24, 2024 20:59
@grafanabot
Copy link
Collaborator

The backport to release-3.0.x 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-12771-to-release-3.0.x origin/release-3.0.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 4404f7d2f723f7c5baa99873cf786df79ba80aa6

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-12771-to-release-3.0.x
# Create the PR body template
PR_BODY=$(gh pr view 12771 --json body --template 'Backport 4404f7d2f723f7c5baa99873cf786df79ba80aa6 from #12771{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title "chore: [release-3.0.x] docs: order configuration template fileds alphabetically" --body-file - --label "size/XXL" --label "type/docs" --label "backport" --base release-3.0.x --milestone release-3.0.x --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-12771-to-release-3.0.x

# Create a pull request where the `base` branch is `release-3.0.x` and the `compare`/`head` branch is `backport-12771-to-release-3.0.x`.

# Remove the local backport branch
git switch main
git branch -D backport-12771-to-release-3.0.x

JStickler pushed a commit to JStickler/loki that referenced this pull request Apr 30, 2024
JStickler added a commit that referenced this pull request May 2, 2024
…2837)

Co-authored-by: Trevor Whitney <trevorjwhitney@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.0.x backport-failed size/XXL type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants