search

OWASP / www-committee-project

OWASP Foundation Web Respository
http://owasp.org/www-committee-project/
5 stars 8 forks source link

Handbook 2014 converted using online pdf to markdown #33

Open DonnieBLT opened 1 year ago

DonnieBLT commented 1 year ago

This gives us a starting point to make changes so we will have a history of updates. Maybe redirect https://owasp.org/www-project-handbook/ as well

hblankenship commented 1 year ago

Please see https://owasp.org/www-committee-project/handbook/ for an updated draft. If you agree, we can close this (the 2014 version had a good deal of wrong information).

DonnieBLT commented 1 year ago

I feel having it be one page is more future proof and easier to keep track of changes:

--

If a document has been a single page since 2014 and was recently converted into multiple pages, there are a few factors to consider when deciding whether to keep it as a single page or maintain the multi-page format:

Historical context: If maintaining the history of the document is important, you can consider using a single page format with version control (e.g., using git) to track changes over time. This allows you to see updates more easily while preserving the document's history.

User experience: If the conversion to multiple pages was done to improve navigation and readability, it might be beneficial to keep the new format. It's essential to prioritize the needs of your users and how they interact with the document.

Maintenance and updates: If the document has grown in size and complexity, multiple pages might be more manageable for updating and maintenance. Splitting the content into separate pages can make it easier to modify specific sections without affecting the entire document.

To see updates more easily while maintaining the multi-page format, you can leverage version control systems like git. This way, you can track changes across multiple pages and maintain a clear history of the document's evolution. Additionally, you can provide a changelog or an update log to inform users about the changes made to the document over time.

Ultimately, the decision to keep the document as a single page or multiple pages should be based on the content's nature, user experience, and maintenance requirements.

hblankenship commented 1 year ago

I maintain still that this PR can be closed as we do not need the 2014 document in any format other than PDF and it contains content that is not materially important any longer.

DonnieBLT commented 1 year ago

Sounds good to me. I would be interested in a changelog sort of document to know what changed in that case. Maybe having a way to join the files into one somehow with a script may be useful to some.