getodk / getodk/docs

Pull in docs from ODK wiki

Open
#380 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

- [ ] Collect
- [Collect troubleshooting](https://github.com/opendatakit/opendatakit/wiki/Collect-Troubleshooting)

- [ ] Aggregate
- [Aggregate 0.9.x to 1.x](https://github.com/opendatakit/opendatakit/wiki/Aggregate-0.9.x-to-1.x-Migration): Added in Aggregate upgrade guide
- [AppEngine Master Slave migration](https://github.com/opendatakit/opendatakit/wiki/Aggregate-AppEngine-Master-Slave-Migration)
- [AppEngine troubleshooting](https://github.com/opendatakit/opendatakit/wiki/Aggregate-AppEngine-Troubleshooting)
- [AWS Install](https://github.com/opendatakit/opendatakit/wiki/Aggregate-AWS-Install): Some information added in Aggregate install guide. Issue #355
- [Security note](https://github.com/opendatakit/opendatakit/wiki/Aggregate-Security-Note)
- [Tomcat troubleshoot](https://github.com/opendatakit/opendatakit/wiki/Aggregate-Tomcat-Troubleshooting)
- [Uninstall instructions](https://github.com/opendatakit/opendatakit/wiki/Aggregate-Uninstall-Instructions)

- [ ] Contributors guide
- [Repository migration](https://github.com/opendatakit/opendatakit/wiki/New-Repository-Migration-Guide)

- [ ] Developing with ODK
- [Aggregate Publishers details](https://github.com/opendatakit/opendatakit/wiki/Aggregate-Publishers-Implementation-Details)
- [Aggregate Eclipse Setup](https://github.com/opendatakit/opendatakit/wiki/Aggregate-Eclipse-Setup)
- [Aggregate database structure](https://github.com/opendatakit/opendatakit/wiki/Aggregate-Database-Structure)
- [Aggregate deployment configuration](https://github.com/opendatakit/opendatakit/wiki/Aggregate-Deployment-Configuration)
- [Aggregate source code overview](https://github.com/opendatakit/opendatakit/wiki/Aggregate-Source-Code-Overview)
- [Briefcase Aggregate API](https://github.com/opendatakit/opendatakit/wiki/Briefcase-Aggregate-API): Issue #375
- [Collect source code overview](https://github.com/opendatakit/opendatakit/wiki/Collect-Source-Code-Overview)
- [DevEnv Setup](https://github.com/opendatakit/opendatakit/wiki/DevEnv-Setup):
- [DevEnv Debugging Tips](https://github.com/opendatakit/opendatakit/wiki/DevEnv-Debugging-Tips)
- [ODK 2.0 Form Specification](https://github.com/opendatakit/opendatakit/wiki/ODK-2.0-Form-Specification)
- [ODK 2.0 Synchronization API](https://github.com/opendatakit/opendatakit/wiki/ODK-2.0-Synchronization-API-(RESTful))

- [ ] Release notes
- [Aggregate Release notes](https://github.com/opendatakit/opendatakit/wiki/Aggregate-Release-Notes): added in upgrade guide
- [Briefcase Release Notes](https://github.com/opendatakit/opendatakit/wiki/Briefcase-Release-Notes)
- [Collect Release Notes](https://github.com/opendatakit/opendatakit/wiki/Collect-Release-Notes): Issue #242
- [FormUploader Release Notes](https://github.com/opendatakit/opendatakit/wiki/FormUploader-Release-Notes)
- [Scan Release Notes](https://github.com/opendatakit/opendatakit/wiki/Scan-Release-Notes)
- [Sensors Framework Release Notes](https://github.com/opendatakit/opendatakit/wiki/Sensors-Framework-Release-Notes)
- [Tools Suite Release Notes](https://github.com/opendatakit/opendatakit/wiki/Tools-Suite-Release-Notes)
- [Zebra Printer Driver Release Notes](https://github.com/opendatakit/opendatakit/wiki/Zebra-Printer-Driver-Release-Notes)

We need to discuss whether release notes should be added or not.

- [ ] Remaining sections
- [Hosting AppDesigner On Static WebServer](https://github.com/opendatakit/opendatakit/wiki/Hosting-AppDesigner-On-Static-WebServer)
- [FoneAstra](https://github.com/opendatakit/opendatakit/wiki/FoneAstra)
- [Clinic](https://github.com/opendatakit/opendatakit/wiki/Clinic)
- [Clinic Patient](https://github.com/opendatakit/opendatakit/wiki/Clinic-Patient)
- [Manage](https://github.com/opendatakit/opendatakit/wiki/Manage)
- [Manage Design Document](https://github.com/opendatakit/opendatakit/wiki/Manage-Design-Document)
- [Manage ReadMe](https://github.com/opendatakit/opendatakit/wiki/Manage-ReadMe)
- [Project Ideas](https://github.com/opendatakit/opendatakit/wiki/Project-Ideas)
- [Project Legacy Notes](https://github.com/opendatakit/opendatakit/wiki/Project-Legacy-Notes)
- [Scan Webapp SetUp](https://github.com/opendatakit/opendatakit/wiki/Scan-Web-App-SetUp)
- [Scan-XLSForm-Documentation](https://github.com/opendatakit/opendatakit/wiki/Scan-XLSForm-Documentation)
- [Tools Suite Javascript framework](https://github.com/opendatakit/opendatakit/wiki/Tool-Suite-Javascript-framework-and-formDef.json-(Survey)-format)
- [Tools-Suite-Technologies](https://github.com/opendatakit/opendatakit/wiki/Tools-Suite-Technologies)
- [Voice](https://github.com/opendatakit/opendatakit/wiki/Voice)
- [XFormControlExtensionProposal](https://github.com/opendatakit/opendatakit/wiki/XFormControlExtensionProposal)
- [XFormLogicExplained](https://github.com/opendatakit/opendatakit/wiki/XFormLogicExplained)

We need to decide on the remaining topics: which ones should be added and where should they be added.

@adammichaelwood @lognaturel @yanokwa Please share your reviews on this issue.

Contributor guide

Open the contributing guide

Research direction

Review the checklist and the existing Aggregate upgrade guide in this Sphinx documentation repository, then compare the linked ODK wiki pages with current docs. Confirm which pages belong in the repository, where each should be placed, and whether release notes are in scope. Done means the selected content has been migrated and the remaining topics and release-note policy are resolved.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.