help

package

v0.0.0-...-2a3cdc3 Latest Latest Go to latest Published: Jun 27, 2020 License: MIT, MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/qxs820624/qor

Links

Open Source Insights

README ¶

QOR Help

QOR Help provides a way to add help documents to QOR Admin

Usage

First, add QOR Help table to the database.

db.DB.AutoMigrate(&help.QorHelpEntry{})

Then add QOR Help to QOR Admin.

Admin.NewResource(&help.QorHelpEntry{})

Now start your application. You should see a question mark icon appears at the top right corner of QOR Admin interface, click the icon, a slide panel should appear, the Admin user could get knowledge from here directly.

License

Released under the MIT License.

Documentation ¶

Index ¶

Variables
type Categories
- func (categories *Categories) Scan(data interface{}) (err error)
- func (categories Categories) Value() (driver.Value, error)
type QorHelpEntry

Constants ¶

This section is empty.

Variables ¶

View Source

var Global = "dashboard"

Functions ¶

This section is empty.

Types ¶

type Categories ¶

type Categories struct {
	RawValue   string
	Categories []string
}

func (*Categories) Scan ¶

func (categories *Categories) Scan(data interface{}) (err error)

func (Categories) Value ¶

func (categories Categories) Value() (driver.Value, error)

type QorHelpEntry ¶

type QorHelpEntry struct {
	gorm.Model
	Title      string
	Categories Categories
	Body       string `gorm:"size:65532"`
}

func (*QorHelpEntry) ConfigureQorResource ¶

func (qorHelpEntry *QorHelpEntry) ConfigureQorResource(res resource.Resourcer)

func (QorHelpEntry) ResourceName ¶

func (QorHelpEntry) ResourceName() string

func (QorHelpEntry) ToParam ¶

func (QorHelpEntry) ToParam() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL