-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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.
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
Proposes a new layout for the guide contents #254
Conversation
TODO: - [ ] Assign section numbers - [ ] Link-ify section names once reorganizing is complete
I think this should be in draft mode? 😄 |
Updated list per @rejahrehim's review |
So you're proposing to drop both section numbers and identifiers? |
@kingthorin No; I’ve only left them out until we agree on the ordering. Please see more details in #253. |
Thanks 🙂 That makes more sense. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My only concern is the IG content, otherwise this looks good I think.
Once we’ve come to an agreement, I can address the layout. This file doesn’t actually need to be merged. |
If people would rather it was more aligned to process flow or basic > advanced then we could do something like:
|
@kingthorin That keeps the progression and is still an improvement organizationally. I’m down. @ThunderSon does this address your above comment? |
In version 4 we put the paragraphs in order of testing. I mean for example after testing the authentication you will test the Authorization than Session Management and so on. I'd prefer that the paragraphs will be shown following the methodology of testing. What do you think? |
@MatOwasp Do you mean the order shown in the v4 description of Phase 2? (Page 28) If so, and we take that ordering as a source of truth when it comes to progression, how would we go about deciding where new types of tests should be slotted in? Also, if it is the purpose of the WSTG to recommend that ordering as a progression, I think that would be better communicated if it were made explicit. For example, using a numbered list and calling each category a “step” instead. Currently, it reads more like many options for types of testing that the user may implement as needed. |
What @MatOwasp said is true, yet not a fact. Testing can be done pretty much based on the user's needs. If I am looking for high ROI from my tests, I'll pick the most crucial tests to start with. In terms of testing, I believe that the ordering doesn't matter that much, more so than the document and the engagement (discussion, info gathering, etc.). The benefits to the new proposal is this: Ordering in Alphabetical order makes it a bit easier to maintain and to map things better in the repository. We currently use the IDs in a way that allows to do this: This begs the question as well: Why is testing cryptography almost at the end, and not after configuration? The order can definitely be questioned based on knowledge and requirements. |
This last commit incorporates the suggestions so far, presenting the Introduction and Information Gathering sections as a progressive flow, then the Testing section, in which the tests are ordered alphabetically. The test IDs still need to be updated (and added). |
Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's take it in. I will be reconsidering this and see its pros and cons to later see if this structure will be taken as such, and how different it would feel. Thanks V!
A small new proposition. Layer 4 for the special cases, and removed 1.2 after we took it out. |
Agreed, closing. See #253 for further discussion. |
Refers to #253 (see issue for full discussion)