# HG changeset patch # User Ludovic Chabant # Date 1455003285 28800 # Node ID 01120d172802ffc5f6ba567e6d4d629e741346e1 # Parent b6a4f768cbb947f3faf5839b6b639b2a7bfea490 docs: Add documentation about FoodTruck. diff -r b6a4f768cbb9 -r 01120d172802 docs/docs/30_admin-panel-assets/commit.png Binary file docs/docs/30_admin-panel-assets/commit.png has changed diff -r b6a4f768cbb9 -r 01120d172802 docs/docs/30_admin-panel-assets/dashboard.png Binary file docs/docs/30_admin-panel-assets/dashboard.png has changed diff -r b6a4f768cbb9 -r 01120d172802 docs/docs/30_admin-panel-assets/edit.png Binary file docs/docs/30_admin-panel-assets/edit.png has changed diff -r b6a4f768cbb9 -r 01120d172802 docs/docs/30_admin-panel-assets/listsrc.png Binary file docs/docs/30_admin-panel-assets/listsrc.png has changed diff -r b6a4f768cbb9 -r 01120d172802 docs/docs/30_admin-panel-assets/publish.png Binary file docs/docs/30_admin-panel-assets/publish.png has changed diff -r b6a4f768cbb9 -r 01120d172802 docs/docs/30_admin-panel-assets/writenew.png Binary file docs/docs/30_admin-panel-assets/writenew.png has changed diff -r b6a4f768cbb9 -r 01120d172802 docs/docs/30_admin-panel.md --- /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. + +![Administration Panel]({{assets.dashboard}}) + +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: + +![Page Sources]({{assets.listsrc}}) + +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: + +![New Page]({{assets.writenew}}) + +Once you created a page, or click a link for an existing one, you can edit the +page: + +![Edit Page]({{assets.edit}}) + +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: + +![Commit Page]({{assets.commit}}) + + +## 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. + +![Publish]({{assets.publish}}) + +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. +