IDA Documentation Strategy 2
- Peter Desjardins (Deactivated)
- Feanil Patel
- Sylvia Pearce (Deactivated)
Owned by Peter Desjardins (Deactivated)
| See also IDA Documentation Strategy 1. |
The way we write and deliver documentation for edX IDAs should be determined by the requirements of the audience for the IDAs. IDAs are part of a cohesive edX site. End users, including Open edX operations installers and administrators need to understand how to combine IDAs to create edX sites with different sets of functionality.
IDA documentation audiences:
- Operations users, installing and configuring an edX site
- Developers, creating and maintaining IDA functionality
- API client developers, using REST web services APIs
- Administrators, maintaining a running edX site
IDAs that can be part of an edX site:
- https://github.com/edx/ecommerce
- https://github.com/edx/course-discovery
- https://github.com/edx/credentials
- https://github.com/edx/api-manager
- https://github.com/edx/programs
- Analytics
- https://github.com/edx/edx-platform (It's an IDA!)
The configuration repository isn't an IDA but it's related to all of them (https://github.com/edx/configuration).
The existing documentation in the separate IDA repositories includes information intended for internal and Open edX developers. For example:
- http://open-edx-credentials-guide.readthedocs.io/en/latest/internationalization.html#internationalization
- http://open-edx-credentials-guide.readthedocs.io/en/latest/testing.html
- https://open-edx-course-discovery.readthedocs.io/en/latest/features.html#feature-toggling
Proposed Documentation Repository for IDAs By Audience
| IDA | Ops Installer | Administrator | API User / Client Developer | IDA Developer |
|---|---|---|---|---|
| Platform (LMS and Studio) | ICR guide in edx-documentation | ICR guide in edx-documentation | New guide covering Open edX REST APIs in edx-documentation | Developer's Guide in edx-documentation |
| Ecommerce | ICR guide in edx-documentation | ICR guide in edx-documentation | New guide covering Open edX REST APIs in edx-documentation | IDA /docs directory |
| Credentials | ICR guide in edx-documentation | ICR guide in edx-documentation | New guide covering Open edX REST APIs in edx-documentation | IDA /docs directory |
| Course Discovery | ICR guide in edx-documentation | ICR guide in edx-documentation | New guide covering Open edX REST APIs in edx-documentation | IDA /docs directory |
| Analytics | ICR guide in edx-documentation | ICR guide in edx-documentation | http://edx.readthedocs.io/projects/edx-data-analytics-api/ in edx-analytics-data-api | IDA /docs directory |
| Programs | ICR guide in edx-documentation | ICR guide in edx-documentation | New guide covering Open edX REST APIs in edx-documentation | IDA /docs directory |
| API Manager | ICR guide in edx-documentation | ICR guide in edx-documentation |