Permalink
Browse files

package documentation for godoc

  • Loading branch information...
nilslice committed Apr 17, 2017
1 parent 1967bdc commit c7f017af059d7838ba9bc6d369bdedd43d45ea5b
View
@@ -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 (
View
@@ -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
@@ -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 (
@@ -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 (
@@ -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 (
@@ -1,3 +1,5 @@
// Package user contains the basic admin user creation and authentication code,
// specific to Ponzu systems.
package user
import (
View
@@ -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"
View
@@ -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 (
View
@@ -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 (
View
@@ -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 (
View
@@ -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"
)
View
@@ -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 (

0 comments on commit c7f017a

Please sign in to comment.