Implement Algolia DocSearch

.github/workflows/dependabot.yml → .github/dependabot.yml

@@ -4,4 +4,4 @@ updates:
     directory: "/"
     schedule:
       # Check for updates to GitHub Actions every weekday
-      interval: "daily"
+      interval: "daily"

.github/pull_request_template.md

@@ -1,12 +1,6 @@
-{Short description}
-
-{More details, or remove this line}
+{Description of the change}
 
 -- Remove this line and following from the merge commit message --
 
 {JIRA / GitHub issue, or remove this line}
 {Upstream code PR, or remove this line}
-
-Confirm that tests pass and this change is ready for review:
-- [ ] Local `hugo serve`
-- [ ] Local `vale ./content`

.github/workflows/check_header.yml

@@ -11,10 +11,10 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.10'
 

.github/workflows/linkcheck.yml

@@ -1,37 +1,34 @@
 name: Lychee check
 on:
-  pull_request:
-    paths:
-      - '**.md'
+  repository_dispatch:
+  workflow_dispatch:
+  schedule:
+    - cron: "5 0 1 * *" # In UTC, currently 12:05 AM on the 1st of each month
 
 jobs:
-  lychee:
+  linkChecker:
     runs-on: ubuntu-latest
+    permissions:
+      issues: write # required for peter-evans/create-issue-from-file
     steps:
+      # check URLs with Lychee
       - uses: actions/checkout@v4
 
-      - name: Get changed files
-        id: changed-files
-        uses: tj-actions/changed-files@v45
-        with:
-          files: "**.md"
-
       - name: Link Checker
         id: lychee
-        uses: lycheeverse/lychee-action@v1.10.0
+        uses: lycheeverse/lychee-action@v2
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          args: > 
-          --scheme https --scheme http --verbose --no-cache
-          --user-agent "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
-          --max-concurrency 5 --retry-count 3 --retry-delay 2
-          ${{ steps.changed-files.outputs.all_changed_files }}
+          args: "--base content --accept 200,429,403 --user-agent 'Mozilla/5.0 (Windows NT 10.0; Win64; x64)' --scheme https --scheme http --max-concurrency 5 --max-retries 1 --retry-wait-time 2 --verbose --no-progress './**/*.md' './**/*.html'"
+          fail: false
         env:
+          # to be used in case rate limits are surpassed
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
-      - name: Create PR comment with link reults
-        uses: marocchino/sticky-pull-request-comment@v2
+      - name: Create Issue From File
+        if: steps.lychee.outputs.exit_code != 0
+        uses: peter-evans/create-issue-from-file@v5
         with:
-          header: lychee
-          recreate: true
-          path: ./lychee/out.md
+          title: Link Checker Report
+          content-filepath: ./lychee/out.md
+          labels: report, automated issue

assets/scss/_variables_project.scss

@@ -366,6 +366,14 @@ $breakpoint-xl: 1200px;   // Large desktop
                         }
                     }
                 }
+                .main-nav-search { 
+                    min-width: 300px !important;
+
+                    .DocSearch.DocSearch-Button {
+                        margin: 0 !important;
+                        min-width: 100% !important;
+                    }
+                }
             }
         }
 
@@ -1371,4 +1379,170 @@ body > div.container-fluid.td-default.td-outer > main > section > div > h2 {
 }
 .gcsc-find-more-on-google {
     display: none !important;
+}
+
+// DocSearch Component
+.DocSearch {
+    // Button styles
+    &-Button {
+        font-family: "Source Sans Pro", sans-serif;
+        font-size: 16px;
+        background: transparent !important;
+        border: 1px solid $border-default !important;
+
+        &:active,
+        &:focus,
+        &:hover {
+            background: var(--docsearch-searchbox-focus-background);
+            box-shadow: inset 0 0 0 2px $teal-500 !important;
+            color: var(--docsearch-text-color);
+            outline: none;
+            border-color: $teal-500 !important;
+        }
+
+        // Dark mode styles
+        [data-bs-theme=dark] & {
+            border: 1px solid $dark-border-default !important;
+
+            &:hover, &:focus, &:active {
+                border-color: $teal-500 !important;
+                box-shadow: inset 0 0 0 2px $teal-450 !important;
+            }
+        }
+    }
+
+    // Placeholder text color
+    &-Button-Placeholder {
+        color: $text-secondary !important;
+
+        [data-bs-theme=dark] & {
+            color: $dark-text-secondary !important;
+        }
+    }
+
+    // Search icon color
+    &-Search-Icon {
+        color: $text-secondary !important;
+
+        [data-bs-theme=dark] & {
+            color: $dark-text-secondary !important;
+        }
+    }
+
+    // Modal styles
+    &-Modal {
+        border-radius: $border-radius-large !important;
+    }
+
+    // Hide footer
+    &-Footer {
+        display: none !important;
+    }
+}
+
+// DocSearch Container with CSS Variables
+.DocSearch-Container {
+    font-family: "Source Sans Pro", sans-serif;
+    font-size: 16px;
+
+    // Light mode variables
+    --docsearch-primary-color: #{$teal-500} !important;
+    --docsearch-highlight-color: #{$teal-500} !important;
+    --docsearch-text-color: #{$moon-800} !important;
+    --docsearch-muted-color: #{$moon-500} !important;
+    --docsearch-container-background: rgba(101, 108, 133, 0.8) !important;
+    --docsearch-modal-background: #{$moon-white} !important;
+    --docsearch-searchbox-background: #{$moon-100} !important;
+    --docsearch-searchbox-focus-background: #{$moon-white} !important;
+    --docsearch-hit-color: #{$moon-800} !important;
+    --docsearch-hit-background: #{$moon-white} !important;
+    --docsearch-hit-active-background: #{$teal-500} !important;
+    --docsearch-footer-background: #{$moon-white} !important;
+    --docsearch-logo-color: #{$teal-500} !important;
+    --docsearch-key-gradient: linear-gradient(-26.5deg, #{$moon-200}, #{$moon-100}) !important;
+    --docsearch-key-shadow: inset 0 -2px 0 0 #{$moon-300} !important;
+    --docsearch-searchbox-shadow: inset 0 0 0 2px #{$teal-500} !important;
+
+    .DocSearch-Modal {
+        border-radius: 0 !important;
+        max-width: 800px !important;
+    }
+
+    // Search form styles
+    .DocSearch-Form {
+        border-radius: 30px !important;
+    }
+
+    // Search results styles
+    .DocSearch-Hit {
+        border-radius: $border-radius-medium;
+
+        > a {
+            box-shadow: none !important;
+            border-radius: $border-radius-medium;
+            border: 1px solid $border-default !important;
+
+        }
+    }
+
+    // Dark mode styles
+    [data-bs-theme=dark] & {
+        --docsearch-primary-color: #{$teal-400} !important;
+        --docsearch-highlight-color: #{$teal-400} !important;
+        --docsearch-text-color: #{$moon-200} !important;
+        --docsearch-muted-color: #{$moon-400} !important;
+        --docsearch-container-background: rgba(21, 23, 31, 0.8) !important;
+        --docsearch-modal-background: #{$moon-800} !important;
+        --docsearch-searchbox-background: #{$moon-900} !important;
+        --docsearch-searchbox-focus-background: #{$moon-900} !important;
+        --docsearch-hit-color: #{$moon-200} !important;
+        --docsearch-hit-background: #{$moon-800} !important;
+        --docsearch-hit-active-background: #{$teal-400} !important;
+        --docsearch-footer-background: #{$moon-800} !important;
+        --docsearch-logo-color: #{$teal-400} !important;
+        --docsearch-key-gradient: linear-gradient(-26.5deg, #{$moon-800}, #{$moon-750}) !important;
+        --docsearch-key-shadow: inset 0 -2px 0 0 #{$moon-700} !important;
+        --docsearch-searchbox-shadow: inset 0 0 0 2px #{$teal-400} !important;
+    }
+
+    .DocSearch-Hit-source {
+        color: $text-secondary !important;
+        font-size: 14px !important;
+    }
+
+    .DocSearch-Hit-title {
+        font-size: 1rem !important;
+    }
+
+    // Dark mode styles
+    [data-bs-theme=dark] & {
+
+        .DocSearch-Modal {
+            box-shadow: inset 1px 1px 0 0 hsla(0, 0%, 18%, 0.5), 0 3px 8px 0 $moon-900;
+        }
+
+        .DocSearch-Hit {
+            > a {
+                border: 1px solid $dark-border-default !important;
+            }
+        }
+
+        .DocSearch-Hit-source {
+            color: $dark-text-secondary !important;
+            font-size: 14px !important;
+        }
+
+        .DocSearch-Hit-title {
+            font-size: 1rem !important;
+        }
+    }
+}
+
+@media (min-width: $breakpoint-lg) {
+    .DocSearch {
+
+        .DocSearch-Modal {
+            border-radius: $border-radius-large !important;
+        }
+    }
 }

content/_index.md

@@ -39,7 +39,7 @@ Use [W&B Models]({{< relref "/guides/" >}}) to manage all aspects of building yo
 - [Introduction]({{< relref "/guides/" >}})
 - [Quickstart]({{< relref "/guides/quickstart/" >}})
 - [YouTube Tutorial](https://www.youtube.com/watch?v=tHAFujRhZLA)
-- [Online Course](https://www.wandb.courses/courses/wandb-101)
+- [Online Course](https://wandb.ai/site/courses/101/)
 
 </div>{{% /card %}}
 {{< /cardpane >}}

content/guides/core/reports/edit-a-report.md

@@ -177,6 +177,15 @@ report.save()
 {{% /tab %}}
 {{< /tabpane >}}
 
+
+## Freeze a run set
+
+A report automatically updates run sets to show the latest data from the project. You can preserve the run set in a report by *freezing* that run set. When you freeze a run set, you preserve the state of the run set in a report at a point in time.
+
+To freeze a run set when viewing a report, click the snowflake icon in its panel grid near the **Filter** button.
+
+{{< img src="/images/reports/freeze_runset.png" alt="" >}}
+
 ## Add code blocks
 
 Add code blocks to your report interactively with the App UI or with the W&B SDK.

content/guides/hosting/data-security/secure-storage-connector.md

@@ -15,6 +15,24 @@ Bring your own bucket (BYOB) allows you to store W&B artifacts and other related
 * You can specify a sub-path when configuring a bucket, to ensure that W&B does not store any files in a folder at the root of the bucket. It can help you better conform to your organzation's bucket governance policy.
 {{% /alert %}}
 
+## Data stored in the central database vs buckets
+
+When using BYOB functionality, certain types of data will be stored in the W&B central database, and other types will be stored in your bucket. 
+
+### Database
+
+- Metadata for users, teams, artifacts, experiments, and projects
+- Reports
+- Experiment logs
+- System metrics
+
+## Buckets
+
+- Experiment files and metrics
+- Artifact files
+- Media files
+- Run files
+
 ## Configuration options
 There are two scopes you can configure your storage bucket to: at the *Instance level* or at a *Team level*.