diff options
| -rw-r--r-- | cmd/ponzu/main.go | 4 | ||||
| -rw-r--r-- | content/doc.go | 2 | ||||
| -rw-r--r-- | management/manager/manager.go | 2 | ||||
| -rw-r--r-- | system/admin/config/config.go | 3 | ||||
| -rw-r--r-- | system/admin/upload/upload.go | 2 | ||||
| -rw-r--r-- | system/admin/user/auth.go | 2 | ||||
| -rw-r--r-- | system/api/server.go | 3 | ||||
| -rw-r--r-- | system/auth.go | 3 | ||||
| -rw-r--r-- | system/db/init.go | 3 | ||||
| -rw-r--r-- | system/item/item.go | 3 | ||||
| -rw-r--r-- | system/search/search.go | 6 | ||||
| -rw-r--r-- | system/tls/enable.go | 3 |
12 files changed, 33 insertions, 3 deletions
diff --git a/cmd/ponzu/main.go b/cmd/ponzu/main.go index b3dc708..d57e776 100644 --- a/cmd/ponzu/main.go +++ b/cmd/ponzu/main.go @@ -1,3 +1,7 @@ +// Package main is located in the cmd/ponzu directory and contains the code to build +// and operate the command line interface (CLI) to manage Ponzu systems. Here, +// you will find the code that is used to create new Ponzu projects, generate +// code for content types and other files, build Ponzu binaries and run servers. package main import ( diff --git a/content/doc.go b/content/doc.go index 8ae4c06..549cf32 100644 --- a/content/doc.go +++ b/content/doc.go @@ -1,6 +1,6 @@ // Package content contains all user-supplied content which the system is to // manage. Generate content types by using the Ponzu command line tool 'ponzu' -// by running `$ ponzu generate <contentName> <fieldName:type...>` +// by running `$ ponzu generate content <structName> <fieldName:type...>` // Note: doc.go file is required to build the Ponzu command since some packages // import content package to a blank identifier. package content diff --git a/management/manager/manager.go b/management/manager/manager.go index 93c3315..1389747 100644 --- a/management/manager/manager.go +++ b/management/manager/manager.go @@ -1,3 +1,5 @@ +// Package manager contains the admin UI to the CMS which wraps all content editor +// interfaces to manage the create/edit/delete capabilities of Ponzu content. package manager import ( diff --git a/system/admin/config/config.go b/system/admin/config/config.go index 015c081..19da39b 100644 --- a/system/admin/config/config.go +++ b/system/admin/config/config.go @@ -1,3 +1,6 @@ +// Package config provides a content type to manage the Ponzu system's configuration +// settings for things such as its name, domain, HTTP(s) port, email, server defaults +// and backups. package config import ( diff --git a/system/admin/upload/upload.go b/system/admin/upload/upload.go index cab3bb7..1a594f8 100644 --- a/system/admin/upload/upload.go +++ b/system/admin/upload/upload.go @@ -1,3 +1,5 @@ +// Package upload provides a re-usable file upload and storage utility for Ponzu +// systems to handle multipart form data. package upload import ( diff --git a/system/admin/user/auth.go b/system/admin/user/auth.go index 76c4804..fd4242b 100644 --- a/system/admin/user/auth.go +++ b/system/admin/user/auth.go @@ -1,3 +1,5 @@ +// Package user contains the basic admin user creation and authentication code, +// specific to Ponzu systems. package user import ( diff --git a/system/api/server.go b/system/api/server.go index 209ddaa..a7bd056 100644 --- a/system/api/server.go +++ b/system/api/server.go @@ -1,3 +1,6 @@ +// Package api sets the various API handlers which provide an HTTP interface to +// Ponzu content, and include the types and interfaces to enable client-side +// interactivity with the system. package api import "net/http" diff --git a/system/auth.go b/system/auth.go index cf1adf2..8b12ab5 100644 --- a/system/auth.go +++ b/system/auth.go @@ -1,3 +1,6 @@ +// Package system contains a collection of packages that make up the internal +// Ponzu system, which handles addons, administration, the Admin server, the API +// server, analytics, databases, search, TLS, and various internal types. package system import ( diff --git a/system/db/init.go b/system/db/init.go index 3fc35f5..eb5f7ee 100644 --- a/system/db/init.go +++ b/system/db/init.go @@ -1,3 +1,6 @@ +// Package db contains all interfaces to the databases used by Ponzu, including +// exported functions to easily manage addons, users, indices, search, content, +// and configuration. package db import ( diff --git a/system/item/item.go b/system/item/item.go index 227cd26..caa6faa 100644 --- a/system/item/item.go +++ b/system/item/item.go @@ -1,3 +1,6 @@ +// Package item provides the default functionality to Ponzu's content/data types, +// how they interact with the API, and how to override or enhance their abilities +// using various interfaces. package item import ( diff --git a/system/search/search.go b/system/search/search.go index 6d538ed..0b058bf 100644 --- a/system/search/search.go +++ b/system/search/search.go @@ -1,6 +1,10 @@ +// Package search is a wrapper around the blevesearch/bleve search indexing and +// query package, and provides interfaces to extend Ponzu items with rich, full-text +// search capability. package search import ( + "encoding/json" "errors" "fmt" "os" @@ -9,8 +13,6 @@ import ( "github.com/ponzu-cms/ponzu/system/item" - "encoding/json" - "github.com/blevesearch/bleve" "github.com/blevesearch/bleve/mapping" ) diff --git a/system/tls/enable.go b/system/tls/enable.go index f2c65d5..a90f2d1 100644 --- a/system/tls/enable.go +++ b/system/tls/enable.go @@ -1,3 +1,6 @@ +// Package tls provides the functionality to Ponzu systems to encrypt HTTP traffic +// through the ability to generate self-signed certificates for local development +// and fetch/update production certificates from Let's Encrypt. package tls import ( |