Open mradamcox opened 5 years ago
@mradamcox Thanks for your comments!
We will work to factor in your proofreading edits.
RE: reorganizing the modules - unfortunately, I doubt that's feasible this time around as students have already been told that day one will be the optional "pre-course" stuff. Also, that would force students who don't need the pre-course material to attend those portions.
FYI, A lot of the content suggestions that you've made here are things that will be discussed in the class, but perhaps not captured in the slides. These are good notes, regardless.
Thanks again for the review!
@robgaston That makes sense about the module order, thanks for the extra background.
Overall Comments
We have a lot of information in the official Arches documentation regarding many of the topics and content covered here, but these slides make no reference to it. I think an effort to link to existing documentation where possible should be undertaken. CLI command reference, etc.
Generally, I think the course flows well overall, and I really like the in-depth examples and lab contents. However, after working through it, I think that consideration should be given to the following restructure (modules would be renamed of course):
A couple reasons for this suggestion
I think it would be good to clearly describe the end state of the project at the end of each module. What should be registered? What should be working correctly? etc.
Module-specific Comments
Note that all bold numbers correspond to the urls generated by the service on github pages. These are based on the state of the repo at commit 51ce70a77a215d7fc294af6dede1a3114b27d18b (Oct. 12).
Pre-course A: Deployment Considerations
General Comments
Proofreading
Pre-course B: KnockoutJS
General Comments
Consider putting documentation and tutorial links fully typed as well, e.g.
Docs found here: https://docs.example.com
instead of
Docs found here
in case this text ends up in a non-hyperlink format (copy/paste, etc.)
26 consider changing first line to "Composed of a template (HTML file) and view model (JS files)" or something like that.
Proofreading
Pre-course C: Django
General Comments
Proofreading
Module 1: The Arches Platform
General Comments
63 This slide is super important. I think a recommended installation directory structure would be helpful, something like
Also I recommend adding
cd arches-dev-training-project
to make it clear from which directory these commands must be run.Also, you should mention settings_local.py here, as this must be configured before running. Windows users need to set GDAL path, anyone using external pg or es will need to configure that stuff. for what it's worth, I can make an ES instance open to anyone who wants to use it.
I don't think it's wise to ever have settings_local.py in version control. At any rate, it's an a-typical and not really a good precedent to set. An alternative would be to put a settings_local.py file elsewhere for download, like the one I have provided here: http://ftp.legiongis.com/swindon_materials/settings_local.py.
Proofreading
Module 2: Introduction to Datatypes
General Comments
Module 3: Building a Custom Datatype
General Comments
77 I think it would be helpful to have people run
before and after running the command to register the function.
Module 4: Introduction to Components
General Comments
Proofreading
$(env)
, or perhaps adding this to all other command examples. Without $(env) is nice because you can more easily copy and paste, with it is the clear indication that a virtual env is in use. Personally I think without is better.Module 5: Widget Development
(no notes)
Module 6: Card Component Development
General Comments
Module 7: Report Template Development
(no notes)
Module 8: Projects and Packages
General Comments
Module 9: Arches Geospatial
General Comments
Proofreading
Module 10: Creating a Package
(no notes)