-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Closed
Labels
Type: Improvement 📈Minor improvements not introducing a new feature or requiring a major refactorMinor improvements not introducing a new feature or requiring a major refactor
Description
Description
Awesome work on quickstart and the first two notebooks.
I think we should finish these up end to end and then once theyre mergable we can plan out the next few.
Notebooks
- Finish DO Create Domain and Upload Flow
- rename files to be 00, 01, use hyphens and lowercase, remove redundant text like Data Owner
- Create breadcrum and link top of Notebook to Install Wizard
- Remove utils import from Upload notebook
- Update README.md with links to published docs
- Update HAGrid to download files and folders based off dev
- Add relative path downloads to quickstart
- Deploy notebook should use port 8081 or 9082 (just conventions we use in other places)
- Add --silent to hagrid launch cell
- Change hagrid check cell to use localhost:8081 (or 9082)
- Change login to use no url but to include port=8081 (or 9082)
- Link Notebooks in Sequence at the bottom of each tutorial
- Move
hagrid quickstartcommand to the top right of RST Docs
HAGrid
$ hagrid quickstart data-owner
# downloads all files in dev branch data-owner
# and launches the 0th notebook
$ hagrid quickstart data-owner/00-deploy-domain
# downloads just that notebook
- Quickstart download overwrite prompt should include (all option) (y/n/a)
- Add repo and branch/tag override to quickstart
$ hagrid quickstart data-owner/00-deploy-domain --repo=madhavajay/PySyft --branch=mybranch
$ hagrid quickstart data-owner/00-deploy-domain --repo=madhavajay/PySyft --commit=c75d98c3543954bfc8d1386205fbba1855f72b95
# downloads from those repo and or commit / branches where the default is `openmined/PySyft` and `dev`
- hagrid disable jupyter extension on install
$ jupyter labextension disable @jupyterlab/cell-toolbar-extension
Linting and Testing
- Make sure the notebooks run
- Keep an eye out for formatting of code in cells
- remove excess spacing on headings
- Use normal font size for main text and custom headings
- Proof read spelling and punctuation
- Check for consistency
abhiwalia15
Metadata
Metadata
Assignees
Labels
Type: Improvement 📈Minor improvements not introducing a new feature or requiring a major refactorMinor improvements not introducing a new feature or requiring a major refactor