qor / doc

QOR3 documentation

QOR overview

QOR5 is released. Check it out!

QOR is a set of libraries written in Go that abstract common features needed for business applications, Content Management Systems (CMS), and E-commerce systems (EC).

Typically, a QOR-based system will revolve around QOR Admin, which is the CMS component. QOR Admin facilitates easy database and media content management and is not bound to a single database technology.

The bulk of QOR's multifaceted capabilities lie in the plugins, they can be used independently but their super-powers shine when used together. Many of the plugins utilize GORM as ORM.

We, The Plant, utilise QOR on our own projects and are interested to hear about yours and your experience in using QOR - there are a number of ways to contribute and communicate with us and the QOR community:

• our English speaking Gitter chat or Chinese speaking Gitter chat,
• email us [email protected]
• the Stackoverflow tag qor,
• for any and every security-related concern or report, send email to [email protected] (note: we ask that you follow a Responsible Disclosure procedure with us).

To keep up-to-date with QOR developments, subscribe to one or more of the following:

• watch our QOR github repo (and any plugin repos you are interested in)
• join our English speaking Gitter chat or Chinese speaking Gitter chat

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.

doc's Issues

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 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

Disambiguate Authentication section

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

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

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.

when is this gonna be updated?

hi there really need those docs! :)

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

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

Add new Publish2 page

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

Setup Gitbook CNAME for getqor.com

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

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.