|
1 | 1 | # PAWS |
2 | 2 |
|
3 | | -PAWS: A Web Shell (PAWS) is a Jupyter notebooks deployment that has been customized to make interacting with Wikimedia wikis easier. It allows users to create and share documents that contain live code, visualizations such as graphs, rich text, etc. The user created notebooks are a powerful tool that enables data analysis and scientific research, and also transforms the way in which programmers write code - by enabling an exploratory environment with a quick feedback loop, and a low barrier for entry through it's easy to use graphical interface. |
| 3 | +PAWS: A Web Shell (PAWS) is a Jupyter notebooks deployment that has been customized to make interacting with Wikimedia wikis easier. It allows users to create and share documents that contain live code, visualizations such as graphs, rich text, etc. The user created notebooks are a powerful tool that enables data analysis and scientific research, and also transforms the way in which programmers write code - by enabling an exploratory environment with a quick feedback loop, and a low barrier for entry through it's easy to use graphical interface. |
4 | 4 |
|
5 | 5 | ## Contributing |
6 | 6 |
|
@@ -33,15 +33,26 @@ install the dependencies for the PAWS dev environment with these steps: |
33 | 33 | The rest of the setup instructions will display on screen as long as the install is successful. |
34 | 34 | Please refer to the helm documentation from there. |
35 | 35 |
|
| 36 | +If you are experiencing issues with the installation, you can try changing the driver configuration in minikube: https://minikube.sigs.k8s.io/docs/drivers/ |
| 37 | + |
| 38 | +- First delete the current cluster: |
| 39 | + |
| 40 | + `minikube delete` |
| 41 | + |
| 42 | +- Start a new cluster with the driver you want to use (e.g. docker, virtualbox, hyperkit, etc.): |
| 43 | + |
| 44 | + `minikube start --driver=docker --kubernetes-version=v1.20.11` |
| 45 | + |
| 46 | +Another possible solution if minikube is acting weird might be to upgrade minikube, or even to |
| 47 | +increase the default memory: |
| 48 | + |
| 49 | +`minikube config set memory 4096` |
| 50 | + |
36 | 51 | NOTE: By default the mariadb chart keeps a PersistentVolumeClaim around for its storage even after |
37 | 52 | uninstall. If you intend on rebuilding your dev environment later, you will need to use all the same |
38 | 53 | values for DB and DB passwords if you don't delete that claim and volume (and the data from your |
39 | 54 | last wiki will be in there--which means you keep your oauth grant!). The PVC for mediawiki gets cleaned up on uninstall. |
40 | 55 |
|
41 | | -If minikube is acting weird, it might be worth it to upgrade minikube or even to |
42 | | - increase the default memory: |
43 | | -`minikube config set memory 4096` |
44 | | - |
45 | 56 | #### Working with images |
46 | 57 | There are 8 images that are part of PAWS, in particular in the images/ directory. If you start a dev environment, it will pull those images from quay.io by default, just like in Wikimedia Cloud Services. If you are making changes to the images and testing those locally, you'll need to build them and tag them for your local environment, possibly setting them in your local values file with the tags you set. |
47 | 58 |
|
@@ -76,7 +87,7 @@ A notebook can be turned into a public notebook by publishing a link to it. This |
76 | 87 |
|
77 | 88 | If you want to run the copy yourself, or do interactive changes, you must download the notebook and reupload on your own account. Downloading the raw format of the previous example can be done by adding format=raw to the previous example …revisions-sql.ipynb?format=raw. This download-reupload-process is somewhat awkward. |
78 | 89 |
|
79 | | -Note that a notebook will always be published, as the link can be guessed, so don't add any private information. |
| 90 | +Note that a notebook will always be published, as the link can be guessed, so don't add any private information. |
80 | 91 |
|
81 | 92 | ### To know more about paws have a look at: |
82 | 93 | https://wikitech.wikimedia.org/wiki/PAWS |
0 commit comments