Merge pull request #23407 from cockroachdb/stanley/consolidated-migration

Project Stanley: consolidated cockroachdb/docs → cockroachlabs/docs migration

Author: mohini-crl

.github/scripts/cross_version_link_linter.py

@@ -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)

.github/scripts/docs-prs-reviews.go

@@ -82,8 +82,8 @@ type prReviewParse struct {
 	UpdatedAt time.Time
 }
 
-const (
-	docsOrganization = "cockroachdb"
+var (
+	docsOrganization = maybeEnv("DOCS_ORG", "cockroachlabs")
 	docsRepo         = "docs"
 	docsPrsTeam      = "docs-prs"
 )

.github/scripts/validate_branch_existence.py

@@ -3,7 +3,7 @@
 validate_branch_existence.py  (EDUENG-614)
 
 For every row in src/current/_data/versions.csv, verifies that the listed
-crdb_branch_name exists as a branch in cockroachdb/generated-diagrams.
+crdb_branch_name exists as a branch in the generated-diagrams repo.
 
 Also flags entries where versions.csv still points to an older branch even
 though the "natural" release-X.Y branch for that version now exists
@@ -37,7 +37,7 @@
 import urllib.request
 from pathlib import Path
 
-GENERATED_DIAGRAMS_REPO = "cockroachdb/generated-diagrams"
+GENERATED_DIAGRAMS_REPO = os.environ.get("GENERATED_DIAGRAMS_REPO", "cockroachdb/generated-diagrams")
 GITHUB_API_BASE = "https://api.github.com"
 VERSIONS_CSV = Path("src/current/_data/versions.csv")
 DOCS_ROOT = Path("src/current")
@@ -139,7 +139,7 @@ def run_checks(rows: list[dict], _exists_fn=None, _has_docs_fn=None) -> list[dic
                     "branch": branch,
                     "message": (
                         f"{version}: crdb_branch_name={branch!r} does not exist "
-                        f"in cockroachdb/generated-diagrams."
+                        f"in {GENERATED_DIAGRAMS_REPO}."
                     ),
                 })
                 continue
@@ -157,7 +157,7 @@ def run_checks(rows: list[dict], _exists_fn=None, _has_docs_fn=None) -> list[dic
                     "expected": expected,
                     "message": (
                         f"{version}: crdb_branch_name={branch!r} but {expected!r} "
-                        f"now exists in cockroachdb/generated-diagrams. "
+                        f"now exists in {GENERATED_DIAGRAMS_REPO}. "
                         f"Update versions.csv to use {expected!r}."
                     ),
                 })
@@ -174,7 +174,7 @@ def format_comment(failures: list[dict]) -> str:
         return (
             "## Branch Existence Check: Passed\n\n"
             "All `crdb_branch_name` entries in `versions.csv` exist in "
-            "`cockroachdb/generated-diagrams`."
+            f"`{GENERATED_DIAGRAMS_REPO}`."
         )
 
     lines = [
@@ -258,7 +258,7 @@ def main() -> None:
         _run_self_tests()
 
     rows = load_versions_csv()
-    print(f"Checking {len(rows)} versions.csv entries against cockroachdb/generated-diagrams...\n")
+    print(f"Checking {len(rows)} versions.csv entries against {GENERATED_DIAGRAMS_REPO}...\n")
     failures = run_checks(rows)
 
     comment = format_comment(failures)

.github/workflows/changed_files.yml

@@ -16,6 +16,7 @@ jobs:
         id: format
         env:
           GH_TOKEN: ${{ github.token }}
+          NETLIFY_SITE_NAME: ${{ vars.NETLIFY_SITE_NAME || 'cockroachlabs-docs' }}
         run: |
           declare -a output
           pr_num=${{ github.event.pull_request.number }}
@@ -29,7 +30,7 @@ jobs:
 
           function generateMainFiles() {
             html_file=`echo "${1%.md}.html" | sed -E 's/src\/[^\/]*\///g'`
-            file="<li><a href=\"https://deploy-preview-$pr_num--cockroachdb-docs.netlify.app/docs/$html_file\" target=\"_blank\" rel=\"noopener\">$1</a></li>"
+            file="<li><a href=\"https://deploy-preview-$pr_num--${NETLIFY_SITE_NAME}.netlify.app/docs/$html_file\" target=\"_blank\" rel=\"noopener\">$1</a></li>"
             output+="$file"
           }
 
@@ -86,7 +87,7 @@ jobs:
               read -ra path <<< "$file"
               IFS=$OLDIFS
               major_version=${path[-2]}
-              file="<li>${file}:<ul><li><a href=\"https://deploy-preview-$pr_num--cockroachdb-docs.netlify.app/docs/releases/${major_version}.html\" target=\"_blank\" rel=\"noopener\">releases/${major_version}.md</a></li></ul></li>"
+              file="<li>${file}:<ul><li><a href=\"https://deploy-preview-$pr_num--${NETLIFY_SITE_NAME}.netlify.app/docs/releases/${major_version}.html\" target=\"_blank\" rel=\"noopener\">releases/${major_version}.md</a></li></ul></li>"
               output+="$file"
             elif [[ $file == src/*/_includes/v* || $file == src/*/_includes/cockroachcloud* || $file == src/*/images/* ]] && [[ $file != src/**/*.json ]] && [[ $file != *.gitignore* ]]
             then

MarkdownGuide.md

@@ -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).
@@ -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.
 
@@ -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.
 

README.md

@@ -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
 

StyleGuide.md

@@ -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
 
@@ -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
 
@@ -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
 
@@ -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
 
@@ -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
 
@@ -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
 

src/api/_includes/head.html

@@ -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>

src/current/Dockerfile

@@ -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"

src/current/_data/redirects.yml

@@ -31,7 +31,7 @@
 # in the list of versions that matches a major version in
 # versions.csv, Jekyll will automatically add a redirect
 # for the dev and stable aliases for that page. versions.csv:
-# https://github.com/cockroachdb/docs/blob/main/src/current/_data/versions.csv
+# https://github.com/cockroachlabs/docs/blob/main/src/current/_data/versions.csv
 #
 # Each redirect added in redirects.yml generates a redirect
 # for the page without the .md extension and a redirect for