Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Refactor and Tidy Tutorials File Structure #61

Closed
wip-abramson opened this issue Feb 17, 2021 · 1 comment
Closed

Refactor and Tidy Tutorials File Structure #61

wip-abramson opened this issue Feb 17, 2021 · 1 comment
Assignees
@morrieinmaas
Labels
Type: Refactor 🔨 A complete overhaul of a file, feature, or codebase

Comments

@wip-abramson
Copy link
Member

What?

The tutorials are getting larger and the naming isn't always clear. I suggest we refactor as follows:

aries-basic-controller folder becomes 1. Learning Aries, ACA-Py and the Basic Controller
aries-staging-net becomes 2. Public ledger's and Mobile Wallet's

Open to suggestions on exact naming.

Additionally I suggest we consider refactoring the aries-basic-controller tutorial to have a subfolder or possibly multiple subfolders for advanced concepts. Mostly it frustrates me that Part 10 appears after Part 1 when you open the notebook, but I think this is a sensible refactor moving forwards.

Both Alice and Bob could have subfolder's for advanced concepts and also potentially for helper functions such as those described in issues #60 #59 #58.

For now revocation could move under the advanced concepts, and in the future tutorials on Mediation - #41 and mutli wallets could go under here too.

There are also still a few floating notebooks that cover the basic API under a misc folder that I think should be removed.

Why?

The refactor should not take too long, it is a renaming of the folder structure for our tutorials so they are more intuitive for students.
@wip-abramson wip-abramson added the Type: Refactor 🔨 A complete overhaul of a file, feature, or codebase label Feb 17, 2021
@morrieinmaas morrieinmaas self-assigned this Mar 3, 2021
@morrieinmaas
Copy link
Collaborator

Can be extended by adding new tutorials for multitenant and mediation

@morrieinmaas morrieinmaas mentioned this issue Mar 3, 2021
Merged
4 tasks
morrieinmaas added a commit to didx-xyz/aries-cloudcontroller-python that referenced this issue Mar 8, 2021
@morrieinmaas
Restructure tutorial notebooks.
94dc203 
* Created folder structure and numbering according to [issue
61](OpenMined/PyDentity#61)
* Adjusted notebook crossreferences/links accordingly in all notebooks
* Fixed some broken links to respective other notebooks in notebooks

Fixed all links for 1. Learning Aries, ACA-py and the
Basic Controller for

* Alice's Notebooks
* Checked all links manually

Fixed all links for bob in 1 Basic concepts

* All manually checked
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@morrieinmaas morrieinmaas

Labels
Type: Refactor 🔨 A complete overhaul of a file, feature, or codebase
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@morrieinmaas @wip-abramson