Skip to content

Commit

Permalink
Docs: fix broken links in website and github (thanos-io#4219)
Browse files Browse the repository at this point in the history
Signed-off-by: Aman Dwivedi <[email protected]>
  • Loading branch information
Aman-Codes authored May 11, 2021
1 parent f4605ce commit 0aa0053
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/contributing/how-to-contribute-to-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ and create PR against Thanos `main` branch.

## White noise

We want all docs to not have any white noise. To achieve it, we provide cleanup-white-noise.sh under `scripts` to check.
We want all docs to not have any white noise. To achieve it, we provide [cleanup-white-noise.sh](https://github.com/thanos-io/thanos/blob/main/scripts/cleanup-white-noise.sh) under `scripts` to check.
You can call it before a pull request, also PR test would call it too.

## Testing
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/mentorship.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Both Thanos and Prometheus projects participate in various, periodic mentoring p

Programs we participated / are participating:

- [CommunityBridge](https://github.com/cncf/mentoring/tree/master/communitybridge)
- [LFX Mentorship](https://github.com/cncf/mentoring/tree/master/lfx-mentorship)
- [Google Summer of Code](https://github.com/cncf/mentoring/tree/master/summerofcode)
- [Red Hat Beyond](https://research.redhat.com/blog/2020/05/24/open-source-development-course-and-devops-methodology/)

Expand Down
2 changes: 1 addition & 1 deletion docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ A store node acts as a gateway to block data that is stored in an object storage
It continuously synchronizes which blocks exist in the bucket and translates requests for metric data into object storage requests. It implements various strategies to minimize the number of requests to the object storage such as filtering relevant blocks by their metadata (e.g. time range and labels) and caching frequent index lookups.

The Prometheus 2.0 storage layout is optimized for minimal read amplification. For example, sample data for the same time series is sequentially aligned in a [chunk file](design.md/#chunk-file). Similarly, series for the same metric name is sequentially aligned as well.
The store node is aware of the files' layout and translates data requests into a plan of a minimum amount of object storage request. Each request may fetch up to hundreds of thousands of [chunks](design.md/#Note) at once. This is essential to satisfy even big queries with a limited amount of requests to the object storage.
The store node is aware of the files' layout and translates data requests into a plan of a minimum amount of object storage request. Each request may fetch up to hundreds of thousands of [chunks](design.md/#chunk) at once. This is essential to satisfy even big queries with a limited amount of requests to the object storage.

Currently, only index data is cached. [Chunk](design.md/#chunk) data could be cached but is orders of magnitude larger in size. In the current state, fetching chunk data from the object storage already only accounts for a small fraction of end-to-end latency. Thus, there's currently no incentive to increase the store nodes resource requirements/limit its scalability by adding chunk caching.

Expand Down
2 changes: 1 addition & 1 deletion docs/operating/use-cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ menu: operating

# Overview

There are many great use cases of [Thanos](thanos.io), we collect them here for others to refer to.
There are many great use cases of [Thanos](https://thanos.io/), we collect them here for others to refer to.

## Horizontal scaleable Prometheus Scraping with Kvass

Expand Down
4 changes: 2 additions & 2 deletions docs/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,14 +108,14 @@ separate what have changed between release candidates.
1. If there were any changes then update the relevant alerting rules and/or dashboards since `thanos-mixin` is part
of the repository now
1. Update website's [hugo.yaml](../website/hugo.yaml) to have correct links for new release (
1. Update website's [hugo.yaml](https://github.com/thanos-io/thanos/blob/main/website/hugo.yaml) to have correct links for new release (
add `0.y.z: "/:sections/:filename.md"`).

1. Update tutorials:

1. Update the Thanos version used in the [tutorials](../tutorials) manifests.
1. In case of any breaking changes or necessary updates adjust the manifests so the tutorial stays up to date.
1. Update the [scripts/quickstart.sh](../scripts/quickstart.sh) script if needed.
1. Update the [scripts/quickstart.sh](https://github.com/thanos-io/thanos/blob/main/scripts/quickstart.sh) script if needed.

1. After review, merge the PR and immediately after this tag a version:

Expand Down
2 changes: 1 addition & 1 deletion docs/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -607,7 +607,7 @@ Example meta.json file:
}
```

Format in Go code can be found [here](../pkg/block/metadata/meta.go).
Format in Go code can be found [here](https://github.com/thanos-io/thanos/blob/main/pkg/block/metadata/meta.go).

##### External Labels

Expand Down

0 comments on commit 0aa0053

Please sign in to comment.