Commit 112c081b by Robbie Hott

Fixed comments in the requirements.md file

parent bc851cf8
...@@ -21,7 +21,7 @@ This is the definitive list of all requirements, briefly. Anything the applicati ...@@ -21,7 +21,7 @@ This is the definitive list of all requirements, briefly. Anything the applicati
list. Each item and group of items is explained in detail later in the document. Being a "list", this includes list. Each item and group of items is explained in detail later in the document. Being a "list", this includes
only sufficient detail to disambiguate items. only sufficient detail to disambiguate items.
**RH: We should reorganize these by component of the system, then create a formal specifications for each component as to what it must do and how they interact.** **Todo: We should reorganize these by component of the system, then create a formal specifications for each component as to what it must do and how they interact.**
- authentication - authentication
...@@ -147,7 +147,7 @@ only sufficient detail to disambiguate items. ...@@ -147,7 +147,7 @@ only sufficient detail to disambiguate items.
2. External resources link to SNAC as an authority. (Tom comment: is SNAC also an archival resource?) 2. External resources link to SNAC as an authority. (Tom comment: is SNAC also an archival resource?)
- Clarify: the co-op version 1 is not going to support bulk data ingest - Clarify: the co-op version 1 is not going to support bulk data ingest
* **Why not?** * This may be a simple bi-product of the Rest API being available
- Clarify: the co-op version 1 is not going to support bi-directional data exchange and update - Clarify: the co-op version 1 is not going to support bi-directional data exchange and update
...@@ -155,12 +155,12 @@ only sufficient detail to disambiguate items. ...@@ -155,12 +155,12 @@ only sufficient detail to disambiguate items.
delete from backups? Are either of these even required by policy? delete from backups? Are either of these even required by policy?
- Are we assuming that data from the web browser has been sanity checked before hitting the server? (Yes, by - Are we assuming that data from the web browser has been sanity checked before hitting the server? (Yes, by
the data validation API) the data validation engine)
* **What is the data validation api? Wouldn't we need a validation engine? Where will the engine live, in the browser?** * **Todo: Where will the engine live, in the browser (Javascript) or on the server?**
- Does the server need to save temporary edit data prior to writing the data to the cpf database? For example, what if - Does the server need to save temporary edit data prior to writing the data to the cpf database? For example, what if
someone enters "19th century" in a date field? It isn't valid, but we need to save their work. (Yes, we need to save invalid user input, and give the user a useful message for each type of data validation failure.) someone enters "19th century" in a date field? It isn't valid, but we need to save their work. (Yes, we need to save invalid user input, and give the user a useful message for each type of data validation failure.)
* **Where does the data validation engine live? If we make that part of the UI, it may live on the browser as a downloaded JS engine** * **Todo: Where does the data validation engine live? If we make that part of the UI, it may live on the browser as a downloaded JS engine**
- We need to sanity check any links we create, especially links back into SNAC. - We need to sanity check any links we create, especially links back into SNAC.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment