...
| Item | Who | Notes | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Roll call and note taker | Bobbi Fox taking notes | |||||||||
| Data Dictionary ownership and maintenance | The Reports subteam has been working on a data dictionary, with a demo at https://desolate-tundra-60608.herokuapp.com/, and they have questions about where/how the data dictionary could be maintained, including these activities:
Where/how could the Tech Docs subteam be involved? Laney:would it flow out of the release process? At least the tables for the data dictionary would get updated with the release as well as the cross-walk, with descriptive metadata to be added later. Is it technical documentation or user documentation? Scott: Could this be part of the QA/Test process to get some eyeballs on it? Bobbi: who's using this? what is the lag time if we put metadata descriptions it on the subteam? Laney: originally thought it was for the developers, but more & more seems like the archival users who have access to the db might use it in SQL. Thinks the metadata could be added later. Laney: the Reports subteam is under the UAC. Is it more a user doc or a technical doc? Max: seems like table & field information is one thing, but the description and example data is something that is so particular to an institution, so getting more of user vibe. Trevor: thinks it's a mixed bag. Dallas: A lot of the descriptions seem like the tooltips in the staff interface; is there a way to re-use this? Laney: The tooltip language is from the user documentation group. Laney: it was suggested that this was a cross-council kind of thing; doesn't know how that works. Laney: also trying to figure out where the Data Dictionary is going to live, who has permissions, etc. Do people get to modify it directly, do we do pull requests? etc. Scott: seems like there isn't a single group that's responsible for it. No conclusion reached Laney's ok with that, it was more that she wanted to make sure that this was discussed with this group. | |||||||||
| API docs, Jira ANW-199 | All | Request to look at
The documentation is in two places: | ||||||||
| Review issues in tech-docs GitHub | All | |||||||||
| Review pull requests in tech-docs GitHub | All | Closed: https://github.com/archivesspace/tech-docs/pull/9 Open: https://github.com/archivesspace/tech-docs/pull/3 https://github.com/archivesspace/tech-docs/pull/4 | ||||||||
| Workplan Goal 1. Enhance provisioning documentation | Updates | |||||||||
| Workplan Goal 2. Enhance plugin documentation | Updates | |||||||||
| Documentation platform | Feedback from TAC call on readthedocs, etc. | |||||||||
| Wrap up and next steps |
...