Merged
Conversation
Closed
Pull Request Test Coverage Report for Build 3739403348
💛 - Coveralls |
sudo-suhas
requested changes
Dec 6, 2022
Contributor
There was a problem hiding this comment.
Please apply the following changes to fix the broken relative links:
diff --git a/docs/docs/installation.md b/docs/docs/installation.md
index 70123b0..0bd40a8 100644
--- a/docs/docs/installation.md
+++ b/docs/docs/installation.md
@@ -76,6 +76,6 @@ ## Serving
\```
## Required Header/Metadata in API
-Compass has a concept of [User](../concepts/user.md). In the current version, all HTTP & gRPC APIs in Compass requires an identity header/metadata in the request. The header key is configurable but the default name is `Compass-User-UUID`.
+Compass has a concept of [User](concepts/user.md). In the current version, all HTTP & gRPC APIs in Compass requires an identity header/metadata in the request. The header key is configurable but the default name is `Compass-User-UUID`.
-Compass APIs also expect an additional optional e-mail header. This is also configurable and the default name is `Compass-User-Email`. The purpose of having this optional e-mail header is described in the [User](../concepts/user.md) section.
\ No newline at end of file
+Compass APIs also expect an additional optional e-mail header. This is also configurable and the default name is `Compass-User-Email`. The purpose of having this optional e-mail header is described in the [User](concepts/user.md) section.
Also, can drop --location --request GET from curl request examples.
sudo-suhas
reviewed
Dec 6, 2022
sudo-suhas
approved these changes
Jan 2, 2023
Contributor
|
Looks like we missed a broken link. It is breaking the docs build - https://github.com/odpf/compass/actions/runs/3820770546/jobs/6499318539#step:5:29. Raised a fix here - #193. Please suggest if we could link it to something else instead. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
No description provided.