security-force-monitor/research-handbook

Security Force Monitor's Research Handbook - full documentation of SFM data model, methodology and brief overview of what to find in WhoWasInCommand

research-handbook's Issues

Typo in units page

https://github.com/security-force-monitor/research-handbook/blob/master/source/units.rst

Change "neartest" to "nearest".

Remove stub internationalisation?

the ~es locale is active in the version of the Handbook that is pushed to RTD, but is not translated.I set this up to provide a working localisation infrastructure (via Sphinx's own internationalisation feature and Transifex), but this has not been used. If we're not using it for now, there's no loss in removing it to keep the repo uncluttered; easy to restore when we do now we know how to do it. Views?

add .readthedocs.yaml

https://blog.readthedocs.com/migrate-configuration-v2/

Consider changing the data types to something less internal

In this column, the data types are named by their internal validation function for clojure.spec. As these are relatively arbitratily named, I would suggest changing them out for something 1) used more widely and 2) further abstracted 3) reveals less about inner implementation.

One such solution would be to use the Typescript standard, as that is becoming a very widely used type system.

the changes would look like this

inner implementation	typed reference	as multiple
uuid-string	uuid	uuid[]
strings<->uuids	uuid[]	uuid[]
single-string	string	string[]
cell-list	string[]	string[]
YN<->bool	boolean	boolean[]
string-date<->timestamp	timestamp	timestamp[]
status	"3" \ "2" \ "1"	Array<"3" \ "2" \ "1">

optional values get added question marks. string?, string[]?, etc

Review deploy process to ReadTheDocs

• Check what webhooks are doing: they currently seem to trigger a deploy when anything is pushed to one of the branches that RTD is actively monitoring.
• Check if sphinx build process is actually done by RTD at the point of deployment, or whether it needs to remain a local process done prior to pushing to github

Add "paragraph" as an access point trigger

Add paragraph as an access point trigger to the section Sources and Access Points. Update description text, and add an example based on paragraphs.