Merge lp://staging/~notnownikki/ubuntu-friendly/uf-docs-and-makefile into lp://staging/ubuntu-friendly

Proposed by Nicola Heald
Status: Merged
Merged at revision: 141
Proposed branch: lp://staging/~notnownikki/ubuntu-friendly/uf-docs-and-makefile
Merge into: lp://staging/ubuntu-friendly
Diff against target: 971 lines (+811/-62)
17 files modified
.bzrignore (+29/-2)
Makefile (+106/-0)
README (+13/-0)
apps/local_settings.py.example (+18/-0)
apps/manage.py (+1/-1)
apps/minidetector/tests/__init__.py (+3/-0)
docs/Makefile (+153/-0)
docs/conf.py (+242/-0)
docs/contributing.rst (+15/-0)
docs/hacking.rst (+67/-0)
docs/hacking.txt (+0/-59)
docs/index.rst (+19/-0)
docs/installing.rst (+38/-0)
docs/running.rst (+59/-0)
docs/schema_changes.text (+1/-0)
docs/testing.rst (+33/-0)
requirements.txt (+14/-0)
To merge this branch: bzr merge lp://staging/~notnownikki/ubuntu-friendly/uf-docs-and-makefile
Reviewer Review Type Date Requested Status
Nicola Heald Pending
David Murphy Pending
Cody A.W. Somerville Pending
Review via email: mp+106199@code.staging.launchpad.net

This proposal supersedes a proposal from 2012-05-11.

Description of the change

Used HEXR as a template for the documentation and Makefile.

Couple of tweaks made to the Makefile, make settings will not obliterate an exsisting local_settings.py, and make clean will remove an existing local_settings.py

To post a comment you must log in.
Revision history for this message
David Murphy (schwuk) wrote : Posted in a previous version of this proposal

testing.rst refers to exr.

review: Needs Fixing
Revision history for this message
Cody A.W. Somerville (cody-somerville) wrote : Posted in a previous version of this proposal

1. The changes to .bzrignore are probably not helpful - it will quickly become incorrect/out of date as people add things with 'bzr ignore'.
2. You ignore docs/_build/*. What about docs/_static, docs/_templates? Are those produced in doc build process? If so, they should be ignored as well. Additionally, I suggest ignoring the directories too and not adding them to the bzr branch.
4. Instead of cding into docs/ to run makefile, use the --directory option.
5. You should not call make directly but instead use $(MAKE)
6. What's the change to 'apps/minidetector/tests/__init__.py' about?
7. The change to 'apps/settings.py' looks incorrect/inadvertent - you're assigning a value to DATABASE_USER after a value has already been assigned. Did you mean to do this or did you forget to remove the existing assignment to DATABASE_USER?
8. In docs/hacking.rst, I recommend using 'lp:ubuntu-friendly' to refer to trunk instead of 'lp:~ubuntu-friendly-control/ubuntu-friendly/trunk' as the former is less likely to become incorrect compared to the latter.

review: Needs Fixing
Revision history for this message
Nicola Heald (notnownikki) wrote : Posted in a previous version of this proposal

> 1. The changes to .bzrignore are probably not helpful - it will quickly become
> incorrect/out of date as people add things with 'bzr ignore'.

I guess to some people it's not helpful, but to new devs it will be. It's a good baseline at any rate.

> 2. You ignore docs/_build/*. What about docs/_static, docs/_templates? Are
> those produced in doc build process? If so, they should be ignored as well.

They're not produced by the build, they are for custom static assets and templates to go in if we want to change the look of the generated docs, so they're just there as placeholders until we want to do that.

> 4. Instead of cding into docs/ to run makefile, use the --directory option.
> 5. You should not call make directly but instead use $(MAKE)

Cool, will add those.

> 6. What's the change to 'apps/minidetector/tests/__init__.py' about?

Django 1.3 does more with the request during testing than Django 1.1, so the dummy request in the minidetector tests needed those attributes to pass under 1.3

> 7. The change to 'apps/settings.py' looks incorrect/inadvertent - you're
> assigning a value to DATABASE_USER after a value has already been assigned.
> Did you mean to do this or did you forget to remove the existing assignment to
> DATABASE_USER?

Well caught. Whoops!

> 8. In docs/hacking.rst, I recommend using 'lp:ubuntu-friendly' to refer to
> trunk instead of 'lp:~ubuntu-friendly-control/ubuntu-friendly/trunk' as the
> former is less likely to become incorrect compared to the latter.

Changed.

review: Needs Resubmitting
Revision history for this message
David Murphy (schwuk) wrote : Posted in a previous version of this proposal

testing.rst still refers to exr :)

review: Needs Fixing

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
The diff is not available at this time. You can reload the page or download it.

Subscribers

People subscribed via source and target branches