move report rendering files into own directory

This commit is contained in:
Callan Bryant 2020-06-01 21:41:42 +01:00
parent 039cd4eb8b
commit d948f204fc
No known key found for this signature in database
GPG Key ID: C31FA9DF3ACBFFAA
5 changed files with 15 additions and 3 deletions

View File

@ -258,7 +258,7 @@ The report can be converted, for instance, into a HTML table as below:
![dsnet report table](https://raw.githubusercontent.com/naggie/dsnet/master/etc/report.png)
See
[etc/README.md](https://github.com/naggie/dsnet/blob/master/etc/dsnetreport.html)
[etc/README.md](https://github.com/naggie/dsnet/blob/master/report_rendering/README.md)
for hugo and PHP code for rendering a similar table.
# FAQ

View File

@ -1,2 +0,0 @@
* `dsnetreport.php`: A php file to render a report.
* `dsnetreport.html`: A hugo shortcode for rendering a report. See https://github.com/naggie/dsnet/issues/4#issuecomment-632928158 for background.

View File

@ -0,0 +1,14 @@
This directory contains scripts and templates that can be used to render
`/var/lib/dsnetreport.json`. They are useful for integrating a peer overview
into an existing website or web application.
Most are contributions from other users. If you have a useful addition, please
do a PR.
* `dsnetreport.php`: A php file to render a report.
* `dsnetreport.html`: A hugo shortcode for rendering a report. See https://github.com/naggie/dsnet/issues/4#issuecomment-632928158 for background. Courtesy of [@Write](https://github.com/Write)
Most look something like this:
![dsnet report table](https://raw.githubusercontent.com/naggie/dsnet/master/etc/report.png)