README
¶
Documize Community Edition
Documentation that integrates and snapshots data from the tools you use.
v0.14.0
Why?
In my previous startup, we sold “project management” software to businesses of all shapes and sizes. Our customers would complain that developers and business folks fought pitched battles over work visibility and deliverables. Being a developer & CTO by trade, I saw the same thing myself many times over.
Developers just want to code, and generally speaking documenting a chore.
It really hit home when staring at Google Docs. I struggled to pull together a coherent document explaining what happened during the latest development cycle. I wanted to share code commits, deployment logs, customer tickets, tasks with co-workers and customers. I just couldn’t do it without cut-pasting screenshots and emailing app links with sketchy instructions.
At that moment, I realized the way we produce documentation was fundamentally broken because more and more of our data was in the cloud. And it was getting worse each time we adopted a new SaaS tool — more SaaS tools, more data silos, more screenshots and even more app links to send round.
So we set about building Documize — it allows people to point-click-integrate their SaaS data into a different kind of “document”. You can think of the end result as a unified team inbox for any deliverable (that kills the hassle of juggling the ever-growing SaaS footprint).
Our mission is simple: to help businesses to snapshot, track and integrate their cloud-based data to compose a new kind of document.
Don’t write documents. Compose them.
@HarveyKandola, Founder, Documize Inc.
Tech stack
- EmberJS v2.5.1
- Go v1.6.2
- MySQL v5.7.10+
Documentation
Screenshot
Legal
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 |
|---|---|
|
This package provides Documize as a single executable.
|
This package provides Documize as a single executable. |
|
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/excerpt
Package excerpt provides basic functionality to create excerpts of text in English.
|
Package excerpt provides basic functionality to create excerpts of text in English. |
|
api/convert/html
Package html documizes html files.
|
Package html documizes html files. |
|
api/endpoint
Package endpoint provides API endpoints for Documize.
|
Package endpoint provides API endpoints for Documize. |
|
api/endpoint/models
Package models describes the communication format between JS snd Go.
|
Package models describes the communication format between JS snd Go. |
|
api/entity
Package entity provides types that mirror database tables.
|
Package entity provides types that mirror database tables. |
|
api/mail
Package mail sends transactional emails.
|
Package mail sends transactional emails. |
|
api/plugins
Package plugins manages the plug-in componenets of the Documize system.
|
Package plugins manages the plug-in componenets of the Documize system. |
|
api/request
Package request handles database requests for Documize, mostly from the endpoints package.
|
Package request handles database requests for Documize, mostly from the endpoints package. |
|
api/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. |
|
api/util
Package util provides utility functions specific to the http-end-point component of Documize.
|
Package util provides utility functions specific to the http-end-point component of Documize. |
|
web
Package web contains the Documize static web data.
|
Package web contains the Documize static web data. |
|
Package main provides a simple Documize plugin for document conversions using libreoffice.
|
Package main provides a simple Documize plugin for document conversions using libreoffice. |
|
wordsmith
|
|
|
api
Package api provides the defininitions of types used for communication between different components of the Documize system.
|
Package api provides the defininitions of types used for communication between different components of the Documize system. |
|
environment
Package environment allow environment variables to be obtained from either the environment or the command line.
|
Package environment allow environment variables to be obtained from either the environment or the command line. |
|
log
Package log provides centralized logging for the Documize application.
|
Package log provides centralized logging for the Documize application. |
|
utility
Package utility contains utility functions used by the whole Documize ecosystem.
|
Package utility contains utility functions used by the whole Documize ecosystem. |
|
wordlists
Package main creates ordered lists of english words and their stems, based on their frequency.
|
Package main creates ordered lists of english words and their stems, based on their frequency. |
|
wordlists/en-2012
Package words was auto-generated ! From base data at http://invokeit.wordpress.com/frequency-word-lists/ .
|
Package words was auto-generated ! From base data at http://invokeit.wordpress.com/frequency-word-lists/ . |