#3198 add architecture doc for the MyData feature

[raprasad]

Note: This is a documentation addition with no functional code changes.

RFI Checklist

Before submitting the pull request, fill out sections (1.) Related Issues and (2.) Pull Request Checklist.

1. Related Issues

#3198 - Add MyData presentation to docs

---

2. Pull Request Checklist

• N/A - Functionality completed as described in FRD
• N/A - Dependencies, risks, assumptions in FRD addressed
• N/A - Unit tests completed
• N/A - Deployment requirements identified (e.g., SQL scripts, indexing)
• Documentation completed
• N/A - All code checkins completed

---

3. Review Checklist

After the pull request has been submitted, fill out this section.

• Code review completed or waived
• Testing requirements completed
• Usability testing completed or waived
• Support testing completed or waived
• Merged with develop branch and resolved conflicts

[coveralls]

Coverage remained the same at 5.133% when pulling afd3749 on 3198-add-mydata-doc into 47b04ed on develop.

[pdurbin]

@raprasad rather than src/main/java/edu/harvard/iq/dataverse/mydata/README.md you might consider making a file at src/main/java/edu/harvard/iq/dataverse/mydata/package-info.java instead. I got this idea from looking at https://github.com/IQSS/dataverse/blob/v4.4/JAVADOC_GUIDE.md and in #3111 I have a file at src/main/java/edu/harvard/iq/dataverse/privateurl/package-info.java

I'm experimenting in #2513 with having those "package-info.java" files get rendered as HTML at http://phoenix.dataverse.org/site/latest/site/apidocs/

Rather than pptx it would be nice if the "editable" version was an open format.

I've thought about bringing up this topic of developer docs on at https://groups.google.com/forum/#!forum/dataverse-dev . I'm not trying to squelch you. Thanks for writing docs!!

[raprasad]

thx, @pdurbin

Yes, completely agreed. I just wanted to get this doc "somewhere" before it was (again) literally "lost" from memory. e.g. Not great but the google presentation link is in the readme and that's editable. The presentation is quite visual but will look at java-doc'ing it for continuity.

@sekmiller had to make a change to this code recently and there was no readily available reference. I had also forgotten about the presentation in this check-in.

[pdurbin]

Closing. Let's simply add a link to https://docs.google.com/a/harvard.edu/presentation/d/1aHjOMy8FIbMVyJEZu_m4ab4ftutgQiC8y6HM47Am2z0/edit?usp=sharing somewhere under https://github.com/IQSS/dataverse/tree/develop/doc/sphinx-guides/source/developers instead of putting proprietary formats such as PowerPoint into the source tree.