Skip to content

Conversation

@StewartJingga
Copy link
Contributor

No description provided.

@StewartJingga StewartJingga added the documentation Improvements or additions to documentation label Jun 27, 2022
@StewartJingga StewartJingga requested a review from ravisuhag June 27, 2022 18:51
@StewartJingga StewartJingga self-assigned this Jun 27, 2022
@StewartJingga StewartJingga linked an issue Jun 27, 2022 that may be closed by this pull request
@coveralls
Copy link

coveralls commented Jun 27, 2022

Pull Request Test Coverage Report for Build 3739403348

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.0%) to 86.183%

Totals Coverage Status
Change from base Build 3529274793: 0.0%
Covered Lines: 4965
Relevant Lines: 5761

💛 - Coveralls

@StewartJingga StewartJingga marked this pull request as ready for review December 5, 2022 06:07
Copy link
Contributor

@sudo-suhas sudo-suhas left a 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.

@ravisuhag ravisuhag merged commit 8833924 into main Jan 2, 2023
@ravisuhag ravisuhag deleted the update-docs branch January 2, 2023 05:51
@sudo-suhas
Copy link
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve documentation

5 participants