Skip to content

Pinax 18.01 Proposed Docs Outline

Jump to bottom
KatherineMichel edited this page Jan 12, 2020 · 1 revision

Pinax Documentation

NOTE: the documentation is available at http://pinaxproject.com/pinax/.

Pinax 18.01 Release

Repo docs are being converted to README and need to be made more consistent. We have discussed linking to docs throughout main docs. Need to resolve temporary references: TODO, "eventually", "under constructions", etc.

  • Home (Incomplete)
  • Introduction
    • What is Pinax?
    • Quick Start (Why 2 Quick Start sections? Some overlap in info)
    • Quick Start Manual
    • History (Incomplete, any info to add, such as timeline, popularity, number of downloads?)
    • FAQs (Want to expand to include answers to more of the "low-hanging fruit"/most often asked questions and how Pinax projects and apps work together)
  • Starter Projects (Demos?)
    • Pinax Starter Projects
    • List of Starter Projects (Each of these will "eventually")
    • Pinax Theme Boostrap (Change to Semantic instead)
  • Apps (Demos?)
    • List of Apps
  • How Tos (Other ones to add? How are How Tos different than "Tutorials"?)
    • LDAP Integration
    • Deploying to Heroku (Any deployment updates? Additional platforms to include?)
    • Releasing a Starter Project (This section coincides with "Release Process" section)
  • Development
    • How to Contribute
    • Ways to Contribute
    • Release Process (This section coincides with "Releasing a Starter Project" section; I personally think both Release sections should be together as Development and How/Ways to Contribute and CoC could be a Community Section, or all under Development)
    • Code of Conduct
  • Tutorials (Incomplete, would be great to take some popular info from blogs/screencasts, update and re-post or reference here, add additional resources? How are How Tutorials different than "How Tos"?)
    • Tutorials
  • In the Wild (Incomplete)
    • In the Wild
  • Companies Working with Pinax (Incomplete, add call to action?)
    • Companies Working with Pinax

Were these parts from the old outline properly explained, or opportunity to add now?

  • what Pinax is
    • starter projects, themes and apps
  • quick start
    • how to start a project with PPA
    • then add one more app
  • a page on each starter project
    • description
    • what starter project it’s built on
    • what apps it uses (and perhaps particularly showcases)
  • app maturity rating
  • a page on each app
    • description
    • maturity rating
    • what starter projects use it
    • what starter projects particularly showcases it
    • how to add it to a project
  • how to contribute
    • changes to projects or apps
    • new starter projects
    • new apps
    • suggested things to contribute
  • code conventions
  • tutorials, how tos
    • site projects: a series of apps put together to build a site
  • about these docs / colophon

Historical Info

  • what Pinax is
    • starter projects, themes and apps
  • quick start
    • how to start a project with PPA
    • then add one more app
  • some history
  • list of starter projects
  • list of apps
  • a page on each starter project
    • description
    • what starter project it’s built on
    • what apps it uses (and perhaps particularly showcases)
  • app maturity rating
  • a page on each app
    • description
    • maturity rating
    • what starter projects use it
    • what starter projects particularly showcases it
    • how to add it to a project
  • how to contribute
    • changes to projects or apps
    • new starter projects
    • new apps
    • suggested things to contribute
  • code conventions
  • release process
  • tutorials
    • site projects: a series of apps put together to build a site
    • HOWTO
      • how do I…?
  • FAQ
  • about these docs / colophon
Clone this wiki locally