... | ... | @@ -16,31 +16,31 @@ Current pieces of documentation for soledad are: |
|
|
|
|
|
# Proposed structure / wishlist
|
|
|
|
|
|
* Tutorials (learning oriented)
|
|
|
* How-to guides (goal oriented)
|
|
|
* Discussions (understanding oriented)
|
|
|
* Reference (information oriented)
|
|
|
* Tutorials (learning oriented) **(T)**
|
|
|
* How-to guides (goal oriented) **(H)**
|
|
|
* Discussions (understanding oriented) **(D)**
|
|
|
* Reference (information oriented) **(R)**
|
|
|
|
|
|
# Current structure
|
|
|
|
|
|
* Soledad Client
|
|
|
* Soledad Server
|
|
|
* General information
|
|
|
* Server database organization
|
|
|
* Server Configuration File
|
|
|
* Authentication
|
|
|
* Authorization header
|
|
|
* Services API tokens file
|
|
|
* Implementation
|
|
|
* Soledad Server **(R)**
|
|
|
* General information **(R)**
|
|
|
* Server database organization **(R)**
|
|
|
* Server Configuration File **(R)**
|
|
|
* Authentication **(R)**
|
|
|
* Authorization header **(R)**
|
|
|
* Services API tokens file **(R)**
|
|
|
* Implementation **(R)**
|
|
|
* Reference
|
|
|
* Environment Variables
|
|
|
* Document attachments
|
|
|
* Soledad “Incoming Box” Specification
|
|
|
* Environment Variables **(R)**
|
|
|
* Document attachments **(D)(R)(T)**
|
|
|
* Soledad “Incoming Box” Specification **(R)**
|
|
|
* Development
|
|
|
* Contributing
|
|
|
* Backwards-compatibility and deprecation policy
|
|
|
* Tests
|
|
|
* Benchmarks
|
|
|
* Changelog
|
|
|
* Contributing **(R)**
|
|
|
* Backwards-compatibility and deprecation policy **(R)**
|
|
|
* Tests **(R)(H)**
|
|
|
* Benchmarks **(R)**
|
|
|
* Changelog **(R)**
|
|
|
* Migrations
|
|
|
* Soledad Server 0.8 to 0.9 - Couch Database schema migration needed |
|
|
\ No newline at end of file |
|
|
* Soledad Server 0.8 to 0.9 - Couch Database schema migration needed **(R)** |
|
|
\ No newline at end of file |