Skip to content

Commit 5fe9ba7

Browse files
committed
Update push documentation.
1 parent 3a07d14 commit 5fe9ba7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

notebooks/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,14 @@ If you create further config files (e.g. `testing.yaml`), they will generate the
4343
`prepare_push.py` translates notebooks in `raw/` to publishable notebooks in `rendered/`.
4444
The logic for this step mostly lives in `lesson_preprocessor.py`. Most of its work is in expanding macros which look like `#$HIDE_OUTPUT$`, or `#$EXERCISE_URL(2)$`. See MACROS.txt for a listing of available macros.
4545

46+
`prepare_push.py` requires a few libraries that may need to be installed before continuing.
47+
4648
The Kaggle Kernels API requires a `kernel-metadata.json` file for any kernel being pushed to the site. `prepare_push.py` also generates these in the `kernels_api_metadata` subdirectory.
4749

4850
## Step 2: Pushing
4951

52+
The push process uses the Kaggle Kernels API, so it requires a valid API key with write permissions to the learn notebooks to update.
53+
5054
Use ./pushall.sh as
5155
./pushall deep_learning/prod
5256

0 commit comments

Comments
 (0)