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: Update labels, add cardinality topic #15399

Merged
merged 5 commits into from
Jan 6, 2025

Conversation

JStickler
Copy link
Contributor

What this PR does / why we need it:

Reorganizes and revises the Labels topic to take into account:

  • New default service_name label
  • Label defaults for OTEL
  • Provides additional guidance to help customers avoid known issues with labels

Adds a new topic for cardinality.

@JStickler JStickler added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Dec 12, 2024
@JStickler JStickler requested a review from a team as a code owner December 12, 2024 18:06
@Jayclifford345
Copy link
Contributor

Really great write up on labels and cardinality. These are just a few points I noticed but they are only suggestions :)

@JStickler JStickler force-pushed the 2024.12.12_labels_cardinality branch from 6f40023 to 307ad6d Compare December 16, 2024 14:53
Copy link
Contributor

github-actions bot commented Dec 16, 2024

💻 Deploy preview deleted.

docs/sources/get-started/labels/_index.md Outdated Show resolved Hide resolved
docs/sources/get-started/labels/cardinality.md Outdated Show resolved Hide resolved
@JStickler JStickler force-pushed the 2024.12.12_labels_cardinality branch from 3399efc to 37dec15 Compare January 6, 2025 18:47
@JStickler JStickler force-pushed the 2024.12.12_labels_cardinality branch from 37dec15 to 341df62 Compare January 6, 2025 18:57
Copy link
Collaborator

@slim-bean slim-bean left a comment

Choose a reason for hiding this comment

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

LGTM!

@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Jan 6, 2025

This PR must be merged before a backport PR will be created.

@JStickler JStickler merged commit b5084dc into main Jan 6, 2025
63 checks passed
@JStickler JStickler deleted the 2024.12.12_labels_cardinality branch January 6, 2025 19:43
@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Jan 6, 2025

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

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-15399-to-release-3.3.x
# Create the PR body template
PR_BODY=$(gh pr view 15399 --json body --template 'Backport b5084dcc7f9686ca1500d8d999ebfd08d5c2be59 from #15399{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: Update labels, add cardinality topic (backport release-3.3.x)' --body-file - --label 'size/L' --label 'type/docs' --label 'backport' --base release-3.3.x --milestone release-3.3.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-15399-to-release-3.3.x

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

# Remove the local backport branch
git switch main
git branch -D backport-15399-to-release-3.3.x

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.3.x backport-failed size/L 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