Deploy to GitHub pages

cortexproject · Nov 22, 2024 · 1d50a49 · 1d50a49
1 parent 62f2cf4
commit 1d50a49
Show file tree

Hide file tree

Showing 91 changed files with 94 additions and 173 deletions.
diff --git a/404.html b/404.html
diff --git a/docs/api/index.html b/docs/api/index.html
diff --git a/docs/architecture/index.html b/docs/architecture/index.html
diff --git a/docs/blocks-storage/binary-index-header/index.html b/docs/blocks-storage/binary-index-header/index.html
diff --git a/docs/blocks-storage/bucket-index/index.html b/docs/blocks-storage/bucket-index/index.html
diff --git a/docs/blocks-storage/compactor/index.html b/docs/blocks-storage/compactor/index.html
diff --git a/docs/blocks-storage/convert-long-term-storage-from-chunks-to-blocks/index.html b/docs/blocks-storage/convert-long-term-storage-from-chunks-to-blocks/index.html
diff --git a/docs/blocks-storage/index.html b/docs/blocks-storage/index.html
diff --git a/docs/blocks-storage/learn-more/index.html b/docs/blocks-storage/learn-more/index.html
diff --git a/docs/blocks-storage/migrate-cortex-cluster-from-chunks-to-blocks/index.html b/docs/blocks-storage/migrate-cortex-cluster-from-chunks-to-blocks/index.html
diff --git a/docs/blocks-storage/migrate-storage-from-thanos-and-prometheus/index.html b/docs/blocks-storage/migrate-storage-from-thanos-and-prometheus/index.html
diff --git a/docs/blocks-storage/production-tips/index.html b/docs/blocks-storage/production-tips/index.html
diff --git a/docs/blocks-storage/querier/index.html b/docs/blocks-storage/querier/index.html
diff --git a/docs/blocks-storage/store-gateway/index.html b/docs/blocks-storage/store-gateway/index.html
diff --git a/docs/case-studies/buoyant-cloud/index.html b/docs/case-studies/buoyant-cloud/index.html
diff --git a/docs/case-studies/gojek/index.html b/docs/case-studies/gojek/index.html
diff --git a/docs/case-studies/index.html b/docs/case-studies/index.html
diff --git a/docs/case-studies/rewe-digital/index.html b/docs/case-studies/rewe-digital/index.html
diff --git a/docs/changelog/index.html b/docs/changelog/index.html
diff --git a/docs/code-of-conduct/index.html b/docs/code-of-conduct/index.html
diff --git a/docs/configuration/arguments/index.html b/docs/configuration/arguments/index.html
diff --git a/docs/configuration/configuration-file/index.html b/docs/configuration/configuration-file/index.html
diff --git a/docs/configuration/index.html b/docs/configuration/index.html
diff --git a/docs/configuration/prometheus-frontend/index.html b/docs/configuration/prometheus-frontend/index.html
diff --git a/docs/configuration/v1guarantees/index.html b/docs/configuration/v1guarantees/index.html
diff --git a/docs/contributing/design-patterns-and-code-conventions/index.html b/docs/contributing/design-patterns-and-code-conventions/index.html
diff --git a/docs/contributing/governance/index.html b/docs/contributing/governance/index.html
diff --git a/docs/contributing/how-integration-tests-work/index.html b/docs/contributing/how-integration-tests-work/index.html
diff --git a/docs/contributing/how-to-add-a-maintainer/index.html b/docs/contributing/how-to-add-a-maintainer/index.html
diff --git a/docs/contributing/how-to-run-the-website-locally/index.html b/docs/contributing/how-to-run-the-website-locally/index.html
diff --git a/docs/contributing/how-to-update-the-build-image/index.html b/docs/contributing/how-to-update-the-build-image/index.html
diff --git a/docs/contributing/how-to-upgrade-golang-version/index.html b/docs/contributing/how-to-upgrade-golang-version/index.html
diff --git a/docs/contributing/index.html b/docs/contributing/index.html
diff --git a/docs/contributing/index.xml b/docs/contributing/index.xml
@@ -1,37 +1,4 @@
-<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Cortex – Contributing</title><link>/docs/contributing/</link><description>Recent content in Contributing on Cortex</description><generator>Hugo -- gohugo.io</generator><atom:link href="/docs/contributing/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: Governance</title><link>/docs/contributing/governance/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/contributing/governance/</guid><description>
-&lt;p>This document defines project governance for the project.&lt;/p>
-&lt;h2 id="voting">Voting&lt;/h2>
-&lt;p>The Cortex project employs voting to ensure no single member can dominate the project. Any maintainer may cast a vote. To avoid having a single company dominate the project, at most two votes from maintainers working for the same company will count.&lt;/p>
-&lt;p>For formal votes, a specific statement of what is being voted on should be added to the relevant github issue or PR, and a link to that issue or PR added to the maintainers meeting agenda document.&lt;/p>
-&lt;p>Maintainers should indicate their yes/no vote on that issue or PR, and after a suitable period of time (minimum 2 business weeks), the votes will be tallied and the outcome noted. Maintainers who do not cast a vote, after a suitable period of time, are not included in the majority calculation.&lt;/p>
-&lt;h2 id="maintainer-role">Maintainer Role&lt;/h2>
-&lt;p>Maintainers are required to participate in the project, by joining discussions, submitting and reviewing pull requests, answering user questions, among others.&lt;/p>
-&lt;p>Besides that, we have one concrete activity in which maintainers have to engage from time to time: releasing new versions of Cortex. This process ideally takes only a couple of hours, but requires coordination on different fronts. Even though the process is well documented, it is not without eventual glitches, so, each release needs a &amp;ldquo;Release shepherd&amp;rdquo;. How it works is described in the &lt;a href="https://github.com/cortexproject/cortex/blob/master/RELEASE.md">RELEASE.md&lt;/a> file.&lt;/p>
-&lt;h2 id="changes-in-maintainership">Changes in Maintainership&lt;/h2>
-&lt;p>Contributors who are interested in becoming a maintainer, if performing relevant responsibilities, should discuss their interest with the existing maintainers. New maintainers must be nominated by an existing maintainer and must be elected by 2/3 majority vote.&lt;/p>
-&lt;p>We do not expect anyone to make a permanent commitment to be a Cortex maintainer forever. After all, circumstances change,
-people get new jobs, new interests, and may not be able to continue contributing to the project. At the same time, we need
-to keep the list of maintainers current in order to have effective governance. People may be removed from the current list
-of maintainers via one of the following ways:&lt;/p>
-&lt;ul>
-&lt;li>They can resign&lt;/li>
-&lt;li>If they stop contributing to the project for a period of 6 months or more&lt;/li>
-&lt;li>By a 2/3 majority vote from active maintainers&lt;/li>
-&lt;/ul>
-&lt;p>Former maintainers are recognized with an honorary &lt;em>Emeritus Maintainer&lt;/em> status, and have their names permanently
-listed in the &lt;a href="https://github.com/cortexproject/cortex/blob/master/README.md">README&lt;/a> as a form of gratitude for their contributions.&lt;/p>
-&lt;h2 id="approving-prs">Approving PRs&lt;/h2>
-&lt;p>PRs may be merged after receiving at least two positive votes. If the PR author is a maintainer, this counts as a vote.&lt;/p>
-&lt;h2 id="triage-role">Triage Role&lt;/h2>
-&lt;p>Triagers are contributors who assist in managing and organizing issues and pull requests. See &lt;a href="https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#repository-roles-for-organizations">here&lt;/a> for details about the role’s permission.&lt;/p>
-&lt;h2 id="github-project-administration">Github Project Administration&lt;/h2>
-&lt;p>Maintainers will be added to the collaborators list of the Cortex repository with &amp;ldquo;Write&amp;rdquo; access.&lt;/p>
-&lt;p>After 6 months a maintainer will be given &amp;ldquo;Admin&amp;rdquo; access to the Cortex repository.&lt;/p>
-&lt;h2 id="changes-in-governance">Changes in Governance&lt;/h2>
-&lt;p>All changes in Governance require a 2/3 majority vote.&lt;/p>
-&lt;h2 id="other-changes">Other Changes&lt;/h2>
-&lt;p>Unless specified above, all other changes to the project require a 2/3 majority vote.
-Additionally, any maintainer may request that any change require a 2/3 majority vote.&lt;/p></description></item><item><title>Docs: Design patterns and Code conventions</title><link>/docs/contributing/design-patterns-and-code-conventions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/contributing/design-patterns-and-code-conventions/</guid><description>
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Cortex – Contributing</title><link>/docs/contributing/</link><description>Recent content in Contributing on Cortex</description><generator>Hugo -- gohugo.io</generator><atom:link href="/docs/contributing/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: Governance</title><link>/docs/contributing/governance/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/contributing/governance/</guid><description/></item><item><title>Docs: Design patterns and Code conventions</title><link>/docs/contributing/design-patterns-and-code-conventions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/contributing/design-patterns-and-code-conventions/</guid><description>
 &lt;p>Cortex adopts some design patterns and code conventions that we ask you to follow when contributing to the project. These conventions have been adopted based on the experience gained over the time and aim to enforce good coding practices and keep a consistent UX (ie. config).&lt;/p>
 &lt;h2 id="go-coding-style">Go coding style&lt;/h2>
 &lt;p>Cortex follows the &lt;a href="https://github.com/golang/go/wiki/CodeReviewComments">Go Code Review Comments&lt;/a> styleguide and the &lt;a href="https://peter.bourgon.org/go-in-production/#formatting-and-style">Formatting and style&lt;/a> section of Peter Bourgon&amp;rsquo;s &lt;a href="https://peter.bourgon.org/go-in-production/">Go: Best Practices for Production Environments&lt;/a>.&lt;/p>