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: move dashboards to hugo bundles #1514

Merged
merged 3 commits into from
Mar 21, 2022
Merged

Conversation

pracucci
Copy link
Collaborator

What this PR does

This is the 1st PR to migrate docs to Hugo bundles. This PR addresses the dashboard images. I've also took the opportunity to update the screenshots, so we're ready for 2.0.0 final.

Which issue(s) this PR fixes or relates to

N/A

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

Signed-off-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Marco Pracucci <marco@pracucci.com>
Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

Looks good to me with a nit about the find command.

I ran the local webserver and checked all the images look good.

Makefile Outdated
@@ -468,7 +468,7 @@ mixin-serve: ## Runs Grafana (listening on port 3000) loading the mixin dashboar
@./operations/mimir-mixin-tools/serve/run.sh

mixin-screenshots: ## Generates mixin dashboards screenshots.
@rm -f docs/sources/images/dashboards/*.png
@find docs/sources/operators-guide/visualizing-metrics/dashboards -name '*.png' | xargs rm
Copy link
Member

Choose a reason for hiding this comment

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

It's considered safer to use -delete or -print0 | xargs -0 rm to handle files with spaces and stuff

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

👍 I used -delete

Signed-off-by: Marco Pracucci <marco@pracucci.com>
@pracucci pracucci enabled auto-merge (squash) March 21, 2022 10:38
@pracucci pracucci merged commit 4646b16 into main Mar 21, 2022
@pracucci pracucci deleted the move-dashboards-to-hugo-bundles branch March 21, 2022 10:50
pracucci added a commit that referenced this pull request Mar 21, 2022
* Moved dashboards to Hugo bundles

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Updated screenshot generator tool and screenshots

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Addressed review feedback

Signed-off-by: Marco Pracucci <marco@pracucci.com>
@pracucci pracucci mentioned this pull request Mar 21, 2022
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants