Skip to content
This repository has been archived by the owner on Apr 23, 2024. It is now read-only.

Validations "QOR Support" section #10

Open
bodhi opened this issue Nov 7, 2016 · 7 comments
Open

Validations "QOR Support" section #10

bodhi opened this issue Nov 7, 2016 · 7 comments
Assignees

Comments

@bodhi
Copy link
Member

bodhi commented Nov 7, 2016

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.

@raven-chen raven-chen self-assigned this Nov 8, 2016
raven-chen added a commit that referenced this issue Nov 8, 2016
@raven-chen
Copy link
Member

Removed unnecessary QOR support text.

@coreform
Copy link
Contributor

coreform commented Nov 8, 2016

Those are remnants of the per-repo README documentation. For the new monolithic Doc, I have been changing that section to 'QOR Integration', removing the basic QOR introduction paragraph and replacing with something like:

Although Location could be used alone, it integrates nicely with QOR.

E.g.:
https://github.com/qor/doc/blob/master/plugins/i18n.md
https://github.com/qor/doc/blob/master/plugins/l10n.md

adccebf
^ shows some work to improve that section. It is not redundant as it makes it clear that such Plugins can be used standalone. Ideally, we would be achieving clarity and consistency, rather than just consistency as a result of this Issue.

@coreform
Copy link
Contributor

coreform commented Nov 8, 2016

Reopening as it would be ideal to follow the new pattern for QOR Integration sections (consistency) in applicable Plugins.

@coreform coreform reopened this Nov 8, 2016
@bodhi
Copy link
Member Author

bodhi commented Nov 8, 2016

Although Location could be used alone, it integrates nicely with QOR

This seems odd: this is the QOR doc, and Location is being described as a QOR plugin, so it would be strange if it didn't integrate nicely?

@raven-chen
Copy link
Member

Yeah. Better to separate it into two sections. "Integrate with QOR" and "Use it alone". Let's just focus on the first section for now ?

@coreform
Copy link
Contributor

coreform commented Nov 9, 2016

It would be nice if there were more information about how each Plugin integrates with QOR (because that is effectively what QOR is: an integration of components and Plugins). Like the information provided in https://github.com/qor/doc/blob/master/plugins/activity.md , that would give developers a better understanding of what to expect to see and the behaviour in QOR Admin when a Plugin is used.

@raven-chen
Copy link
Member

@coreform yes. https://doc.getqor.com/helpers/render.html this is a good negative example. I'm working on it now.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants