qor/doc

QOR3 documentation

QOR

English Chat Room:

中文聊天室：

For security issues, please send us an email to [email protected] and give us time to respond BEFORE posting as an issue or reporting on public forums.

What is QOR?

QOR is a set of libraries written in Go that abstracts common features needed for business applications, CMSs, and E-commerce systems.

This is a complete rewrite in Go, of the original QOR, which was a proprietary framework written in Ruby on Rails and used internally at The Plant. QOR 1.0 is the first version to be open sourced and distributed under the MIT license.

What QOR is not

QOR is not a "boxed turnkey solution". You need proper coding skills to use it. It's designed to make the lives of developers easier when building complex EC systems, not providing you one out of the box.

Documentation

https://doc.getqor.com/

The modules

• Admin - The core part of QOR system, will generate an admin interface and RESTFul API for you to manage your data

• Publish - Providing a staging environment for all content changes to be reviewed before being published to the live system

• Transition - A configurable State Machine: define states, events (eg. pay order), and validation constraints for state transitions

• Media Library - Asset Management with support for several cloud storage backends and publishing via a CDN

• Worker (Batch processing) - A process scheduler

• Exchange - Data exchange with other business applications using CSV or Excel data

• Internationalization (i18n) - Managing and (inline) editing of translations

• Localization (l10n) - Manage DB-backed models on per-locale basis, with support for defining/editing localizable attributes, and locale-based querying

• Roles - Access Control

• And more https://github.com/qor

Live DEMO

• Live Demo http://demo.getqor.com/admin
• Source Code of Live Demo https://github.com/qor/qor-example

Frontend Development

Requires Node.js and Gulp for building frontend files

npm install && npm install -g gulp

• Watch SCSS/JavaScript changes: gulp
• Build Release files: gulp release

License

Released under the MIT License.

doc's Issues

Disambiguate Authentication section

It talks about Authorization, which is not the same as Authentication...so it is confused, and readers will/should be confused.

怎么安装？

怎么看不到怎么安装呢？

开源诚意在哪里？居然安装的文档都没有

less nasty representation of resource-intro Configurations

I imagine other readers will easily glaze-over looking at that. Perhaps a descending list that is far more legible and with room to explain each part in more depth?

Add new Publish2 page

• Add documentation for the new Publish2 feature of QOR.
• Review new documentation.

Add more screenshots to document

For those documents that a screenshot could explain it better.

Add a fancy new Gitbooks cover image

Large and small sizes

when is this gonna be updated?

hi there really need those docs! :)

Language, grammar check new doco

Go through the doco, top to bottom, and make it read well in English proper.

• Getting started
• Building an application
• Set up QOR admin
• Dashboard
• Site name
• Menus
• Router
• Resource
• Search
• Scopes and filters
• Actions
• Theme & Customize views
  Form fields
• Checkbox
• Collection/Single edit
• Date/Datetime
• Number/Float
• Hidden/Readonly
• Password
• Rich editor
• Select many
• Select one
• Text input/Text area
  Plugins
• Authentication
• Activity
• Audited
• BinDataFS
• Exchange
• Filebox
• I18n
• L10n
• Location
• Media library
• Notification
• Publish
• Roles
• Serializable meta
• Slug
• Transition
• Validation
• Worker
  Helpers
• Action bar
• Cache
• Render
• Responder
• SEO
• Sorting
• Widget
• Wildcard router

Setup Gitbook CNAME for getqor.com

https://help.gitbook.com/books/can-i-use-custom-domain.html

Follow each tutorial code snippet with an explanation of what is happening

At the moment, the tutorial code is listed and not thoroughly explained.

Validations "QOR Support" section

Seems unnecessary?

QOR is architected from the ground up to accelerate development and deployment of [...]

Part of it describes the way it integrates with QOR admin, this is probably useful to keep, but just edit it to remove any info that is already described.

Linkify QOR components throughout doco

1. Go through doco, bottom to top, and turn all references to QOR components to links pointing to each respective Doc section.
2. Ensure each Doc section has it's corresponding Github repo linked.