elixir-secure-coding icon indicating copy to clipboard operation
elixir-secure-coding copied to clipboard

REST Module

Open hvalkerie19 opened this issue 3 years ago • 2 comments

REST Security Module (issue #11)

hvalkerie19 avatar Feb 01 '23 22:02 hvalkerie19

Section complete and ready for review

hvalkerie19 avatar Feb 10 '23 22:02 hvalkerie19

This is great - really nice work! Here are a few notes of feedback that I think should be incorporated before we move to merge this in.

Larger, more "ethereal" feedback:

  • The content (subjects covered, structure, etc.) is basically perfect, but I think the voice of the writing within this module as it stands may be a bit too formal and could use a once over to make it more casual in tone.
    • I think going over it with that lens may lead to removing some instances of "OWASP says" that's popped up here and there as well as making some parts a bit more concise.
  • None of the content currently refers to / incorporates Elixir: I think there's a great opportunity to outline how the Phoenix framework ties into some of the subsections you created in this document - which subsequently may lead to the creation of some Quiz/Examples.

Small Things:

  • There are a few typos in the form of non-capitalized proper nouns and such
  • Let's slot this in as the new Module 5 in the training, so this will require a few changes:
    1. Update the Module title on line 1
    2. Update the page navigation on the last line of the module so that the previous module is 4-graphql.livemd and just update the 5-elixir.livemd to read 6-elixir.livemd
      • Since we're slotting this into the middle of the ESCT, it will cause a cascading change of filenames and references to the other modules - so let's not worry about updating everything right now, we can fix that in a different PR

houllette avatar Feb 11 '23 00:02 houllette