Docs: Move architecture components doc to Hugo bundles #1517
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Marco Pracucci <marco@pracucci.com>
8 tasks
jdbaldry
approved these changes
Mar 21, 2022
Makefile
Outdated
| @@ -502,4 +502,4 @@ integration-tests: cmd/mimir/$(UPTODATE) | |||
|
|
|||
| include docs/docs.mk | |||
| DOCS_DIR = docs/sources | |||
| docs: doc | |||
| docs: | |||
There was a problem hiding this comment.
I guess this prerequisite was more annoying than useful?
There was a problem hiding this comment.
This is an unintended change :( Sorry for spotting it! Reverted.
There was a problem hiding this comment.
No problem at all. I think there is certainly a case to be made that it gets in the way for rapid iteration on docs. If it's useful, I cd to docs and run make docs there when I know that I don't need to rebuild any of the documentation. The Makefile in that directory does not have the prerequisite target doc so just runs the webserver.
Signed-off-by: Marco Pracucci <marco@pracucci.com>
pracucci
added a commit
that referenced
this pull request
Mar 21, 2022
* Migrated query-frontend doc to Hugo bundle Signed-off-by: Marco Pracucci <marco@pracucci.com> * Migrated query-scheduler doc to Hugo bundle Signed-off-by: Marco Pracucci <marco@pracucci.com> * Migrated compactor doc to Hugo bundle Signed-off-by: Marco Pracucci <marco@pracucci.com> * Reverted unintended change in Makefile Signed-off-by: Marco Pracucci <marco@pracucci.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does
In this PR I'm moving components doc which has images to Hugo bundles.
Which issue(s) this PR fixes or relates to
Part of #1497.
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]