pinax-starter-projects
pinax-starter-projects copied to clipboard
Add branch for waiting-list starter project
part of #1
@jtauber Looks like this branch (waiting-list) has been created, perhaps this issue is complete?
@grahamu let me review what state it's in; it still may be a work in progress and not up-to-date
I think all that's left here is:
- [x] https://github.com/pinax/pinax-waitinglist/issues/2
- [ ] document how to change footer
- [ ] document how to change site title
- [ ] document how to change email address
THEME_CONTACT_EMAIL
- [ ] document how to change background image
- [ ] release project
I can tackle some of these points. I'm guessing starting a separate file, the same as last time?
Also, where will this located? Will I have to create a new how-to folder in pinax-starter-projects?
The documentation for changing footer, for changing site title and changing the contact email address are more generally applicable than this project so they should live elsewhere such as theme docs.
The waiting list project should have it's own doc page in pinax/pinax that links to those howtos plus provides the answer to the 'how to change background image'.
The doc page for the waiting list starter project can also explain how to use pinax-cli to start a new project.
So I think the general structure should be:
- what the project is for
- how to start a project using waiting list (mostly boilerplate for pinax-cli)
- the 4 howtos listed above (plus any more we think of later)
- a list of what apps this starter project demonstrates (in this case pinax-waitinglist)
we need to document pinax-waitinglist
and explain there how to set up surveys, etc.
Once that's done we should link to those howtos from the project doc page. But that shouldn't block this issue being closed.
@jtauber given the rest of the items in your list are documentation tasks that should occur outside of the starter project itself, should those issues be created on pinax/pinax
and pinax/pinax-theme-bootstrap
, tag the project for a release, and close this issue?
@paltman yes, I think that's a good idea
so one thing still to do here is upgrade the starter project to use latest waitinglist app. Perhaps we need to release a 1.0.0 of waitinglist app first.
Just noting here that @jtauber had idea to use pinax-referrals in pinax-waiting-list to link to non-users https://github.com/pinax/pinax/issues/72