summaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/CLI/General-Usage.md10
-rw-r--r--docs/src/CLI/Generating-References.md4
-rw-r--r--docs/src/Content/An-Overview.md4
-rw-r--r--docs/src/HTTP-APIs/Search.md6
-rw-r--r--docs/src/Interfaces/API.md8
-rw-r--r--docs/src/Interfaces/Editor.md4
-rw-r--r--docs/src/Interfaces/Format.md2
-rw-r--r--docs/src/Interfaces/Item.md14
-rw-r--r--docs/src/Interfaces/Search.md2
-rw-r--r--docs/src/Quickstart/Overview.md2
-rw-r--r--docs/src/Running-Backups/Backups.md2
-rw-r--r--docs/src/System-Deployment/Docker.md2
-rw-r--r--docs/src/index.md2
13 files changed, 31 insertions, 31 deletions
diff --git a/docs/src/CLI/General-Usage.md b/docs/src/CLI/General-Usage.md
index 993ff18..b6827fc 100644
--- a/docs/src/CLI/General-Usage.md
+++ b/docs/src/CLI/General-Usage.md
@@ -12,7 +12,7 @@ Creates a project directory of the name supplied as a parameter immediately
following the 'new' option in the $GOPATH/src directory. Note: 'new' depends on
the program 'git' and possibly a network connection. If there is no local
repository to clone from at the local machine's $GOPATH, 'new' will attempt to
-clone the 'github.com/ponzu-cms/ponzu' package from over the network.
+clone the 'github.com/haturatu/ponzu' package from over the network.
Example:
```bash
@@ -159,7 +159,7 @@ to run the Admin and API on separate processes, you must call them with the
Will backup your own custom project code (like content, addons, uploads, etc) so
we can safely re-clone Ponzu from the latest version you have or from the network
if necessary. Before running `$ ponzu upgrade`, you should update the `ponzu`
-package by running `$ go get -u github.com/ponzu-cms/ponzu/...`
+package by running `$ go get -u github.com/haturatu/ponzu/...`
Example:
```bash
@@ -217,11 +217,11 @@ Ponzu v0.9.2
_A typical contribution workflow might look like:_
```bash
# clone the repository and checkout ponzu-dev
-$ git clone https://github.com/ponzu-cms/ponzu path/to/local/ponzu # (or your fork)
+$ git clone https://github.com/haturatu/ponzu path/to/local/ponzu # (or your fork)
$ git checkout ponzu-dev
# install ponzu with go get or from your own local path
-$ go get github.com/ponzu-cms/ponzu/...
+$ go get github.com/haturatu/ponzu/...
# or
$ cd /path/to/local/ponzu
$ go install ./...
@@ -239,7 +239,7 @@ $ ponzu build && ponzu run
# push to your origin:ponzu-dev branch and create a PR at ponzu-cms/ponzu
$ git push origin ponzu-dev
-# ... go to https://github.com/ponzu-cms/ponzu and create a PR
+# ... go to https://github.com/haturatu/ponzu and create a PR
```
**Note:** if you intend to work on your own fork and contribute from it, you will
diff --git a/docs/src/CLI/Generating-References.md b/docs/src/CLI/Generating-References.md
index 77cd16a..0bcc24c 100644
--- a/docs/src/CLI/Generating-References.md
+++ b/docs/src/CLI/Generating-References.md
@@ -70,8 +70,8 @@ import (
"github.com/bosssauce/reference"
- "github.com/ponzu-cms/ponzu/management/editor"
- "github.com/ponzu-cms/ponzu/system/item"
+ "github.com/haturatu/ponzu/management/editor"
+ "github.com/haturatu/ponzu/system/item"
)
type Catalog struct {
diff --git a/docs/src/Content/An-Overview.md b/docs/src/Content/An-Overview.md
index 1e9d53e..445c5ef 100644
--- a/docs/src/Content/An-Overview.md
+++ b/docs/src/Content/An-Overview.md
@@ -20,8 +20,8 @@ package content
import (
"fmt"
- "github.com/ponzu-cms/ponzu/management/editor"
- "github.com/ponzu-cms/ponzu/system/item"
+ "github.com/haturatu/ponzu/management/editor"
+ "github.com/haturatu/ponzu/system/item"
)
type Post struct {
diff --git a/docs/src/HTTP-APIs/Search.md b/docs/src/HTTP-APIs/Search.md
index 2939cce..e1ec728 100644
--- a/docs/src/HTTP-APIs/Search.md
+++ b/docs/src/HTTP-APIs/Search.md
@@ -26,9 +26,9 @@ which handles the indexing and querying.
- Search results are formatted exactly the same as standard Content API calls, so you don't need to change your client data model
- Search handler will respect other interface implementations on your content, including:
- - [`item.Hideable`](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Hideable)
- - [`item.Omittable`](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Omittable)
- - [`item.Pushable`](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Pushable) _(Note: only the first search result will be pushed)_
+ - [`item.Hideable`](https://godoc.org/github.com/haturatu/ponzu/system/item#Hideable)
+ - [`item.Omittable`](https://godoc.org/github.com/haturatu/ponzu/system/item#Omittable)
+ - [`item.Pushable`](https://godoc.org/github.com/haturatu/ponzu/system/item#Pushable) _(Note: only the first search result will be pushed)_
##### Sample Response
```javascript
diff --git a/docs/src/Interfaces/API.md b/docs/src/Interfaces/API.md
index 1d9ab82..c2ff055 100644
--- a/docs/src/Interfaces/API.md
+++ b/docs/src/Interfaces/API.md
@@ -13,7 +13,7 @@ life-cycle.
## Interfaces
-### [api.Createable](https://godoc.org/github.com/ponzu-cms/ponzu/system/api#Createable)
+### [api.Createable](https://godoc.org/github.com/haturatu/ponzu/system/api#Createable)
Externalable enables 3rd-party clients (outside the CMS) to send content via a
`multipart/form-data` encoded `POST` request to a specific endpoint:
`/api/content/create?type=<Type>`. When `api.Createable` is implemented, content
@@ -42,7 +42,7 @@ func (p *Post) Create(res http.ResponseWriter, req *http.Request) error {
---
-### [api.Updateable](https://godoc.org/github.com/ponzu-cms/ponzu/system/api#Updateable)
+### [api.Updateable](https://godoc.org/github.com/haturatu/ponzu/system/api#Updateable)
Updateable enables 3rd-party clients (outside the CMS) to update existing content
via a `multipart/form-data` encoded `POST` request to a specific endpoint:
`/api/content/update?type=<Type>&id=<id>`. Request validation should be employed
@@ -65,7 +65,7 @@ func (p *Post) Update(res http.ResponseWriter, req *http.Request) error {
---
-### [api.Deleteable](https://godoc.org/github.com/ponzu-cms/ponzu/system/api#Deleteable)
+### [api.Deleteable](https://godoc.org/github.com/haturatu/ponzu/system/api#Deleteable)
Updateable enables 3rd-party clients (outside the CMS) to delete existing content
via a `multipart/form-data` encoded `POST` request to a specific endpoint:
`/api/content/delete?type=<Type>&id=<id>`. Request validation should be employed
@@ -88,7 +88,7 @@ func (p *Post) Delete(res http.ResponseWriter, req *http.Request) error {
---
-### [api.Trustable](https://godoc.org/github.com/ponzu-cms/ponzu/system/api#Trustable)
+### [api.Trustable](https://godoc.org/github.com/haturatu/ponzu/system/api#Trustable)
Trustable provides a way for submitted content (via `api.Createable`) to bypass
the `editor.Mergeable` step in which CMS end-users must manually click the
"Approve" button in order for content to be put in the "Public" section and access
diff --git a/docs/src/Interfaces/Editor.md b/docs/src/Interfaces/Editor.md
index 63d3ceb..d1abf01 100644
--- a/docs/src/Interfaces/Editor.md
+++ b/docs/src/Interfaces/Editor.md
@@ -8,7 +8,7 @@ within the CMS.
## Interfaces
-### [editor.Editable](https://godoc.org/github.com/ponzu-cms/ponzu/management/editor#Editable)
+### [editor.Editable](https://godoc.org/github.com/haturatu/ponzu/management/editor#Editable)
Editable determines what `[]bytes` are rendered inside the editor page. Use
Edtiable on anything inside your CMS that you want to provide configuration, editable
@@ -51,7 +51,7 @@ func (p *Post) MarshalEditor() ([]byte, error) {
---
-### [editor.Mergeable](https://godoc.org/github.com/ponzu-cms/ponzu/management/editor#Mergeable)
+### [editor.Mergeable](https://godoc.org/github.com/haturatu/ponzu/management/editor#Mergeable)
Mergable enables a CMS end-user to merge the "Pending" content from an outside source into the "Public" section, and thus making it visible via the public content API. It also allows the end-user to reject content. "Approve" and "Reject" buttons will be visible on the edit page for content submitted.
diff --git a/docs/src/Interfaces/Format.md b/docs/src/Interfaces/Format.md
index 8a259d3..ad483a9 100644
--- a/docs/src/Interfaces/Format.md
+++ b/docs/src/Interfaces/Format.md
@@ -8,7 +8,7 @@ the Admin interface.
## Interfaces
-### [format.CSVFormattable](https://godoc.org/github.com/ponzu-cms/ponzu/management/format#CSVFormattable)
+### [format.CSVFormattable](https://godoc.org/github.com/haturatu/ponzu/management/format#CSVFormattable)
CSVFormattable controls if an "Export" button is added to the contents view for
a Content type in the CMS to export the data to CSV. If it is implemented, a
diff --git a/docs/src/Interfaces/Item.md b/docs/src/Interfaces/Item.md
index 9f805b8..454322d 100644
--- a/docs/src/Interfaces/Item.md
+++ b/docs/src/Interfaces/Item.md
@@ -8,7 +8,7 @@ components inside and outside of Ponzu.
## Interfaces
-### [item.Pushable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Pushable)
+### [item.Pushable](https://godoc.org/github.com/haturatu/ponzu/system/item#Pushable)
Pushable, if [HTTP/2 Server Push](https://http2.github.io/http2-spec/#PushResources)
is supported by the client, can tell a handler which resources it would like to
have "pushed" preemptively to the client. This saves follow-on roundtrip requests
@@ -48,7 +48,7 @@ func (p *Post) Push(res http.ResponseWriter, req *http.Request) ([]string, error
---
-### [item.Hideable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Hideable)
+### [item.Hideable](https://godoc.org/github.com/haturatu/ponzu/system/item#Hideable)
Hideable tells an API handler that data of this type shouldn’t be exposed outside
the system. Hideable types cannot be used as references (relations in Content types).
The `Hide` method, the only method in Hideable, takes an `http.ResponseWriter, *http.Request`
@@ -72,7 +72,7 @@ func (p *Post) Hide(res http.ResponseWriter, req *http.Request) error {
---
-### [item.Omittable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Omittable)
+### [item.Omittable](https://godoc.org/github.com/haturatu/ponzu/system/item#Omittable)
Omittable tells a content API handler to keep certain fields from being exposed
through the JSON response. It's single method, `Omit` takes no arguments and
returns a `[]string` which must be made up of the JSON struct tags for the type
@@ -105,7 +105,7 @@ func (p *Post) Omit(res http.ResponseWriter, req *http.Request) ([]string, error
---
-### [item.Hookable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Hookable)
+### [item.Hookable](https://godoc.org/github.com/haturatu/ponzu/system/item#Hookable)
Hookable provides lifecycle hooks into the http handlers which manage Save, Delete,
Approve, Reject routines, and API response routines. All methods in its set take an
`http.ResponseWriter, *http.Request` and return an `error`. Hooks which relate to the API response, additionally take data of type `[]byte`, and may provide a return of the same type.
@@ -441,7 +441,7 @@ Hookable is implemented by Item by default as no-ops which are expected to be ov
---
-### [item.Identifiable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Identifiable)
+### [item.Identifiable](https://godoc.org/github.com/haturatu/ponzu/system/item#Identifiable)
Identifiable enables a struct to have its ID set/get. Typically this is done to set an ID to -1 indicating it is new for DB inserts, since by default a newly initialized struct would have an ID of 0, the int zero-value, and BoltDB's starting key per bucket is 0, thus overwriting the first record.
Most notable, Identifiable’s `String` method is used to set a meaningful display name for an Item. `String` is called by default in the Admin dashboard to show the Items of certain types, and in the default creation of an Item’s slug.
Identifiable is implemented by Item by default.
@@ -481,7 +481,7 @@ func (i Item) String() string {
```
---
-### [item.Sluggable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Sluggable)
+### [item.Sluggable](https://godoc.org/github.com/haturatu/ponzu/system/item#Sluggable)
Sluggable makes a struct locatable by URL with it's own path. As an Item implementing Sluggable, slugs may overlap. If this is an issue, make your content struct (or one which embeds Item) implement Sluggable and it will override the slug created by Item's `SetSlug` method with your own.
It is not recommended to override `SetSlug`, but rather the `String` method on your content struct, which will have a similar, more predictable effect.
Sluggable is implemented by Item by default.
@@ -514,7 +514,7 @@ func (i *Item) ItemSlug() string {
---
-### [item.Sortable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Sortable)
+### [item.Sortable](https://godoc.org/github.com/haturatu/ponzu/system/item#Sortable)
Sortable enables items to be sorted by time, as per the sort.Interface interface. Sortable is implemented by Item by default.
##### Method Set
diff --git a/docs/src/Interfaces/Search.md b/docs/src/Interfaces/Search.md
index a7cd0d1..ca309eb 100644
--- a/docs/src/Interfaces/Search.md
+++ b/docs/src/Interfaces/Search.md
@@ -4,7 +4,7 @@ Ponzu provides a set of interfaces from the `system/search` package to enable an
## Interfaces
-### [search.Searchable](https://godoc.org/github.com/ponzu-cms/ponzu/system/search#Searchable)
+### [search.Searchable](https://godoc.org/github.com/haturatu/ponzu/system/search#Searchable)
Searchable determines how content is indexed and whether the system should index the content when it is created and updated or be removed from the index when content is deleted.
!!! warning ""
diff --git a/docs/src/Quickstart/Overview.md b/docs/src/Quickstart/Overview.md
index 329a0f7..5a40714 100644
--- a/docs/src/Quickstart/Overview.md
+++ b/docs/src/Quickstart/Overview.md
@@ -3,7 +3,7 @@
2) Install Ponzu CLI:
```bash
-$ go get github.com/ponzu-cms/ponzu/…
+$ go get github.com/haturatu/ponzu/…
```
3) Create a new project (path is created in your GOPATH):
diff --git a/docs/src/Running-Backups/Backups.md b/docs/src/Running-Backups/Backups.md
index fde0cab..c2a6989 100644
--- a/docs/src/Running-Backups/Backups.md
+++ b/docs/src/Running-Backups/Backups.md
@@ -5,7 +5,7 @@ Both the databases `system.db` & `analytics.db`, and the `/uploads` directory ca
All backups are made using a `GET` request to the `/admin/backup` path with a query parameter of `?source={system,analytics,uploads}` (only one source can be included in the URL).
Here are some full backup scripts to use or modify to fit your needs:
-[https://github.com/ponzu-cms/backup-scripts](https://github.com/ponzu-cms/backup-scripts)
+[https://github.com/haturatu/backup-scripts](https://github.com/haturatu/backup-scripts)
## System & Analytics
The `system.db` & `analytics.db` data files are sent uncompressed in their original form as they exist on your server. No temporary copy is stored on the origin server, and it is possible that the backup could fail so checking for successful backups is recommended. See https://github.com/boltdb/bolt#database-backups for more information about how BoltDB handles HTTP backups.
diff --git a/docs/src/System-Deployment/Docker.md b/docs/src/System-Deployment/Docker.md
index a998a38..a5e1beb 100644
--- a/docs/src/System-Deployment/Docker.md
+++ b/docs/src/System-Deployment/Docker.md
@@ -24,7 +24,7 @@ docker build -t ponzu-dev
#### Start the image, share the local directory and pseudo terminal (tty) into for debugging:
```bash
-docker run -v $(pwd):/go/src/github.com/ponzu-cms/ponzu -it ponzu-dev
+docker run -v $(pwd):/go/src/github.com/haturatu/ponzu -it ponzu-dev
pwd # will output the go src directory for ponzu
ponzu version # will output the ponzu version
# make an edit on your local and rebuild
diff --git a/docs/src/index.md b/docs/src/index.md
index bdf2ddf..74c2986 100644
--- a/docs/src/index.md
+++ b/docs/src/index.md
@@ -35,7 +35,7 @@ Want to jump in right away? Try the [Quickstart](/Quickstart/Overview)
### Need help? Get in touch
- Chat: [#ponzu on Slack](https://gophers.slack.com/messages/C3TBV356D)
- Reach out on Twitter: [@ponzu_cms](https://twitter.com/ponzu_cms)
-- File an [issue](https://github.com/ponzu-cms/ponzu/issues)
+- File an [issue](https://github.com/haturatu/ponzu/issues)
---
current version: `v0.9.4` @ ponzu:master