Mercurial > piecrust2

annotate docs/docs/30_admin-panel.md @ 1096:2aa6174453c8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
tests: Better error reporting for serving tests.
author Ludovic Chabant <ludovic@chabant.com>
date Sat, 17 Feb 2018 11:51:06 -0800
parents 01120d172802
children 1dcebff866f1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
631
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
1 ---
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
2 title: Administration Panel
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
3 short_title: Admin Panel
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
4 ---
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
5
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
6 Remember when we said there was no complex administration panel? Well, we kinda
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
7 lied. Only not really, since the one that comes with PieCrust is super simple
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
8 and, of course, completely optional. That's why we're only bringing it up here.
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
9
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
10 ![Administration Panel]({{assets.dashboard}})
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
11
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
12 To run the administration panel, type:
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
13
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
14 ```
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
15 $ chef admin run
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
16 * Running on http://localhost:8090/ (Press CTRL+C to quit)
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
17
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
18 ```
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
19
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
20 Now copy paste the specified URL (`http://localhost:8090/`) into your favorite
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
21 browser's address bar and you should see "FoodTruck", PieCrust's administrative
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
22 panel.
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
23
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
24 The navigation menu on the left should have:
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
25
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
26 * The dashboard.
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
27 * One entry for each of your page sources.
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
28 * An interface to publish your website.
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
29
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
30 ## The Dashboard
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
31
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
32 This is where you can see a summary of your website, with links to see your list
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
33 of already existing content.
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
34
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
35 If your website content is also stored in a version control system, you can see
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
36 what's currently edited in the "_Work in Progress_" section.
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
37
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
38 > Right now, FoodTruck only supports Mercurial for source control.
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
39
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
40
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
41 ## Page Sources
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
42
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
43 For each source, you can list the existing pages:
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
44
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
45 ![Page Sources]({{assets.listsrc}})
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
46
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
47 Clicking on any link will let you edit that page.
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
48
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
49 You can also create a new page by clicking the appropriate entry in the left
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
50 navigation menu. You'll have to fill up information similar to what you specify
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
51 to the `chef prepare` command:
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
52
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
53 ![New Page]({{assets.writenew}})
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
54
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
55 Once you created a page, or click a link for an existing one, you can edit the
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
56 page:
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
57
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
58 ![Edit Page]({{assets.edit}})
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
59
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
60 Note that if your website is stored in a VCS, you'll have the ability to commit
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
61 the page file if you want, but using the dropdown on the "_Save_" button:
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
62
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
63 ![Commit Page]({{assets.commit}})
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
64
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
65
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
66 ## Publishing
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
67
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
68 You also have a UI for running your publish targets. The descriptions shown for
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
69 each target are taken from a `description` entry in their configuration
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
70 settings.
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
71
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
72 ![Publish]({{assets.publish}})
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
73
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
74 Clicking any "_Execute_" button will publish your website using the
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
75 corresponding target. You'll see some notifications popup on the bottom right to
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
76 indicate the progress of the operation.
01120d172802 docs: Add documentation about FoodTruck.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
77