Fix broken doc link in quickwit-storage #3735
Merged
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
In quickwit-oss#3709 there was a refactor that removed `StorageConfig` from the scope of the changed file in this commit. This was fine as the function `register` in StorageResolveBuilder did not need it anymore. However, the docs alluded to registering both a factory and a config. When running `make build-docs` for a different change I ran into this causing the command to fail. This change updates the docs so that they can build properly again.
guilload
approved these changes
Aug 10, 2023
|
CI used to perform that check but no longer does because of recent refactor of the workflow. Can you fix that too? |
|
@guilload do you mean this part right here? Would this not always run now if the source changed? |
|
|
|
Merging. I don't think @mgattozzi has the permissions to do that. |
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.
Description
In #3709 there was a refactor that removed
StorageConfigfrom the scope of the changed file in this commit. This was fine as the functionregisterin StorageResolveBuilder did not need it anymore. However, the docs alluded to registering both a factory and a config. When runningmake build-docsfor a different change I ran into this causing the command to fail. This change updates the docs so that they can build properly again.How was this PR tested?
I ran
make build-docsto make sure they built and checked the output.