Skip to content
This repository has been archived by the owner on Jan 25, 2022. It is now read-only.

Review runner documentation #14

Open
solidgoldpig opened this issue Apr 24, 2019 · 1 comment
Open

Review runner documentation #14

solidgoldpig opened this issue Apr 24, 2019 · 1 comment

Comments

@solidgoldpig
Copy link
Contributor

No description provided.

@umaar
Copy link
Contributor

umaar commented Apr 25, 2019

Docs are looking great

Thoughts:

As a general note, almost all doc links are broken

Also lots of TODOs which can be addressed.


https://github.com/ministryofjustice/form-builder/blob/master/documentation/running/runner/storage.md

image

I think it's config instead now?

There will be an option to enable persistent storage.

Would be good to clarify what this means, as in when/how?

Read more about dynamoDb

This doesn't link to anything, but I think we're using RDS/Postgres now?


https://github.com/ministryofjustice/form-builder/blob/master/documentation/running/runner/pattern.md - needs updating, e.g. with an example of a pattern


https://github.com/ministryofjustice/form-builder/blob/master/documentation/running/runner/block.md#optional-properties

_isa _id of another block that the block is based on and which it inherit properties from. Any properties defined in the block override those set in the referenced block.

The wording of this could be improved - not sure I follow it! Also an explanation of what isa stands for

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants