Mercurial > piecrust2
changeset 631:01120d172802
docs: Add documentation about FoodTruck.
author | Ludovic Chabant <ludovic@chabant.com> |
---|---|
date | Mon, 08 Feb 2016 23:34:45 -0800 |
parents | b6a4f768cbb9 |
children | 9dd2f68f243b |
files | docs/docs/30_admin-panel-assets/commit.png docs/docs/30_admin-panel-assets/dashboard.png docs/docs/30_admin-panel-assets/edit.png docs/docs/30_admin-panel-assets/listsrc.png docs/docs/30_admin-panel-assets/publish.png docs/docs/30_admin-panel-assets/writenew.png docs/docs/30_admin-panel.md |
diffstat | 7 files changed, 77 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/docs/30_admin-panel.md Mon Feb 08 23:34:45 2016 -0800 @@ -0,0 +1,77 @@ +--- +title: Administration Panel +short_title: Admin Panel +--- + +Remember when we said there was no complex administration panel? Well, we kinda +lied. Only not really, since the one that comes with PieCrust is super simple +and, of course, completely optional. That's why we're only bringing it up here. + + + +To run the administration panel, type: + +``` +$ chef admin run + * Running on http://localhost:8090/ (Press CTRL+C to quit) + +``` + +Now copy paste the specified URL (`http://localhost:8090/`) into your favorite +browser's address bar and you should see "FoodTruck", PieCrust's administrative +panel. + +The navigation menu on the left should have: + +* The dashboard. +* One entry for each of your page sources. +* An interface to publish your website. + +## The Dashboard + +This is where you can see a summary of your website, with links to see your list +of already existing content. + +If your website content is also stored in a version control system, you can see +what's currently edited in the "_Work in Progress_" section. + +> Right now, FoodTruck only supports Mercurial for source control. + + +## Page Sources + +For each source, you can list the existing pages: + + + +Clicking on any link will let you edit that page. + +You can also create a new page by clicking the appropriate entry in the left +navigation menu. You'll have to fill up information similar to what you specify +to the `chef prepare` command: + + + +Once you created a page, or click a link for an existing one, you can edit the +page: + + + +Note that if your website is stored in a VCS, you'll have the ability to commit +the page file if you want, but using the dropdown on the "_Save_" button: + + + + +## Publishing + +You also have a UI for running your publish targets. The descriptions shown for +each target are taken from a `description` entry in their configuration +settings. + + + +Clicking any "_Execute_" button will publish your website using the +corresponding target. You'll see some notifications popup on the bottom right to +indicate the progress of the operation. +