From edd91578808d808646ca583dbd091220b5b7cb28 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 25 Oct 2010 19:20:22 -0400 Subject: convert remainder of docs to use pyramid instead of repoze.bfg --- docs/index.rst | 69 +++++++++++++++++++++++++++------------------------------- 1 file changed, 32 insertions(+), 37 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 5aa2e8b99..3b5d204cc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,14 +1,13 @@ .. _index: -======================================== -The repoze.bfg Web Application Framework -======================================== +================================================= +The pyramid Web Application Development Framework +================================================= -:mod:`repoze.bfg` is a small, fast, down-to-earth Python web -application framework. It is developed as part of the `Repoze -`_ project by `Agendaless Consulting -`_ and other contributors. It is licensed -under a `BSD-like license `_. +:mod:`pyramid` is a small, fast, down-to-earth Python web application +development framework. It is developed as part of the `Pylons +`_ project. It is licensed under a `BSD-like +license `_. Front Matter ============ @@ -19,21 +18,11 @@ Front Matter copyright.rst conventions.rst -"What's New" Documents -====================== - -.. toctree:: - :maxdepth: 2 - - whatsnew-1.3 - whatsnew-1.2 - whatsnew-1.1 - Narrative documentation ======================= Narrative documentation in chapter form explaining how to use -:mod:`repoze.bfg`. +:mod:`pyramid`. .. toctree:: :maxdepth: 2 @@ -69,15 +58,15 @@ Narrative documentation in chapter form explaining how to use Tutorials ========= -Detailed tutorials explaining how to use :mod:`repoze.bfg` to build -various types of applications and how to deploy :mod:`repoze.bfg` +Detailed tutorials explaining how to use :mod:`pyramid` to build +various types of applications and how to deploy :mod:`pyramid` applications to various platforms. .. toctree:: :maxdepth: 2 - tutorials/bfgwiki/index.rst - tutorials/bfgwiki2/index.rst + tutorials/wiki/index.rst + tutorials/wiki2/index.rst tutorials/cmf/index.rst tutorials/gae/index.rst tutorials/modwsgi/index.rst @@ -89,7 +78,7 @@ Reference Material ================== Reference material includes API documentation and documentation of -every :mod:`repoze.bfg` :term:`ZCML directive`. +every :mod:`pyramid` :term:`ZCML directive`. .. toctree:: :maxdepth: 2 @@ -116,6 +105,12 @@ Design Documentation Sample Applications =================== +.. warning:: + + These applications are for an older version of :mod:`pyramid`, + which was named :mod:`repoze.bfg`. We'll be updating them soon to + use :mod:`pyramid`. + `repoze.cluegun `_ is a simple pastebin application based on Rocky Burt's `ClueBin `_. It demonstrates form @@ -162,25 +157,25 @@ commenting, and file uploads. See the `KARL site Support and Development ======================= -The `BFG web site `_ is the main online source -of :mod:`repoze.bfg` support and development information. +The `Pyramid web site `_ is the main +online source of :mod:`pyramid` support and development information. -To report bugs, use the `bug tracker `_. +To report bugs, use the `issue tracker +`_. If you've got questions that aren't answered by this documentation, -contact the `Repoze-dev maillist -`_ or join the `#repoze -IRC channel `_. +contact the `Pylons-discuss maillist +`_ or join the `#pylons +IRC channel `_. -Browse and check out tagged and trunk versions of :mod:`repoze.bfg` -via the `Repoze Subversion repository -`_. To check out the trunk -via Subversion, use this command:: +Browse and check out tagged and trunk versions of :mod:`pyramid` via +the `Pyramid GitHub repository `_. +To check out the trunk via ``git``, use this command:: - svn co http://svn.repoze.org/repoze.bfg/trunk repoze.bfg + git clone git@github.com:Pylons/pyramid.git -To find out how to become a contributor to :mod:`repoze.bfg`, please -see the `contributor's page `_. +To find out how to become a contributor to :mod:`pyramid`, please see +the `contributor's page `_. Index and Glossary ================== -- cgit v1.2.3