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: public dashboards fixes #87870

Merged
merged 4 commits into from
May 16, 2024
Merged

Conversation

imatwawana
Copy link
Collaborator

@imatwawana imatwawana commented May 14, 2024

Minor style fixes including updating old note style to admonitions.

This PR also updates the linking style from docs/refs to ref URIs, which is now the preferred method when linking from source content that's used in multiple projects (i.e., Grafana and Grafana Cloud).

@imatwawana imatwawana added type/docs no-changelog Skip including change in changelog/release notes backport v11.0.x Mark PR for automatic backport to v11.0.x labels May 14, 2024
@imatwawana imatwawana added this to the 11.1.x milestone May 14, 2024
@imatwawana imatwawana self-assigned this May 14, 2024
Copy link
Contributor

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

1 similar comment
Copy link
Contributor

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

@imatwawana imatwawana linked an issue May 14, 2024 that may be closed by this pull request
2 tasks
@imatwawana imatwawana marked this pull request as ready for review May 15, 2024 15:02
@imatwawana imatwawana merged commit 80e2af5 into main May 16, 2024
15 checks passed
@imatwawana imatwawana deleted the ihm/140524-public-dashboards-fixes branch May 16, 2024 13:16
grafana-delivery-bot bot pushed a commit that referenced this pull request May 16, 2024
* Made minor style fixes

* Converted docs ref links to ref URIs and updated note style to admonitions

* Fixed link text and version syntax

(cherry picked from commit 80e2af5)
imatwawana added a commit that referenced this pull request May 16, 2024
Docs: public dashboards fixes (#87870)

* Made minor style fixes

* Converted docs ref links to ref URIs and updated note style to admonitions

* Fixed link text and version syntax

(cherry picked from commit 80e2af5)

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
@imatwawana imatwawana added backport v10.4.x backport v10.3.x Mark PR for automatic backport to v10.3.x labels May 22, 2024
Copy link
Contributor

The backport to v10.4.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-87870-to-v10.4.x origin/v10.4.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 80e2af5d256360e94677d842c3e5155095a13750

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-87870-to-v10.4.x
# Create the PR body template
PR_BODY=$(gh pr view 87870 --json body --template 'Backport 80e2af5d256360e94677d842c3e5155095a13750 from #87870{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[v10.4.x] Docs: public dashboards fixes' --body-file - --label 'type/docs' --label 'no-changelog' --label 'backport' --base v10.4.x --milestone 10.4.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-87870-to-v10.4.x

# Create a pull request where the `base` branch is `v10.4.x` and the `compare`/`head` branch is `backport-87870-to-v10.4.x`.

# Remove the local backport branch
git switch main
git branch -D backport-87870-to-v10.4.x

@grafana-delivery-bot grafana-delivery-bot bot added the backport-failed Failed to generate backport PR. Please resolve conflicts and create one manually. label May 22, 2024
grafana-delivery-bot bot pushed a commit that referenced this pull request May 22, 2024
* Made minor style fixes

* Converted docs ref links to ref URIs and updated note style to admonitions

* Fixed link text and version syntax

(cherry picked from commit 80e2af5)
imatwawana added a commit that referenced this pull request May 23, 2024
* Made minor style fixes

* Converted docs ref links to ref URIs and updated note style to admonitions

* Fixed link text and version syntax

(cherry picked from commit 80e2af5)
imatwawana added a commit that referenced this pull request May 23, 2024
* Docs: public dashboards fixes (#87870)

* Made minor style fixes

* Converted docs ref links to ref URIs and updated note style to admonitions

* Fixed link text and version syntax

(cherry picked from commit 80e2af5)

* Reverted link type

* Reverted note type

* Removed closing admonition tag

---------

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
imatwawana added a commit that referenced this pull request May 23, 2024
* Docs: public dashboards fixes (#87870)

* Made minor style fixes

* Converted docs ref links to ref URIs and updated note style to admonitions

* Fixed link text and version syntax

(cherry picked from commit 80e2af5)

* Removed leftover merge conflict copy

* Removed second set of ref URIs

* Fixed ref text
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport v10.3.x Mark PR for automatic backport to v10.3.x backport v10.4.x backport v11.0.x Mark PR for automatic backport to v11.0.x backport-failed Failed to generate backport PR. Please resolve conflicts and create one manually. no-changelog Skip including change in changelog/release notes type/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Public dashboards: Minor improvements
2 participants