The following table gives you an overview on the folder structure in Pagekit.
+ - /app + - /packages + - /storage + - /tmp + - /tmp/cache + - /tmp/logs + - /tmp/packages + - /tmp/sessions + - /tmp/temp + + + | Folder | Description | |--------|-------------| | `/app` | Contains the Pagekit configuration, cache and user sessions. | diff --git a/getting-started/getting-help.md b/getting-started/getting-help.md new file mode 100644 index 0000000..dd315db --- /dev/null +++ b/getting-started/getting-help.md @@ -0,0 +1,11 @@ +# Getting Help + +## Gitter + +## Github Issues + +## Twitter + +## Google+ + +## Pagekit Blog diff --git a/quickstart.md b/getting-started/installation.md similarity index 62% rename from quickstart.md rename to getting-started/installation.md index f730946..d145988 100644 --- a/quickstart.md +++ b/getting-started/installation.md @@ -1,28 +1,22 @@ -# Quickstart +# InstallationThis document will guide you through Pagekit's installation process.
-Download Pagekit - -## Requirements - -Make sure your server meets the following requirements. +## Download -- Apache 2.2+ or nginx -- MySQL Server 5.1+ or SQLite 3 -- PHP Version 5.4+ - -In addition, Pagekit needs certain PHP extensions to be enabled. Check out the detailed list in the [server requirements section](troubleshooting.md). +Download Pagekit ## Installation Extract the downloaded archive and copy the contents to your webserver, either to web root directory or to a subfolder, for example called `/pagekit`. -Open your browser. If you have moved your files to the web root, navigate to your domain directly: `http://example.com`. If your files are located in a subfolder, navigate to that location, e.g. `http://example.com/pagekit`. +Open your browser. If you have moved your files to the web root, navigate to your domain directly: `http://example.com`. If your files are located in a subfolder, navigate to that location, e.g. `http://example.com/pagekit`. You should see the first screen of the web installer. -#### Step 1 - Database information +#### Step 1 - Language + +#### Step 2 - Database In the first step of the installation process we give Pagekit some information to connect to the database we created earlier. @@ -36,25 +30,12 @@ In the first step of the installation process we give Pagekit some information t **Note** Pagekit will try to create the database during installation. You can also do this yourself using a tool like [phpMyAdmin](http://http://www.phpmyadmin.net/). Feel free to use an existing database. Pagekit prefixes its tables to avoid conflicts. -#### Step 2 - Create a User +#### Step 3 - Create a User Now you need to create your user account for Pagekit. This user will have admin access and will be able to log in to Pagekit's control panel, once the installation is finished. -#### Step 3 - Site Settings +#### Step 4 - Site Settings Finally we enter the name of your site and a description. Once the installation was successful you can log in to Pagekit's control panel with the account we created. You can access the login screen by appending `/admin` to your URL. -## Updating - -Before you perform an update, make sure you have a backup of the current Pagekit installation and your database. That way you can always recover previous states of your installation in case something goes wrong. - -### 1-Click Update - -You can update Pagekit using the update function in Pagekit's Administration. Open *Settings > Update* and click the *Update* button. - -### Manual Update - -To update Pagekit manually, download the latest release from http://pagekit.com and extract the archive. -Now upload the folder to your webserver and overwrite the existing files in the Pagekit folder. - -To make sure that the update was successful, just open *Settings > Info*. If everything went smoothly, you should see the new version number under *Pagekit Version*. +## Installation from Github \ No newline at end of file diff --git a/getting-started/requirements.md b/getting-started/requirements.md new file mode 100644 index 0000000..4f5e7ad --- /dev/null +++ b/getting-started/requirements.md @@ -0,0 +1,30 @@ +# Requirements + +This document will guide you through Pagekit's installation process.
+ +## System requirements + +Make sure your server meets the following requirements. + +- Apache 2.2+ or nginx +- MySQL Server 5.1+ or SQLite 3 +- PHP Version 5.4+ + +## PHP extensions + +In addition, Pagekit needs certain PHP extensions to be enabled. + +- JSON extension +- Session extension +- ctype extension +- Tokenizer extension +- SimpleXML extension +- cURL extension +- mbstring extension +- PCRE extension (version 8.0+) +- ZIP extension +- PDO extension with MySQL- or SQLite drivers +- APCu extension (version 4.0.2+) + + +## Browser () \ No newline at end of file diff --git a/serverconfig.md b/getting-started/server-configuration.md similarity index 96% rename from serverconfig.md rename to getting-started/server-configuration.md index ceff6a2..f4c67f8 100644 --- a/serverconfig.md +++ b/getting-started/server-configuration.md @@ -4,7 +4,7 @@ ## Apache 2.2+ -With Apache, all necessary configuration comes with the included `.htaccess` file. +With Apache, all necessary configuration comes with the included `.htaccess` file. Make sure `mod_rewrite` is loaded for pretty URLs. If the module is not available, Pagekit will still work but fall back to a URL format of the form `http://example.com/index.php/page/welcome`. diff --git a/getting-started/updating.md b/getting-started/updating.md new file mode 100644 index 0000000..baf521d --- /dev/null +++ b/getting-started/updating.md @@ -0,0 +1,14 @@ +# Updating + +Before you perform an update, make sure you have a backup of the current Pagekit installation and your database. That way you can always recover previous states of your installation in case something goes wrong.
+ +## 1-Click Update + +You can update Pagekit using the update function in Pagekit's Administration. Open *Settings > Update* and click the *Update* button. + +## Manual Update + +To update Pagekit manually, download the latest release from http://pagekit.com and extract the archive. +Now upload the folder to your webserver and overwrite the existing files in the Pagekit folder. + +To make sure that the update was successful, just open *Settings > Info*. If everything went smoothly, you should see the new version number under *Pagekit Version*. diff --git a/razr-templating.md b/razr-templating.md deleted file mode 100644 index 97b10ca..0000000 --- a/razr-templating.md +++ /dev/null @@ -1,3 +0,0 @@ -# Razr Templating - -## Syntax \ No newline at end of file diff --git a/tools/command-line-tool.md b/tools/command-line-tool.md new file mode 100644 index 0000000..d6d6bda --- /dev/null +++ b/tools/command-line-tool.md @@ -0,0 +1,2 @@ +# Command Line Tool + diff --git a/tools/developer-toolbar.md b/tools/developer-toolbar.md new file mode 100644 index 0000000..9027521 --- /dev/null +++ b/tools/developer-toolbar.md @@ -0,0 +1,2 @@ +# Developer Toolbar + diff --git a/tools/webpack-grunt.md b/tools/webpack-grunt.md new file mode 100644 index 0000000..6b41641 --- /dev/null +++ b/tools/webpack-grunt.md @@ -0,0 +1 @@ +# Webpack & Grunt diff --git a/troubleshooting.md b/troubleshooting.md deleted file mode 100644 index 2acdff3..0000000 --- a/troubleshooting.md +++ /dev/null @@ -1,64 +0,0 @@ -# Troubleshooting - -If you run into problems with Pagekit, there are a few steps you should try.
- -## System requirements - -First, please check if your webserver meets the system requirements and if all needed PHP extensions are enabled. - -- Apache 2.2+ or nginx -- MySQL Server 5.1+ or SQLite 3 -- PHP Version 5.4+ - -### PHP extensions - -- JSON extension -- Session extension -- ctype extension -- Tokenizer extension -- SimpleXML extension -- cURL extension -- mbstring extension -- PCRE extension (version 8.0+) -- ZIP extension -- PDO extension with MySQL- or SQLite drivers -- APCu extension (version 4.0.2+) - -### Permissions - -The installer will check for correct permissions automatically. If you want to make sure yourself, refer to the following list. We recommend CHMOD *755*. Pagekit needs to be able to write to the following files and directories and each of their subdirectories: - -| File / Folder | Description | -|------------------|-------------| -| `/app` | Stores temporary, cache and log files. | -| `/extensions` | To install and update extensions. | -| `/storage` | Stores binary files you upload to your site. | -| `/themes` | To install and update themes. | -| `/vendor` | Third party libraries, managed by `composer`. | -| `config.php` | Installer will write to this file. | - -The actual permission settings depend on the user that the webserver is running with and the owner of the folders. If your webserver has problems with the CHMOD *755*, you can also try *775* and lastly *777* in this order. - -**Important** You should always avoid *777* permissions on your production webserver, since this will allow anyone who has access to the machine to edit the files. - -## Clear Cache - -If outdated data stored in the cache causes unexpected behavior, clearing the cache will fix these issues. There are several ways to clear the cache. - -| Method | Description | -|------|-------------| -| From the browser | Go to the *Settings* screen and click on the *Clear Cache* button. | -| From the command line | Open terminal and change to the Pagekit folder, then run `./pagekit clear-cache`. | -| From your file browser | To empty the cache folder manually, simply delete all files and subfolders located in `/app/cache`. | - -## System Information - -A lot of times when an error occurs, you will have to retrieve more information about the system environment Pagekit runs on. -Pagekit offers this information in the Control Panel, just go to *Settings > Info*. - -| Menu | Description | -|------|-------------| -| *System* | Shows the current Pagekit Version, the webserver it runs on and the browser you're using. | -| *PHP* | Shows information on the server's PHP version. | -| *Database* | Shows information on the database server version. | -| *Permissions* | Shows information on folder permissions. If it shows a directory that is not writable, you should correct this. | diff --git a/troubleshooting/internal-server-error.md b/troubleshooting/internal-server-error.md new file mode 100644 index 0000000..b240267 --- /dev/null +++ b/troubleshooting/internal-server-error.md @@ -0,0 +1,2 @@ +# Internal Server Error + diff --git a/troubleshooting/not-found.md b/troubleshooting/not-found.md new file mode 100644 index 0000000..8a7fe86 --- /dev/null +++ b/troubleshooting/not-found.md @@ -0,0 +1,2 @@ +# Not Found + diff --git a/troubleshooting/permissions.md b/troubleshooting/permissions.md new file mode 100644 index 0000000..b9cd7d1 --- /dev/null +++ b/troubleshooting/permissions.md @@ -0,0 +1,17 @@ +# Permissions + +The installer will check for correct permissions automatically. If you want to make sure yourself, refer to the following list. We recommend CHMOD *755*. Pagekit needs to be able to write to the following files and directories and each of their subdirectories: + +| File / Folder | Description | +|------------------|-------------| +| `/app` | Stores temporary, cache and log files. | +| `/extensions` | To install and update extensions. | +| `/storage` | Stores binary files you upload to your site. | +| `/themes` | To install and update themes. | +| `/vendor` | Third party libraries, managed by `composer`. | +| `config.php` | Installer will write to this file. | + +The actual permission settings depend on the user that the webserver is running with and the owner of the folders. If your webserver has problems with the CHMOD *755*, you can also try *775* and lastly *777* in this order. + +**Important** You should always avoid *777* permissions on your production webserver, since this will allow anyone who has access to the machine to edit the files. + diff --git a/troubleshooting/server-error.md b/troubleshooting/server-error.md new file mode 100644 index 0000000..cecebef --- /dev/null +++ b/troubleshooting/server-error.md @@ -0,0 +1,2 @@ +# Server Error + diff --git a/troubleshooting/system-information.md b/troubleshooting/system-information.md new file mode 100644 index 0000000..c691343 --- /dev/null +++ b/troubleshooting/system-information.md @@ -0,0 +1,14 @@ +# System Information + +If you run into problems with Pagekit, there are a few steps you should try.
+ +A lot of times when an error occurs, you will have to retrieve more information about the system environment Pagekit runs on. + +Pagekit offers this information in the Control Panel, just go to *Settings > Info*. + +| Menu | Description | +|------|-------------| +| *System* | Shows the current Pagekit Version, the webserver it runs on and the browser you're using. | +| *PHP* | Shows information on the server's PHP version. | +| *Database* | Shows information on the database server version. | +| *Permissions* | Shows information on folder permissions. If it shows a directory that is not writable, you should correct this. | \ No newline at end of file diff --git a/adding-content.md b/user-interface/adding-content.md similarity index 100% rename from adding-content.md rename to user-interface/adding-content.md diff --git a/images/dashboard.png b/user-interface/assets/dashboard.png similarity index 100% rename from images/dashboard.png rename to user-interface/assets/dashboard.png diff --git a/images/markdown-image-1.png b/user-interface/assets/markdown-image-1.png similarity index 100% rename from images/markdown-image-1.png rename to user-interface/assets/markdown-image-1.png diff --git a/images/markdown-image-2.png b/user-interface/assets/markdown-image-2.png similarity index 100% rename from images/markdown-image-2.png rename to user-interface/assets/markdown-image-2.png diff --git a/images/markdown-image-3.png b/user-interface/assets/markdown-image-3.png similarity index 100% rename from images/markdown-image-3.png rename to user-interface/assets/markdown-image-3.png diff --git a/images/markdown-link.png b/user-interface/assets/markdown-link.png similarity index 100% rename from images/markdown-link.png rename to user-interface/assets/markdown-link.png diff --git a/images/markdown.png b/user-interface/assets/markdown.png similarity index 100% rename from images/markdown.png rename to user-interface/assets/markdown.png diff --git a/images/menu-overview.png b/user-interface/assets/menu-overview.png similarity index 100% rename from images/menu-overview.png rename to user-interface/assets/menu-overview.png diff --git a/images/pages-edit.png b/user-interface/assets/pages-edit.png similarity index 100% rename from images/pages-edit.png rename to user-interface/assets/pages-edit.png diff --git a/images/pages-overview.png b/user-interface/assets/pages-overview.png similarity index 100% rename from images/pages-overview.png rename to user-interface/assets/pages-overview.png diff --git a/images/settings-overview.png b/user-interface/assets/settings-overview.png similarity index 100% rename from images/settings-overview.png rename to user-interface/assets/settings-overview.png diff --git a/images/users.png b/user-interface/assets/users.png similarity index 100% rename from images/users.png rename to user-interface/assets/users.png diff --git a/images/widgets-assignment.png b/user-interface/assets/widgets-assignment.png similarity index 100% rename from images/widgets-assignment.png rename to user-interface/assets/widgets-assignment.png diff --git a/images/widgets-edit.png b/user-interface/assets/widgets-edit.png similarity index 100% rename from images/widgets-edit.png rename to user-interface/assets/widgets-edit.png diff --git a/images/widgets-overview.png b/user-interface/assets/widgets-overview.png similarity index 100% rename from images/widgets-overview.png rename to user-interface/assets/widgets-overview.png diff --git a/images/widgets-rendered.png b/user-interface/assets/widgets-rendered.png similarity index 100% rename from images/widgets-rendered.png rename to user-interface/assets/widgets-rendered.png diff --git a/images/widgets-theme.png b/user-interface/assets/widgets-theme.png similarity index 100% rename from images/widgets-theme.png rename to user-interface/assets/widgets-theme.png diff --git a/ui-dashboard.md b/user-interface/dashboard.md similarity index 92% rename from ui-dashboard.md rename to user-interface/dashboard.md index 72b04dd..e283154 100644 --- a/ui-dashboard.md +++ b/user-interface/dashboard.md @@ -4,4 +4,4 @@ The Dashboard is the first thing you see when entering the Pagekit administratio It is up to you what information you want to have displayed here. To manage which widgets are being displayed and what order they appear in, go to *Settings > Dashboard*. - \ No newline at end of file + \ No newline at end of file diff --git a/ui-markdown-editor.md b/user-interface/markdown-editor.md similarity index 85% rename from ui-markdown-editor.md rename to user-interface/markdown-editor.md index ddff6ed..b25e8f4 100644 --- a/ui-markdown-editor.md +++ b/user-interface/markdown-editor.md @@ -2,7 +2,7 @@ Let's introduce you to the the main editing tool you will see in all places: Pagekit's powerful markdown editor. - + To edit content, you can write HTML with some autocompletion aid or use the popular [markdown syntax](http://daringfireball.net/projects/markdown/syntax). You can even include HTML snippets in markdown. As you create your content on the left, you will see a real-time preview of the final output on the right. To define how the content is rendered, you can enable or disable markdown in the settings above the editor. The editor's toolbar supports you with common markdown elements and allows you to choose text styles, insert links, quotes, lists and media elements. @@ -12,15 +12,15 @@ To insert an image, just click the image icon and a placeholder area will appear ### Step 1: Settings for a blank image - + ### Step 2: Select an image from the storage - + ### Step 3: Updated settings for your chosen image - + **Note** Adding videos or other binary files works just the same - and when you've inserted your files you can always go to the *Settings* dialog again. @@ -28,4 +28,4 @@ To insert an image, just click the image icon and a placeholder area will appear Links have a little pencil icon that you can click to call up the settings panel - either select the link's destination or manually enter a URL. - + diff --git a/ui-menus.md b/user-interface/menus.md similarity index 95% rename from ui-menus.md rename to user-interface/menus.md index f56566c..b5bbede 100644 --- a/ui-menus.md +++ b/user-interface/menus.md @@ -2,7 +2,7 @@ This is the place where you manage the site's menus. You can see an overview of all menus on the left and their pending items on the right. Hover over a single entry to see an edit and remove button for that menu. - + Items can be arranged quickly via drag-and drop. Click the green or red circle in the status column to enable or disable a menu item. diff --git a/ui-pages.md b/user-interface/pages.md similarity index 90% rename from ui-pages.md rename to user-interface/pages.md index 4ec68d3..f65414d 100644 --- a/ui-pages.md +++ b/user-interface/pages.md @@ -6,8 +6,8 @@ A slug is a computer friendly version of the title so that it can be included in By default, the page is *unpublished*. When you are done creating the content and saving the page, click the red *unpublished* label to publish the page. - + Page settings are available from the overview - or from the single page edit view. - + diff --git a/ui-settings.md b/user-interface/settings.md similarity index 97% rename from ui-settings.md rename to user-interface/settings.md index d0d7b0f..09cc5a3 100644 --- a/ui-settings.md +++ b/user-interface/settings.md @@ -2,7 +2,7 @@ Click on *Settings* in the main navigation to see all important settings in one place - split into *System settings* and *Extension settings*. - + ## System diff --git a/ui-users.md b/user-interface/users.md similarity index 98% rename from ui-users.md rename to user-interface/users.md index f01b5bd..eff8194 100644 --- a/ui-users.md +++ b/user-interface/users.md @@ -10,7 +10,7 @@ A user's profile contains a *Username* (used to login, limited to alphanumeric c The user's profile picture is displayed as a [Gravatar](https://gravatar.com/) depending on the given email address. - + ## Permissions diff --git a/ui-widgets.md b/user-interface/widgets.md similarity index 90% rename from ui-widgets.md rename to user-interface/widgets.md index 8935bd8..3545e22 100644 --- a/ui-widgets.md +++ b/user-interface/widgets.md @@ -4,7 +4,7 @@ Widgets are a way to render small chunks of content in areas defined by the them In the *Widgets* overview you see widgets sorted by the position they are published in. Note that only positions are displayed that have a widget published on at least one page - your theme might provide more positions than you can see. - + Use drag and drop to move an entry to another position or to change the rendering order inside a position which has several widgets. Toggle between enabled and published state by clicking the red or green circle on the *Status* column. @@ -13,12 +13,12 @@ Pagekit comes with the pre-defined widget types *Login*, *Menu* and *Text*, exte When editing a widget, you will have the *Settings* tab selected by default. Its content depends on the type of the widget. For a text widget you will have a content editing area, for a menu widget options to select a menu and so on. Every widget type has a set of options available on the right side where you can enable or disable the widget and assign it to a widget position in your theme. - + The *Assignment* tab allows you to choose which pages the widget will be rendered on. Alternatively you can use simple patterns to match URLs where you want to display the widget. You can insert one pattern per line. Use the "\*" character as a wildcard and exclude pages by prepending an exclamation mark to the path. Example paths: `blog` for the blog page, `blog/*` for blog entries or `!blog` if you want to exclude the blog. - + The *Theme* tab includes configuration settings for the widget's appearance. You can choose a panel style (like a box around the widget's content), add a badge and center the widget's content. Note that these settings are specific to your activated theme. - +