Skip to content

Commit

Permalink
tweaking intro text in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jtauber committed Apr 13, 2015
1 parent 8051257 commit 0af1456
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
2 changes: 0 additions & 2 deletions docs/index.md
@@ -1,7 +1,5 @@
# Pinax Documentation

Pinax is an ecosystem of reusable Django apps, themes, and starter project templates.

@@@ We're just starting to provide overarching documentation for the whole of Pinax to better explain what it is and how to get going with it.

## Table of Contents
Expand Down
17 changes: 14 additions & 3 deletions docs/what_is_pinax.md
@@ -1,18 +1,29 @@
# What is Pinax?

Pinax is an ecosystem of reusable Django apps, themes, and starter project templates.
Pinax is an open source ecosystem of reusable Django apps, themes, and starter project templates.

It takes care of the things that many sites have in common so you can focus on what makes your site different.

Pinax provides:

* **standard project layout** for consistency and easy deployment
* **starter projects** that can be used as the basis for any Django website as well as some tailored to community sites, company sites, intranets and sites in closed beta
* **reusable apps** providing both back-end functionality and user-facing components
* **default templates** to enable quick prototyping

Pinax has been used for everything from social networks to conference websites, and from intranets to online games.

Because it's an entire ecosystem you can't just download Pinax and try it out, but there are starter projects you can do this with (see [Quick Start](quick_start.md)).

A starter project is a Django project template that comes with a bunch of apps already integrated with templates, etc.
A **starter project** is a Django project template that comes with a bunch of apps already integrated with templates, etc.

Some starter projects are intended to just lay a foundation for your site. For example the "account starter project" or `pinax-project-account`, gives you user signup (optionally closed), login, password change and reset, basic user preferences all with an easy-to-customize Bootstrap-based UI.

Hundreds of sites have been built on `pinax-project-account` even if they otherwise have nothing else in common or even use any other Pinax apps.

Some starter projects are more designed to be demos of how to use a particular reusable app or set of apps.

Yet other starter projects are designed to be out-of-the box, fully-functional sites ready to deploy (although we don't have many of these yet).
Yet other starter projects are designed to be out-of-the-box, fully-functional sites ready to deploy (although we don't have many of these yet).

After you've started your Django project with a Pinax starter project, it is quite common to add other apps from the Pinax ecosystem. But the apps in Pinax are just regular Django apps. Django apps don't have to be "Pinax" apps to be added to a Pinax starter project.

Expand Down

0 comments on commit 0af1456

Please sign in to comment.