README
¶
Documize - author, track and deliver documentation
The mission
To bring software development inspired features to the world of documenting -- refactoring, importing, testing, linting, metrics, PRs, versioning....
What is it?
Documize is an intelligent document environment (IDE) for authoring, tracking and delivering documentation -- everything you need in one place.
Why should I care?
Because maybe like us you're tired of:
- juggling WYSIWYG editors, wiki software and other document related solutions
- playing email tennis with documents, contributions, versions and feedback
- sharing not-so-secure folders with external participants
Sound familiar? Read on.
Who is it for?
Anyone who wants a single place for any kind of document.
Anyone who wants to loop in external participants complete security.
Anyone who wishes documentation and knowledge capture worked like agile software development.
What's different about Documize?
Sane organization through personal, team and public spaces.
Granular document access control via categories.
Section based approach to document construction.
Reusable templates and content blocks.
Documentation related tasking and delegation.
Integrations for embedding SaaS data within documents, zero add-on/marketplace fees.
What does it look like?
All spaces.
Space view.
Latest version
OS support
Documize runs on the following:
- Linux
- Windows
- macOS
Technology stack
Documize is built with the following technologies:
- EmberJS (v2.18.0)
- Go (v1.10.1)
...and supports the following databases:
- MySQL (v5.7.10+)
- Percona (v5.7.16-10+)
- MariaDB (10.3.0+)
Coming soon, PostgreSQL and Microsoft SQL Server database support.
Authentication options
Besides email/password login, you can also leverage the following options.
Keycloak Integration
Documize provides out-of-the-box integration with Redhat Keycloak for open source identity and access management.
Connect and authenticate with LDAP, Active Directory and more.
Auth0 Compatible
Documize is compatible with Auth0 identity as a service.
Open Source Identity and Access Management
Developer's Note
We try to follow sound advice when writing commit messages:
https://chris.beams.io/posts/git-commit/
The legal bit at the end
This software (Documize Community Edition) is licensed under GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html. You can operate outside the AGPL restrictions by purchasing Documize Enterprise Edition and obtaining a commercial license by contacting sales@documize.com. Documize® is a registered trade mark of Documize Inc.
Directories
¶
| Path | Synopsis |
|---|---|
|
core
|
|
|
api/convert
Package convert provides the gateway to document conversion native and plugin functionality, both in and out of the system.
|
Package convert provides the gateway to document conversion native and plugin functionality, both in and out of the system. |
|
api/convert/html
Package html documizes html files.
|
Package html documizes html files. |
|
api/plugins
Package plugins manages the plug-in componenets of the Documize system.
|
Package plugins manages the plug-in componenets of the Documize system. |
|
convapi
Package convapi provides the definitions of types used for file conversion communication between different components of the Documize system.
|
Package convapi provides the definitions of types used for file conversion communication between different components of the Documize system. |
|
env
Package env provides runtime, server level setup and configuration Package env provides runtime, server level setup and configuration Package env provides runtime, server level setup and configuration
|
Package env provides runtime, server level setup and configuration Package env provides runtime, server level setup and configuration Package env provides runtime, server level setup and configuration |
|
mail
Package gomail provides a simple interface to compose emails and to mail them efficiently.
|
Package gomail provides a simple interface to compose emails and to mail them efficiently. |
|
request
Package request provides HTTP request parsing functions.
|
Package request provides HTTP request parsing functions. |
|
response
Package response provides functions to write HTTP response.
|
Package response provides functions to write HTTP response. |
|
timeutil
Package timeutil provides date and time related types and helpers.
|
Package timeutil provides date and time related types and helpers. |
|
uniqueid
Package uniqueid provides utility functions specific to the http-end-point component of Documize.
|
Package uniqueid provides utility functions specific to the http-end-point component of Documize. |
|
uniqueid/xid
Package xid is a globally unique id generator suited for web scale Xid is using Mongo Object ID algorithm to generate globally unique ids: https://docs.mongodb.org/manual/reference/object-id/ - 4-byte value representing the seconds since the Unix epoch, - 3-byte machine identifier, - 2-byte process id, and - 3-byte counter, starting with a random value.
|
Package xid is a globally unique id generator suited for web scale Xid is using Mongo Object ID algorithm to generate globally unique ids: https://docs.mongodb.org/manual/reference/object-id/ - 4-byte value representing the seconds since the Unix epoch, - 3-byte machine identifier, - 2-byte process id, and - 3-byte counter, starting with a random value. |
|
Package domain defines data structures for moving data between services.
|
Package domain defines data structures for moving data between services. |
|
audit/mysql
Package audit records user events.
|
Package audit records user events. |
|
category
Package category handles API calls and persistence for categories.
|
Package category handles API calls and persistence for categories. |
|
category/mysql
Package mysql handles data persistence for both category definition and and document/category association.
|
Package mysql handles data persistence for both category definition and and document/category association. |
|
conversion/store
Package store provides the implementation for a file system based storage provider.
|
Package store provides the implementation for a file system based storage provider. |
|
permission
Package permission handles API calls and persistence for spaces.
|
Package permission handles API calls and persistence for spaces. |
|
permission/mysql
Package mysql handles data persistence for space and document permissions.
|
Package mysql handles data persistence for space and document permissions. |
|
setting
Package setting manages both global and user level settings Package setting manages both global and user level settings Package setting manages both global and user level settings
|
Package setting manages both global and user level settings Package setting manages both global and user level settings Package setting manages both global and user level settings |
|
smtp
Package smtp provides access to SMTP server for sending email.
|
Package smtp provides access to SMTP server for sending email. |
|
space
Package space handles API calls and persistence for spaces.
|
Package space handles API calls and persistence for spaces. |
|
space/mysql
Package mysql handles data persistence for spaces.
|
Package mysql handles data persistence for spaces. |
|
This package provides Documize as a single executable.
|
This package provides Documize as a single executable. |
|
boot
Package boot prepares runtime environment.
|
Package boot prepares runtime environment. |
|
logging
Package logging defines application-wide logging implementation.
|
Package logging defines application-wide logging implementation. |
|
Package embed contains the Documize static web data.
|
Package embed contains the Documize static web data. |
|
Package model ...
|
Package model ... |
|
audit
Package eventing records and propagates events based on user actions.
|
Package eventing records and propagates events based on user actions. |
|
web
Package web contains the Documize static web data.
|
Package web contains the Documize static web data. |