-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Search] Update notebooks & search_notebooks readme (#180630)
- Loading branch information
1 parent
0a24e23
commit 9195b22
Showing
3 changed files
with
14 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,15 @@ | ||
# Search Notebooks plugin | ||
|
||
This plugin contains endpoints and components for rendering search python notebooks in the persistent dev console. | ||
|
||
### Cached Notebooks | ||
|
||
There is a limited set of search notebooks that we cache in `/server/data` directory to be served from this plugin. These should be available in all environments. | ||
|
||
To update the cached notebooks, run the following command: | ||
|
||
```shell | ||
./scripts/download-notebooks.sh | ||
``` | ||
|
||
This script reads the `scripts/notebooks.txt` file and downloads each notebook from the url in the file and then saves it in the `server/data` directory with a snake_case filename and `.json` extension. The `.json` extension is just to make loading the files with node.js easier using an `async require()` instead of writing custom loading code with `fs` and implementing in-memory caching with the same loading code. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters