Skip to content

Commit

Permalink
initial structure update
Browse files Browse the repository at this point in the history
  • Loading branch information
saschadube committed Sep 21, 2015
1 parent e97aa3d commit 4f50c39
Show file tree
Hide file tree
Showing 64 changed files with 201 additions and 152 deletions.
81 changes: 46 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,56 @@
Pagekit Documentation
=====================

This is the documentation for Pagekit, a modular and lightweight CMS built with
Symfony components.
This is the documentation for Pagekit, a modular and lightweight CMS built with modern technologies.

1. Getting Started
1. [Quickstart](quickstart.md)
2. [Folder Structure](folder-structure.md)
3. [Server configuration](serverconfig.md)
4. [Configuration File](configuration-file.md)
5. [Troubleshooting](troubleshooting.md)

1. [Requirements](getting-started/requirements.md)
2. [Installation](getting-started/installation.md)
3. [Updating](getting-started/updating.md)
4. [Configuration File](getting-started/configuration-file.md)
5. [Folder Structure](getting-started/folder-structure.md)
6. [Server Configuration](getting-started/server-configuration.md)
7. [Getting Help](getting-started/getting-help.md)

2. User Interface
1. [Dashboard](ui-dashboard.md)
2. [Markdown Editor](ui-markdown-editor.md)
3. [Pages](ui-pages.md)
4. [Widgets](ui-widgets.md)
5. [Menus](ui-menus.md)
6. [Users](ui-users.md)
7. [Settings](ui-settings.md)
1. [Dashboard](user-interface/dashboard.md)
2. [Markdown Editor](user-interface/markdown-editor.md)
3. [Pages](user-interface/pages.md)
4. [Widgets](user-interface/widgets.md)
5. [Menus](user-interface/menus.md)
6. [Users](user-interface/users.md)
7. [Settings](user-interface/settings.md)
8. [Adding Content](user-interface/adding-content.md)

3. Guides
1. [Create a theme](guide-theme.md)
2. [Create a translation](guide-translation.md)
3. Developer
1. [Introduction](developer/introduction.md)
2. [Themes](developer/themes.md)
3. [Extensions](developer/extensions.md)
4. [Widgets](developer/widgets.md)
5. [Configuration](developer/configuration.md)
6. [Marketplace](developer/marketplace.md)
7. [The Application](developer/application.md)
8. [Controller](developer/controller.md)
9. [View and Response](developer/view-response.md)
10. [Links](developer/links.md)
11. [Migrations](developer/migrations.md)
12. [Architecture and Events](developer/architecture-events.md)
13. [Translation](developer/translation.md)
14. [Option](developer/api-option.md)
15. [Database](developer/database.md)
16. [Users & Permissisons](developer/database.md)
17. [Create a theme](developer/guide-theme.md)
18. [Create a translation](developer/guide-translation.md)

4. Developer
1. [Introduction](introduction.md)
2. [Themes](themes.md)
3. [Extensions](extensions.md)
4. [Widgets](widgets.md)
5. [Configuration](configuration.md)
6. [Marketplace](marketplace.md)
7. [The Application](application.md)
8. [Controller](controller.md)
9. [View and Response](view-response.md)
10. [Links](links.md)
11. [Migrations](migrations.md)
12. [Architecture and Events](architecture-events.md)
13. [Translation](translation.md)
4. Tools
1. [Developer Toolbar](tools/developer-toolbar.md)
2. [Command Line Tool](tools/command-line-tool.md)
2. [Webpack & Grunt](tools/webpack-grunt.md)

5. Advanced
1. [Option](api-option.md)
2. [Database](database.md)
3. Razr Templating
5. Troubleshooting
1. [System Information](troubleshooting/system-information.md)
2. [Permissions](troubleshooting/permissions.md)
2. [Not Found](troubleshooting/not-found.md)
2. [Server Error](troubleshooting/server-error.md)
2. [Internal Server Error](troubleshooting/internal-server-error.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions guide-theme.md → developer/guide-theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ php pagekit theme:generate mytheme

To get started, create an empty folder `/themes/mytheme`. Create three empty files `theme.json` and `theme.php` and `templates/template.razr`. This is the minimal set of files needed for a theme, though we still need to add some content before the theme will be available in Pagekit's back end.

![Generated file structure](images/guide-theme-files-minimal.png)
![Generated file structure](assets/guide-theme-files-minimal.png)

| File | Needed? | Description |
|------------------------------|----------|--------------------|
Expand All @@ -30,7 +30,7 @@ To get started, create an empty folder `/themes/mytheme`. Create three empty fil

When working with themes, you will add more and more files. Even though we won't need all of them in this tutorial, have a look at the following structure to understand what the structure for a more complex theme will look like.

![Generated file structure](images/guide-theme-files.png)
![Generated file structure](assets/guide-theme-files.png)

| File | Needed? | Description |
|------------------------------|----------|--------------------|
Expand Down
6 changes: 3 additions & 3 deletions guide-translation.md → developer/guide-translation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ If you would like to improve or complete an existing localization, go to the [Pa

To take part in the Pagekit project, you must first click the *Join team* button that you can find in every language folder. Once we've approved your request, you will be able to access the language team and can start to translate the project.

![Join team](images/guide-translation-join.png)
![Join team](assets/guide-translation-join.png)

Choose the resource you want to contribute to by clicking on it, this will open an options screen. By clicking *Translate now* you will enter Transifex's editor which allows you to translate on the fly without having to down- and upload the files.

## Request a language

If your language is not listed, you can add a new language to the project. To do so, go to the [Pagekit project](http://www.transifex.com/organization/pagekit/) on Transifex and add a new language by clicking the button on the right side *Request language*. We will then get notified and can review and approve your added language.

![Request a language](images/guide-translation-request.png)
![Request a language](assets/guide-translation-request.png)

Following our approval, you will have two options:

Expand All @@ -38,4 +38,4 @@ In case you already created a .po language file, you can upload it easily by cli

A green bar in each column shows you the progress of each localization.

![Options](images/guide-translation-options.png)
![Options](assets/guide-translation-options.png)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions configuration-file.md → getting-started/configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@

Pagekit's configuration is stored in `config.php` in the Pagekit root folder. Here you will find the database credentials, debug, profiler and cache settings. You can configure the settings in Pagekit *Settings > System* or edit them in this config file.

## Database

## System

## Cache

## Finder

## Application

## Debug




## Database

The database connection settings are stored in `database['connections']`. Here you can find the connection data you have provided during the installation process:
Expand Down
12 changes: 12 additions & 0 deletions folder-structure.md → getting-started/folder-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

<p class="uk-article-lead">The following table gives you an overview on the folder structure in Pagekit.</p>

- /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. |
Expand Down
11 changes: 11 additions & 0 deletions getting-started/getting-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Getting Help

## Gitter

## Github Issues

## Twitter

## Google+

## Pagekit Blog
39 changes: 10 additions & 29 deletions quickstart.md → getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,22 @@
# Quickstart
# Installation

<p class="uk-article-lead">This document will guide you through Pagekit's installation process.</p>

<a class="uk-button uk-button-large uk-button-primary" href="http://pagekit.com">Download Pagekit</a>

## 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).
<a class="uk-button uk-button-large uk-button-primary" href="http://pagekit.com">Download Pagekit</a>

## 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.

Expand All @@ -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
30 changes: 30 additions & 0 deletions getting-started/requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Requirements

<p class="uk-article-lead">This document will guide you through Pagekit's installation process.</p>

## 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 ()
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
14 changes: 14 additions & 0 deletions getting-started/updating.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Updating

<p class="uk-article-lead">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.</p>

## 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*.
3 changes: 0 additions & 3 deletions razr-templating.md

This file was deleted.

2 changes: 2 additions & 0 deletions tools/command-line-tool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Command Line Tool

2 changes: 2 additions & 0 deletions tools/developer-toolbar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Developer Toolbar

1 change: 1 addition & 0 deletions tools/webpack-grunt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Webpack &amp; Grunt
64 changes: 0 additions & 64 deletions troubleshooting.md

This file was deleted.

2 changes: 2 additions & 0 deletions troubleshooting/internal-server-error.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Internal Server Error

2 changes: 2 additions & 0 deletions troubleshooting/not-found.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Not Found

Loading

0 comments on commit 4f50c39

Please sign in to comment.