-
Notifications
You must be signed in to change notification settings - Fork 9
doc: improve documentation #155
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
Conversation
Pull Request Test Coverage Report for Build 3739403348
💛 - Coveralls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
|
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. |
No description provided.