158 Commits

Author SHA1 Message Date
Jim Campbell
fd5c35e54c docs: started refactoring of the deployment docs. several updates to make the configuration steps more explicit. 2013-05-13 01:04:42 -05:00
Christopher Allan Webber
fcfcd1f8a3 Merge remote-tracking branch 'refs/remotes/merge-requests/47' 2013-05-10 11:23:36 -05:00
Christopher Allan Webber
f65bf89836 Documenting plugin configuration
This commit sponsored by David Krupicz.  Thanks, David!
2013-05-08 11:03:09 -05:00
Elrond
b835e15319 Add warning about crypt/itsdangeroussecret.bin.
You should not leak that file, really.
2013-04-30 00:26:06 +02:00
Christopher Allan Webber
90e7fc6738 word-wrapping the public/queue storage explainations in storage.rst 2013-04-26 16:13:05 -05:00
Christopher Allan Webber
c4771d7247 Merge remote-tracking branch 'refs/remotes/npigeon/ticket-660' 2013-04-26 16:08:39 -05:00
Christopher Allan Webber
51d5d3aa20 changing the things to document in api.rst 2013-04-19 16:29:03 -05:00
Christopher Allan Webber
4d0191dcb8 A warning about the plugin API being unstable. 2013-04-19 13:22:03 -05:00
Christopher Allan Webber
3606316e9d ppoppler -> poppler tyop fix 2013-04-17 07:41:15 -05:00
Alon Levy
827f91e603 update documentation for s/nose/py.test/
Signed-off-by: Alon Levy <alon@pobox.com>
2013-04-17 12:55:57 +03:00
nattily pigeonfowl
a2d94b0cca Transfered information from http://wiki.mediagoblin.org/Storage into docs/source/devel/storage
For info check out ticket: issues.mediagoblin.org/ticket/660
2013-04-16 15:34:40 -04:00
Alon Levy
a80ebf3b64 add pdf media type
The new media type supports pdf and a subset of media recognized by libreoffice via
unoconv.

Every document added goes through:
* conversion to pdf with unoconv if not already a pdf
* creation of thumbnail and medium sized image, and pdfinfo generates
 some information (even for unoconv produces docs - should fix this)

Poppler (pdftocairo, pdfinfo) is used.  http://poppler.freedesktop.org/

A working but uglified pdf.js integration exists, which is enabled by
setting pdf.pdf_js=true mediagoblin_local.ini (disabled in mediagoblin.ini)

Adds one test to the test_submission test suite, and another separate test_pdf suite.
The tests are only run if media_types.pdf.processing.check_prerequisites passes, so
the test suite will not require any extra package.

TODO: make test suite say 'skipped' in that case instead of just 'ok'

Signed-off-by: Alon Levy <alon@pobox.com>
2013-04-15 09:51:21 +03:00
Christopher Allan Webber
36748921c2 adding callable_runone and callable_runall to the docs 2013-04-11 16:57:11 -05:00
Christopher Allan Webber
71ef20078c Adding some help about what to do if flup flakes out on you 2013-04-10 10:52:39 -05:00
Elrond
82a40cc4e1 Remove the last traces of beaker.
There were still some traces of beaker around:
- docs: replaced by reference to itsdangerous.
- paste configs: Wiped away.
- config_spec.ini: wiped.
- test_mgoblin_app.ini: also wiped.
2013-04-09 22:39:04 +02:00
Christopher Allan Webber
9430b957e4 Move description of software stack below description of "What's where" 2013-03-24 09:26:04 -05:00
Elrond
997ef97669 Improve release notes formatting.
The geolocation ini sample needed more indenting and
got a nice "code-block:: ini".
2013-03-19 18:52:14 +01:00
Christopher Allan Webber
d40bce8594 Point to the Hacking HOWTO 2013-03-18 08:50:29 -05:00
Christopher Allan Webber
6b92dca59d Better description of the structure of the application 2013-03-17 14:16:19 -05:00
Christopher Allan Webber
f6097b2eac Clarification on some original design decisions things. 2013-03-17 13:53:45 -05:00
Elrond
340100ee99 Start a storage section.
With the workbench stuff in it.
2013-03-12 18:16:16 +01:00
Christopher Allan Webber
fda5ea7aaa "will now" -> "will not" tyop caught by AVRS... fixed, thanks! 2013-03-12 11:49:39 -05:00
Christopher Allan Webber
70177c1feb You can also DELETE accounts now 2013-03-11 15:18:24 -05:00
Christopher Allan Webber
a28c6c4c48 Minor release note changes, as suggested by Elrond.
This commit sponsored by Martin Ansdell-Smith.  Thanks!
2013-03-11 13:35:59 -05:00
Christopher Allan Webber
6e2dcbffaf 0.3.3 release notes 2013-03-11 12:34:02 -05:00
Christopher Allan Webber
8da8449332 tyop fix in docs, lazyserer.sh->lazyserver.sh
This commit sponsored by S J Bennett.  Thanks!
2013-03-09 12:18:53 -06:00
Elrond
ed6a0bcd42 Change the _original_ design decisions.
- Rename the chapter to "Original *".
- Fix links.
2013-03-09 15:49:20 +01:00
Elrond
43a2f7fe79 Revive old "Design Decisions".
This brings back the exact version that was removed in
65e7ce634cfecc87ed6f390f9ccf91be513d2eea.
2013-03-09 15:49:20 +01:00
Joar Wandborg
f3f530286f Updated raven plugin
- Added wrap_wsgi, celery_setup, celery_logging_setup hooks
- Updated raven plugin docs
- Updated production considerations docs
- Added raven logging setup
2013-03-03 02:32:03 +01:00
Joar Wandborg
35f1f75922 Added raven plugin docs to docs 2013-03-03 00:46:05 +01:00
Christopher Allan Webber
a49c741f11 Removing stray character from pythonsnake's doc change and filling comment
This commit sponsored by Johannes Knabbe.  Thank you!
2013-02-24 16:38:01 -06:00
pythonsnake
37b48053e9 Fix bug 461 2013-02-24 16:38:01 -06:00
Elrond
cf41e7d744 Improve formatting for hook template docs. 2013-01-31 20:58:19 +01:00
Christopher Allan Webber
75621003af Added register_template_hooks and get_hook_templates to the plugin api
auto module documentation.
2013-01-30 13:27:40 -06:00
Joar Wandborg
f8107ccccc *docs* intersphinx, exception monitoring 2013-01-27 22:10:47 +01:00
Elrond
ae9f0aec38 Docs: Add a database guide to the plugin docs.
Plugin writers will often need to create new tables. So
give them some hints, what they need to do and where they
might find more info.
2013-01-26 19:38:52 +01:00
Elrond
3214c653dd Docs: Create new area for developers.
We need some "Part" for developers. Currently, it's named
"Part 4: Developer's Zone".  But we should come up with a
better name soon.

Moved the codebase docs in there for starters.
2013-01-26 19:20:18 +01:00
Elrond
b238a95464 Add Trim whitespace plugin docs.
Added the documentation (which was already present in
plugindocs/) to the TOC, so it's getting build and linked.
2013-01-26 13:03:54 +01:00
Elrond
92c597ca1c Allow doc string extraction and use for pluginapi.
Allow us to extract docstrings from our sources using the
sphinx.ext.autodoc module.

First use: Extract some of the docs for the pluginapi and
provide it in a new "Plugin API" section.
2013-01-26 00:15:57 +01:00
Joar Wandborg
3a8b18f85b Updated video apt-get to not use glob
Also changed some literal blocks to code-blocks
2013-01-25 21:43:49 +01:00
Sebastian Spaeth
b0c8328e54 Move db.sql.models* to db.models* 2013-01-07 11:44:29 +01:00
Sebastian Spaeth
511d5b8966 Revert accidental checkin
Commit 8d19cb2445e2aa1f53431da26d866bf9b5e25872 accidentally included
my docs/source/build directory. Removing it again. Thanks to Elrond for
noticing.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-12-22 12:05:03 +01:00
Sebastian Spaeth
8d19cb2445 Don't require webob as dependency
It is pushing up the daisies. Also relnote the change.
2012-12-21 08:24:28 +01:00
Sebastian Spaeth
53f528cfea purge webob from docs and replace with werkzeug 2012-12-21 08:10:48 +01:00
Mike Linksvayer
42ce372e38 actual upgrade instructions 2012-12-20 12:52:31 -08:00
Christopher Allan Webber
5c99cd01a7 Fixing tyop'ed "dbupdate" 2012-12-20 13:54:03 -06:00
Christopher Allan Webber
1f01df1dfc 0.3.2 release notes 2012-12-20 09:48:47 -06:00
Christopher Allan Webber
3fe3b2229c Docs fix: Adding proper blank line after the "Run::" 2012-12-20 08:23:03 -06:00
Christopher Allan Webber
5ef7ab084f Added documentation on how to add STL support, and notes on running ./bin/gmg dbupdate 2012-12-20 08:18:56 -06:00
Sebastian Spaeth
cacb6feae4 Release note 0.3.2 blurb
On MongoDB...
2012-12-15 21:00:41 +01:00