Make formatting and readability changes

enisaeu / Reference-Security-Incident-Taxonomy-Task-Force

This repository hosts files relating to the TF-CSIRT Reference Security Incident Taxonomy Working Group.

Creative Commons Zero v1.0 Universal

64 stars 33 forks source link

Make formatting and readability changes #86

Closed gabrielcurrie closed 3 years ago

gabrielcurrie commented 3 years ago

This pull request contains primarily formatting changes in order to enhance the usability and readability of the RSIT repository. This includes:

Merge CONTRIBUTING.md and ACKNOWLEDGEMENTS.md into README.md to consolidate information and prevent duplication.
Update README.md to add ENISA logo to top, add headings throughout to improve structure, resolve spelling and grammar issues, reword to improve readability, and update links.
Update Use Cases.md to adjust headings to improve structure and resolve grammar issues.
Update LICENCE to add word-wrap to licence text and add numbering as per official licence text available here.
Prefix file names of meeting minutes with meeting dates, so they are automatically ordered by date.
Update machinev1 to standardise case in "expanded" fields to be title case (as the majority of these entries currently are), and resolve spelling and grammar issues in description fields.

ghost commented 3 years ago

Dear Gabriel, many thanks for your work! I appreciate all the changes and think that the changes in the taxonomy itself won't require voting and a new version as your changes are only in the human-readable values (expanded and description), not the unique identifiers.

gabrielcurrie commented 3 years ago

Thanks @wagner-certat - glad I could be of help. As you say, I've tried to keep changes relatively uncontroversial and not change the underlying taxonomy.

adulau commented 3 years ago

It looks good me. @amicaross what's the next step to allow the merge of the changes?

amicaross commented 3 years ago

we need to discuss the changes in the next meeting as part of the 62nd TF-CSIRT Virtual Meeting that will take place on Tuesday 26th January 2021 from 10:00 to 12:00 CET.

amicaross commented 3 years ago

Approved everything but the logo

gabrielcurrie commented 3 years ago

Hi @amicaross just to confirm, do you want me to remove the logo from the current pull request entirely?

amicaross commented 3 years ago

Hi @amicaross just to confirm, do you want me to remove the logo from the current pull request entirely?

yes, please.

adulau commented 3 years ago

When this will be merged, we can then generate the website for GitHub automatically. This could improve the RSIT visibility.

gabrielcurrie commented 3 years ago

Hi @amicaross just to confirm, do you want me to remove the logo from the current pull request entirely?

yes, please.

Hi @amicaross I have updated the pull request as requested. Please can you merge?