Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
/.bundle/ @cockroachdb/docs-infra-prs
/.github/ @cockroachdb/docs-infra-prs
/__tests__/ @cockroachdb/docs-infra-prs
/_layouts/ @cockroachdb/docs-infra-prs
/_plugins/ @cockroachdb/docs-infra-prs
/css/ @cockroachdb/docs-infra-prs
/fonts/ @cockroachdb/docs-infra-prs
/githooks/ @cockroachdb/docs-infra-prs
/jekyll-algolia-dev/ @cockroachdb/docs-infra-prs
/js/ @cockroachdb/docs-infra-prs
/netlify/ @cockroachdb/docs-infra-prs
/vale/ @cockroachdb/docs-infra-prs
_redirects @cockroachdb/docs-infra-prs
.gitattributes @cockroachdb/docs-infra-prs
.gitignore @cockroachdb/docs-infra-prs
.htmltest.yaml @cockroachdb/docs-infra-prs
.vale.ini @cockroachdb/docs-infra-prs
Gemfile @cockroachdb/docs-infra-prs
Makefile @cockroachdb/docs-infra-prs
package.json @cockroachdb/docs-infra-prs
search.html @cockroachdb/docs-infra-prs
sitemap.xml @cockroachdb/docs-infra-prs
update.sh @cockroachdb/docs-infra-prs
/.bundle/ @cockroachlabs/docs-infra-prs
/.github/ @cockroachlabs/docs-infra-prs
/__tests__/ @cockroachlabs/docs-infra-prs
/_layouts/ @cockroachlabs/docs-infra-prs
/_plugins/ @cockroachlabs/docs-infra-prs
/css/ @cockroachlabs/docs-infra-prs
/fonts/ @cockroachlabs/docs-infra-prs
/githooks/ @cockroachlabs/docs-infra-prs
/jekyll-algolia-dev/ @cockroachlabs/docs-infra-prs
/js/ @cockroachlabs/docs-infra-prs
/netlify/ @cockroachlabs/docs-infra-prs
/vale/ @cockroachlabs/docs-infra-prs
_redirects @cockroachlabs/docs-infra-prs
.gitattributes @cockroachlabs/docs-infra-prs
.gitignore @cockroachlabs/docs-infra-prs
.htmltest.yaml @cockroachlabs/docs-infra-prs
.vale.ini @cockroachlabs/docs-infra-prs
Gemfile @cockroachlabs/docs-infra-prs
Makefile @cockroachlabs/docs-infra-prs
package.json @cockroachlabs/docs-infra-prs
search.html @cockroachlabs/docs-infra-prs
sitemap.xml @cockroachlabs/docs-infra-prs
update.sh @cockroachlabs/docs-infra-prs
2 changes: 1 addition & 1 deletion .github/scripts/cross_version_link_linter.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ def format_violations_for_github(self) -> str:
"",
"**Action Required**: Please update all cross-version links to use version variables or ensure links stay within the same version.",
"",
"For more information about proper link formatting, see the [CockroachDB Docs Style Guide](https://github.com/cockroachdb/docs/blob/main/StyleGuide.md#links)."
"For more information about proper link formatting, see the [CockroachDB Docs Style Guide](https://github.com/cockroachlabs/docs/blob/main/StyleGuide.md#links)."
])

return "\n".join(lines)
Expand Down
8 changes: 4 additions & 4 deletions .github/scripts/docs-prs-reviews.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ type prReviewParse struct {
UpdatedAt time.Time
}

const (
docsOrganization = "cockroachdb"
docsRepo = "docs"
docsPrsTeam = "docs-prs"
var (
docsOrganization = maybeEnv("DOCS_ORG", "cockroachlabs")
docsRepo = maybeEnv("DOCS_REPO_NAME", "docs")
docsPrsTeam = maybeEnv("DOCS_PRS_TEAM", "docs-prs")
)

func main() {
Expand Down
6 changes: 3 additions & 3 deletions MarkdownGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -592,7 +592,7 @@ The contents of `shared-file.md` will now appear on all of the pages where you a

#### Different content depending on page name

There may be cases where the content of the include file will need to vary slightly depending on what pages that content is being shared into. For example, while working on [cockroachdb/docs#12216](https://github.com/cockroachdb/docs/pull/12216), I needed a way to:
There may be cases where the content of the include file will need to vary slightly depending on what pages that content is being shared into. For example, while working on [cockroachlabs/docs#12216](https://github.com/cockroachlabs/docs/pull/12216), I needed a way to:

- Have text be a link on the [Known Limitations](https://www.cockroachlabs.com/docs/stable/known-limitations) page.
- Have that same text _not_ be a link on the [Cost-Based Optimizer](https://www.cockroachlabs.com/docs/stable/cost-based-optimizer) page (since it would be a self-referring link).
Expand All @@ -615,7 +615,7 @@ Locality-optimized search

#### Remote includes

Sometimes, you need to include files that are maintained in other places than the `cockroachdb/docs` repo but referenced in our docs. The `remote_include` tag is used for this. We most often use this tag for code samples, which are maintained in various repos.
Sometimes, you need to include files that are maintained in other places than the `cockroachlabs/docs` repo but referenced in our docs. The `remote_include` tag is used for this. We most often use this tag for code samples, which are maintained in various repos.

For code samples, you usually want to show only part of a larger file to highlight a specific technique, or due to length considerations.

Expand All @@ -639,7 +639,7 @@ For more information about the `remote_include` tag, see the README in the [jeky

### Filter tabs

Use filter tabs to create navigation between related pages. The [`filter-tabs.md`](https://github.com/cockroachdb/docs/blob/main/src/current/_includes/filter-tabs.md) include generates tabs that link to different pages.
Use filter tabs to create navigation between related pages. The [`filter-tabs.md`](https://github.com/cockroachlabs/docs/blob/main/src/current/_includes/filter-tabs.md) include generates tabs that link to different pages.

**Note:** Filter tabs link to different URLs/pages, not tabs within a single page.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This repository contains the source files for the CockroachDB documentation avai

## Suggest Improvements

Want a topic added to the docs? Need additional details or clarification? See an error or other problem? Please [open an issue](https://github.com/cockroachdb/docs/issues).
Want a topic added to the docs? Need additional details or clarification? See an error or other problem? Please [open an issue](https://github.com/cockroachlabs/docs/issues).

## Resources

Expand Down
12 changes: 6 additions & 6 deletions StyleGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ Avoid terms that imply violence or harm.
- Replace "performance _hit_" with **reduced performance**.
- Replace "want to _hit_ up" with **want to visit**.

Terminology around "kill" vs. "stop" vs. "terminate" is nuanced, as described [in this GitHub comment](https://github.com/cockroachdb/docs/issues/7767#issuecomment-662028864). Use your best judgement.
Terminology around "kill" vs. "stop" vs. "terminate" is nuanced, as described [in this GitHub comment](https://github.com/cockroachlabs/docs/issues/7767#issuecomment-662028864). Use your best judgement.

### Write accessible documentation

Expand Down Expand Up @@ -372,7 +372,7 @@ A _concept_ topic explains how a particular feature works, or how a specific sys

- Provide as much relevant information as you can, and then link to other pages as necessary. If there is a related [reference](#reference) topic, link to it from within the conceptual topic.

For templates that provide a starting point for writing concept topics, refer to the [concept templates](https://github.com/cockroachdb/docs/tree/main/templates/concept).
For templates that provide a starting point for writing concept topics, refer to the [concept templates](https://github.com/cockroachlabs/docs/tree/main/templates/concept).

#### Examples

Expand Down Expand Up @@ -403,7 +403,7 @@ A _task_ topic provides step-by-step instructions to complete a specific goal. T

Tasks should **not** include concept or reference information; instead, a task should link to [Concept](#concept) and [Reference](#reference) topics as needed.

For templates that provide a starting point for writing task topics, refer to the [task templates](https://github.com/cockroachdb/docs/tree/main/templates/task).
For templates that provide a starting point for writing task topics, refer to the [task templates](https://github.com/cockroachlabs/docs/tree/main/templates/task).

#### Examples

Expand All @@ -422,7 +422,7 @@ Reference topics help users understand the precise meaning and effect of Cockroa
- The content should be comprehensive and accurate. This principle might apply to other page types, but it is especially important for reference, as it is the ultimate source of truth for a particular feature or interface.
- The content should be succinct. Details are often presented in table format. Prose is better suited for [Concept](#concept) topics.

For templates that provide a starting point for writing reference topics, refer to the [reference templates](https://github.com/cockroachdb/docs/tree/main/templates/reference).
For templates that provide a starting point for writing reference topics, refer to the [reference templates](https://github.com/cockroachlabs/docs/tree/main/templates/reference).

#### Examples

Expand All @@ -436,7 +436,7 @@ _Guides_ offer the reader a perspective on how to decide between a number of dif

To accomplish this goal, guides often link to several different [Concept](#concept) topics and compare and contrast them. They can also link to multiple [Task](#task) topics.

For templates that provide a starting point for writing guide topics, refer to the [guide templates](https://github.com/cockroachdb/docs/tree/main/templates/guide).
For templates that provide a starting point for writing guide topics, refer to the [guide templates](https://github.com/cockroachlabs/docs/tree/main/templates/guide).

#### Examples

Expand Down Expand Up @@ -564,7 +564,7 @@ For include file syntax, refer to the [Markdown Guide](MarkdownGuide.md#include-

Reference issues and pull requests by their corresponding number, prepended with `#`.

**Example:** `[#1](https://github.com/cockroachdb/docs/pull/1)`
**Example:** `[#1](https://github.com/cockroachlabs/docs/pull/1)`

#### External links

Expand Down
2 changes: 1 addition & 1 deletion src/api/_includes/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"author": {
"@type": "Organization",
"name": "Cockroach Labs Documentation Team",
"url": "https://github.com/cockroachdb/docs"
"url": "https://github.com/cockroachlabs/docs"
}
}
</script>
Expand Down
2 changes: 1 addition & 1 deletion src/current/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ FROM ruby:3.4-slim
# Version labels
LABEL org.opencontainers.image.title="CockroachDB Docs Builder"
LABEL org.opencontainers.image.description="Hermetic build environment for CockroachDB documentation"
LABEL org.opencontainers.image.source="https://github.com/cockroachdb/docs"
LABEL org.opencontainers.image.source="https://github.com/cockroachlabs/docs"
LABEL ruby.version="3.4.0"
LABEL bundler.version="2.7.2"
LABEL jekyll.version="4.3.4"
Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"author": {
"@type": "Organization",
"name": "Cockroach Labs Documentation Team",
"url": "https://github.com/cockroachdb/docs"
"url": "https://github.com/cockroachlabs/docs"
}
}
</script>
Expand Down
2 changes: 1 addition & 1 deletion src/interactive-tutorials/_includes/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"author": {
"@type": "Organization",
"name": "Cockroach Labs Documentation Team",
"url": "https://github.com/cockroachdb/docs"
"url": "https://github.com/cockroachlabs/docs"
}
}
</script>
Expand Down
2 changes: 1 addition & 1 deletion vale/CockroachDB/Contractions.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: substitution
message: Use '%s' instead of '%s'
link: https://github.com/cockroachdb/docs/blob/main/StyleGuide.md#style-and-tone
link: https://github.com/cockroachlabs/docs/blob/main/StyleGuide.md#style-and-tone
ignorecase: false
level: warning
swap:
2 changes: 1 addition & 1 deletion vale/CockroachDB/HeadingsCase.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: capitalization
message: "'%s' should be in sentence case"
link: https://github.com/cockroachdb/docs/blob/main/StyleGuide.md#capitalization-and-punctuation
link: https://github.com/cockroachlabs/docs/blob/main/StyleGuide.md#capitalization-and-punctuation
level: warning
scope: heading
match: $sentence
2 changes: 1 addition & 1 deletion vale/CockroachDB/HeadingsPunctuation.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: Do not use '%s' at the end of headings
link: https://github.com/cockroachdb/docs/blob/main/StyleGuide.md#capitalization-and-punctuation
link: https://github.com/cockroachlabs/docs/blob/main/StyleGuide.md#capitalization-and-punctuation
scope: heading
level: warning
raw:
Expand Down
2 changes: 1 addition & 1 deletion vale/CockroachDB/Hyperbolic.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: Consider removing '%s'
link: https://github.com/cockroachdb/docs/blob/main/StyleGuide.md#style-and-tone
link: https://github.com/cockroachlabs/docs/blob/main/StyleGuide.md#style-and-tone
ignorecase: true
level: warning
tokens:
Expand Down
2 changes: 1 addition & 1 deletion vale/CockroachDB/LocalizedLinks.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Link contains a localization element (e.g., `en`, `en-us`). Some websites will auto-localize. Try to remove it from the URL if it doesn't 404: '%s'..."
link: https://github.com/cockroachdb/docs/blob/main/StyleGuide.md#links
link: https://github.com/cockroachlabs/docs/blob/main/StyleGuide.md#links
scope: raw
level: warning
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion vale/CockroachDB/NondescriptLinkTitles.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: Avoid using non-descriptive link titles.
link: https://github.com/cockroachdb/docs/blob/main/StyleGuide.md#lists
link: https://github.com/cockroachlabs/docs/blob/main/StyleGuide.md#lists
level: warning
scope: raw
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion vale/CockroachDB/OrderedLists.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: Use "1." instead of "%s" for ordered lists.
link: https://github.com/cockroachdb/docs/blob/main/StyleGuide.md#lists
link: https://github.com/cockroachlabs/docs/blob/main/StyleGuide.md#lists
level: warning
scope: raw
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion vale/CockroachDB/OxfordComma.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: Use the Oxford comma in a list of three or more items
link: https://github.com/cockroachdb/docs/blob/main/StyleGuide.md#capitalization-and-punctuation
link: https://github.com/cockroachlabs/docs/blob/main/StyleGuide.md#capitalization-and-punctuation
level: suggestion
tokens:
- '(?:[^,]+,){1,}\s\w+\sand'
Loading