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: Rename variables pages #87844

Merged
merged 6 commits into from
May 23, 2024
Merged

Docs: Rename variables pages #87844

merged 6 commits into from
May 23, 2024

Conversation

imatwawana
Copy link
Collaborator

This PR:

  • Updates menuTitle and page title of the Manage variables page to Add variables
  • Updates the title of Inspect variables page to Manage and inspect variables (menuTitle remains as is)
  • Moves the paragraph of “manage” content from the new Add variables page to the new Manage and inspect variables page

Justification

  • This keeps everything that’s in the configuration UI on one page and everything on the Variables page UI on another page
  • The original file name of the Manage variables page is add-tempate-variables and the content is primarily about adding them and all the different types that you can add
  • When I was on the Inspect variables (docs) page and realized it was about actions you could take on the main Variables page in the UI, I expected to find the rest of the actions I could take on this page here

@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
@imatwawana imatwawana requested review from a team, ivanortegaalba and mdvictor and removed request for a team May 14, 2024 16:00
@imatwawana imatwawana linked an issue May 14, 2024 that may be closed by this pull request
7 tasks
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 added backport v10.3.x Mark PR for automatic backport to v10.3.x backport v10.4.x labels May 22, 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 merged commit 197ce30 into main May 23, 2024
11 checks passed
@imatwawana imatwawana deleted the ihm/140524-variables-IA-updates branch May 23, 2024 15:31
Copy link
Contributor

The backport to v10.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-87844-to-v10.3.x origin/v10.3.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 197ce3042d6760530a32819a924ddbf09bf0af2c

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-87844-to-v10.3.x
# Create the PR body template
PR_BODY=$(gh pr view 87844 --json body --template 'Backport 197ce3042d6760530a32819a924ddbf09bf0af2c from #87844{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[v10.3.x] Docs: Rename variables pages' --body-file - --label 'type/docs' --label 'no-changelog' --label 'backport' --base v10.3.x --milestone 10.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-87844-to-v10.3.x

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

# Remove the local backport branch
git switch main
git branch -D backport-87844-to-v10.3.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 23, 2024
grafana-delivery-bot bot pushed a commit that referenced this pull request May 23, 2024
* Renamed Manage variables page to Add variables

* Renamed Inspect variables page to Manage and inspect variables

* Updated H1 on Add variables

* Moved Manage variables content to from Add varibles page to Manage and inspect variables page and updated text to fit

* Updated link style to ref URIs in Manage and inspect variables

(cherry picked from commit 197ce30)
Copy link
Contributor

The backport to v11.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-87844-to-v11.0.x origin/v11.0.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 197ce3042d6760530a32819a924ddbf09bf0af2c

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-87844-to-v11.0.x
# Create the PR body template
PR_BODY=$(gh pr view 87844 --json body --template 'Backport 197ce3042d6760530a32819a924ddbf09bf0af2c from #87844{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[v11.0.x] Docs: Rename variables pages' --body-file - --label 'type/docs' --label 'no-changelog' --label 'backport' --base v11.0.x --milestone 11.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-87844-to-v11.0.x

# Create a pull request where the `base` branch is `v11.0.x` and the `compare`/`head` branch is `backport-87844-to-v11.0.x`.

# Remove the local backport branch
git switch main
git branch -D backport-87844-to-v11.0.x

imatwawana added a commit that referenced this pull request May 23, 2024
* Docs: Rename variables pages (#87844)

* Renamed Manage variables page to Add variables

* Renamed Inspect variables page to Manage and inspect variables

* Updated H1 on Add variables

* Moved Manage variables content to from Add varibles page to Manage and inspect variables page and updated text to fit

* Updated link style to ref URIs in Manage and inspect variables

(cherry picked from commit 197ce30)

* Fixed bullet list

* trigger CI

* Ran prettier

---------

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
* Renamed Manage variables page to Add variables

* Renamed Inspect variables page to Manage and inspect variables

* Updated H1 on Add variables

* Moved Manage variables content to from Add varibles page to Manage and inspect variables page and updated text to fit

* Updated link style to ref URIs in Manage and inspect variables

(cherry picked from commit 197ce30)
imatwawana added a commit that referenced this pull request May 23, 2024
* Renamed Manage variables page to Add variables

* Renamed Inspect variables page to Manage and inspect variables

* Updated H1 on Add variables

* Moved Manage variables content to from Add varibles page to Manage and inspect variables page and updated text to fit

* Updated link style to ref URIs in Manage and inspect variables

(cherry picked from commit 197ce30)
imatwawana added a commit that referenced this pull request May 23, 2024
* Docs: Rename variables pages (#87844)

* Renamed Manage variables page to Add variables

* Renamed Inspect variables page to Manage and inspect variables

* Updated H1 on Add variables

* Moved Manage variables content to from Add varibles page to Manage and inspect variables page and updated text to fit

* Updated link style to ref URIs in Manage and inspect variables

(cherry picked from commit 197ce30)

* Fixed link type
imatwawana added a commit that referenced this pull request May 23, 2024
Docs: Rename variables pages (#87844)

* Renamed Manage variables page to Add variables

* Renamed Inspect variables page to Manage and inspect variables

* Updated H1 on Add variables

* Moved Manage variables content to from Add varibles page to Manage and inspect variables page and updated text to fit

* Updated link style to ref URIs in Manage and inspect variables

(cherry picked from commit 197ce30)
ryantxu pushed a commit that referenced this pull request May 24, 2024
* Renamed Manage variables page to Add variables

* Renamed Inspect variables page to Manage and inspect variables

* Updated H1 on Add variables

* Moved Manage variables content to from Add varibles page to Manage and inspect variables page and updated text to fit

* Updated link style to ref URIs in Manage and inspect variables
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.

Improve Dashboards docs information architecture
2 participants