documentation - things to add

guardian / gudocs2

Google Docs to S3 uploader

0 stars 0 forks source link

documentation - things to add #4

Open dblatcher opened 1 month ago

dblatcher commented 1 month ago

general

[ ] explanation of what the tool is used for
[ ] example links to articles which are using it, and/or to repo for the interactives

guide to running locally

[x] janus credentials needed ("interactives.dev" ? I have "interactives.s3", but doesn't seem to allow access to the params and secrets)
[x] how to trigger the scheduled updates
[x] point out that running locally points to the CODE dynanmo DB and google docs sharing profiles (IE - others can see what you share)

davidfurey commented 1 month ago

Is the new section in the README sufficient to cover the points raise here on guide to running locally?

General explanation of the tool is on my list, but good to have it recorded here. I was planning to write something and get the interactives team to check if it matches reality

dblatcher commented 1 month ago

Is the new section in the README sufficient to cover the points raise here on guide to running locally?

looks good to me! I'll update the desctiption