Migrate Documents to New Structure
Problem Statement
- Repo directory structure is not meeting class expectations
- Privacy concerns over some content in notes has been raised
- Realtime access to documents by team members has been requested
- Updating Documents in multiple locations takes too much time
- Updating Documents is not recognized as a task by the class
Who will benefit?
- Any team members assigned to documentation tasks
- Any external individuals with privacy concerns
Benefits and risks
- Harder to deploy scripts and automation in Microsoft Office document formats
- Course professor will have access to all documents (currently no risk)
Proposed solution
- Migrate all notes and documents to Microsoft OneNote and Microsoft Word
- Provide access to Microsoft Teams for review of documents to particular people on a limited basis
Deliverable
- Repository directory modifications
- Document generation and storage process modifications
Priority/Severity
-
High (This will bring a huge increase in performance/productivity/usability/legislative cover) -
Medium (This will bring a good increase in performance/productivity/usability) -
Low (anything else e.g., trivial, minor improvements)
Tasks
-
Create issue of moving documents -
Move Contributing to Root -
Move Security to Root -
Move Conduct to Root -
Move Decisions to OneNote -
Move Discussions to OneNote -
Cleanup Unused OneNote Folders -
Censor Shared Documents (No Changes Necessary) -
Update README (Repo) -
Update Changelog (Repo) -
Update Changelog (OneNote) -
Update Decisions (OneNote) -
Notify Team of Changes -
Notify Course Instructor of Changes
Edited by Peter Mangelsdorf