Skip to content

Implement Algolia DocSearch #1055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 55 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
1154fc6
checkin
johndmulhausen Jan 31, 2025
631bf39
Re-import styles
johndmulhausen Jan 31, 2025
12e2511
Update hugo.yaml
johndmulhausen Jan 31, 2025
b941911
Add DocSearch-specific meta tag
johndmulhausen Feb 1, 2025
c1615e9
Inject title into meta
johndmulhausen Feb 5, 2025
968b82c
Force lvl0
johndmulhausen Feb 5, 2025
b047bff
Rearrange lvl0 injection location
johndmulhausen Feb 5, 2025
7c2fca0
Move lvl0 to inner
johndmulhausen Feb 5, 2025
7ccf7b9
checkin
johndmulhausen Feb 19, 2025
a79b8bb
Update ref-arch.md (#1022)
mkaesz-wandb Jan 30, 2025
a236822
Update some details in the airgapped Operator install (#1032)
venky-wandb Jan 31, 2025
f645426
Reference sensitive data from secrets and config maps (#1024)
mkaesz-wandb Jan 31, 2025
dc1967d
Update operator-airgapped.md (#1028)
venky-wandb Jan 31, 2025
e9a841b
Update the install via Helm CLI section to include an example values.…
venky-wandb Jan 31, 2025
f52f48b
Add info on WANDB_SWEEP_ID (#1052)
J2-D2-3PO Jan 31, 2025
4835291
Try to fix Lychee github action error (#1034)
mdlinville Jan 31, 2025
dbe409b
Add details of bucket-vs-database-stored data (#1051)
johndmulhausen Feb 1, 2025
0e3a6fb
DOCS-641: wandb.Audio docstrings and/or show example in docs (#1050)
J2-D2-3PO Feb 1, 2025
4d72adf
Simplify pull_request_template.md (#1049)
mdlinville Feb 1, 2025
9ddadb3
Update and rename .github/workflows/dependabot.yml to .github/dependa…
johndmulhausen Feb 1, 2025
40c8a89
Bump actions/checkout from 2 to 4 (#1058)
dependabot[bot] Feb 1, 2025
c7cb3d9
Bump actions/setup-python from 4 to 5 (#1059)
dependabot[bot] Feb 1, 2025
cb449b8
[DOCS-466] Standardize docs about creating API keys and signing in (#…
mdlinville Feb 3, 2025
1b8615e
Update linkcheck.yml (#1063)
mdlinville Feb 4, 2025
0ff7d34
Update cron entry in linkchecker action to test it out (#1064)
mdlinville Feb 4, 2025
166ba04
Update Lychee args (#1066)
mdlinville Feb 4, 2025
e84e41b
Update the link check time again (#1067)
mdlinville Feb 4, 2025
446e112
Fix the cron syntax (#1068)
mdlinville Feb 4, 2025
839d87d
Fix wandb101 link (#1071)
mdlinville Feb 4, 2025
602cd3b
Update linkcheck.yml cron again (#1072)
mdlinville Feb 4, 2025
5944adc
Put lychee args back on a single line (#1073)
mdlinville Feb 4, 2025
fdde2ba
Remove stray newline (#1074)
mdlinville Feb 4, 2025
7250584
Put back inputs to Lychee command (#1076)
mdlinville Feb 4, 2025
0010b6e
Reports: Add section on freezing a run state (#1062)
ngrayluna Feb 5, 2025
2e1d993
[DOCS-1241] Fix typo in OIDC_CLIENT_SECRET env variable (#1078)
mdlinville Feb 5, 2025
236eee9
[DOCS-1214] Document 'ignore outliers' behavior for full fidelity plo…
mdlinville Feb 5, 2025
e6ca537
[DOCS-1158] Add details about customizing the view of the Runs and Wo…
mdlinville Feb 5, 2025
4671bc7
[DOCS-633] Document Billing Settings page (#1056)
mdlinville Feb 6, 2025
6a6fa46
fix: description for .init() dir argument (#1008)
ijdoc Feb 6, 2025
090ae83
Remove detritus from code block (#1085)
johndmulhausen Feb 6, 2025
4eb9230
Prism "copy" button fix (#1069)
johndmulhausen Feb 6, 2025
d4bf4e1
Fix a typo (#1082)
travis-the-dragon Feb 6, 2025
06ac219
Update schedule for link checker action (#1086)
mdlinville Feb 6, 2025
b658344
Fix broken links (#1088)
mdlinville Feb 7, 2025
165ec8f
Experiments: Reproduce experiments (#1057)
ngrayluna Feb 11, 2025
11af87b
Registry team access bulk (#1047)
ngrayluna Feb 11, 2025
0a7ee91
Revert "Registry team access bulk" (#1093)
ngrayluna Feb 11, 2025
0b288dc
Duplicate: Updated registry team access bulk (#1094)
ngrayluna Feb 11, 2025
de3ce32
Fix audit log example API endpoint url (#1089)
azureology Feb 12, 2025
647cd43
Registry cards (#999)
ngrayluna Feb 13, 2025
41a3575
Fix the table format in watch.md (#1090)
A-mess Feb 13, 2025
cd1d744
Add basic authn to audit log API (#1096)
jennwandb Feb 13, 2025
333423d
Added 15 new Q&A pairs to the Support knowledgebase section (#1081)
luisbergua Feb 18, 2025
8a20e74
Add SDK system metrics questions to Support section (#1102)
luisbergua Feb 19, 2025
945ed83
New ref arch image (#1103)
mkaesz-wandb Feb 19, 2025
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
12 changes: 6 additions & 6 deletions hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,11 @@ services:
id: GTM-5BL5RTH

params:
#search:
# algolia:
# appId: 2D210VB5MP
# apiKey: 730cfa02025b8ba2e95d4c33b1e38cc7
# indexName: docodile
search:
algolia:
appId: 6HH47A49YJ
Copy link
Contributor

@ngrayluna ngrayluna Jan 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we be hiding our API keys? E.g. in a .env or .gitignore? (apiKey)

Copy link
Contributor Author

@johndmulhausen johndmulhausen Jan 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We never did before; I think it's fine, that's the pattern you use for things like GTM as well, and this is the documented way Docsy says to specify your appId

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our repo was private before ;)

apiKey: bf3fd9fa3347add30277074786bd05e2
indexName: wandb
taxonomy:
# set taxonomyCloud = [] to hide taxonomy clouds
taxonomyCloud: []
Expand Down Expand Up @@ -140,7 +140,7 @@ params:
github_branch: main

# Google Custom Search Engine ID. Remove or comment out to disable search.
gcs_engine_id: 674c0c3807d874d09
# gcs_engine_id: 674c0c3807d874d09

# Enable Lunr.js offline search
offlineSearch: false
Expand Down
12 changes: 12 additions & 0 deletions layouts/partials/algolia/head.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- Algolia DocSearch Template -->
<div class="algolia-docsearch-suggestion--title">
{{ "{{" }}#lvl0{{ "}}" }}{{ "{{" }}lvl0{{ "}}" }}{{ "{{" }}/lvl0{{ "}}" }}
{{ "{{" }}#lvl1{{ "}}" }} > {{ "{{" }}lvl1{{ "}}" }}{{ "{{" }}/lvl1{{ "}}" }}
{{ "{{" }}#lvl2{{ "}}" }} > {{ "{{" }}lvl2{{ "}}" }}{{ "{{" }}/lvl2{{ "}}" }}
{{ "{{" }}#lvl3{{ "}}" }} > {{ "{{" }}lvl3{{ "}}" }}{{ "{{" }}/lvl3{{ "}}" }}
{{ "{{" }}#lvl4{{ "}}" }} > {{ "{{" }}lvl4{{ "}}" }}{{ "{{" }}/lvl4{{ "}}" }}
{{ "{{" }}#lvl5{{ "}}" }} > {{ "{{" }}lvl5{{ "}}" }}{{ "{{" }}/lvl5{{ "}}" }}
</div>
<div class="algolia-docsearch-suggestion--content">
{{ "{{" }}#_highlightResult.content{{ "}}" }}{{ "{{" }}{{ "{{" }}{{ "{{" }}value{{ "}}" }}{{ "}}" }}{{ "{{" }}/_highlightResult.content{{ "}}" }}
</div>