Article Template

[patrickceg]

Is your feature request related to a problem? Please describe.

This task arose out of issues and #65 #10, specifically this comment #10 (comment)

There have been a lot of discussions regarding changes to where images are stored, how links should be handled, and file names. As the discussion, we should have a template to be able to:

1. Visualize all the proposals in a more concrete manner
2. Make it easier to either create new articles or fix old ones

Describe the solution you'd like

The acceptance criteria of this task is to have template files that show:

1. A file providing a template for the a test case (example: for Section 4), ready to use such that if someone was writing a new article (like the infrastructure as code for issue Add a section on testing of Infrastructure as Code (IaC)  #15), they can copy-paste that template and modify simply by adding content and replacing the fake text with real text.
2. An images folder, with an image in it. We mentioned we want a convention for images, so the template should also demonstrate that convention.

Optional:

• I propose the templates be in their own folder, similar to the OWASP's MTSG project. https://github.com/OWASP/owasp-mstg/tree/master/Templates
• If the template itself will look confusing if we put explanations, we could put another file justifying our reasoning for each element in the template. (For example, staying away from spaces to avoid having to URL encode hyperlinks.)
• The other option is to have lots of explanations built into the template itself, but we have to be sure that people don't accidentally copy-paste the template explanations into their real articles. The example I can think of for a "template" like that is the configuration file for a big system like Apache Cassandra - https://github.com/cassandra-rb/cassandra/blob/master/conf/1.2/cassandra.yaml - where there's lots and lots of comments for each line of parsed content. I'm just putting this out as an option, but I greatly prefer having a very small template with the MINIMAL content. When you have large templates, people think that the article itself also has to be large, and for some emerging or very focused fields of web app testing, that probably isn't the case.

[patrickceg]

I'm getting ready to promote my draft to a full pull request, using this "comment" to gather notes

• From Section 2 - introduction references section seems to not render (Firefox) #167 (comment) it seems like we want to promote inline link if appropriate, and other references or reading material that did not get linked in-line go in the references section
• Of course the template needs to follow the front page's guidelines for capitalization and whatnot https://github.com/OWASP/OWASP-Testing-Guide-v5#style-guidelines