Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Unified Diff: docs/usage/test-server.md

Issue 29628724: Issue 5521 - Restructure CMS documentation to make it easier to use and extend (Closed) Base URL: https://hg.adblockplus.org/cms
Patch Set: Created Dec. 4, 2017, 9:59 a.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« docs/structure/static.md ('K') | « docs/usage/syncing-translations.md ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: docs/usage/test-server.md
===================================================================
new file mode 100644
--- /dev/null
+++ b/docs/usage/test-server.md
@@ -0,0 +1,28 @@
+# Running the test server #
+
+The test server will convert your content directory on the fly, your changes
+will become visible immediately. To run it you need:
+
+* Python 2.7
+* [Jinja2](http://jinja.pocoo.org/) and
+ [Markdown](https://pypi.python.org/pypi/Markdown) modules (can be installed by
+ running `easy_install Jinja2 Markdown` from the command line)
+* A current copy of the
+ [cms repository](https://github.com/adblockplus/cms/) (can be
+ [downloaded as ZIP file](https://github.com/adblockplus/cms/archive/master.zip)
+ or cloned via `git clone https://github.com/adblockplus/cms.git`)
+
+Optionally, the [Werkzeug](http://werkzeug.pocoo.org/) module can be installed
+as well, this will provide some developer features.
+
+Run the `runserver.py` script from your content directory, e.g.:
+
+ python ../cms/runserver.py
+
+Alternatively, the content directory could also be specified as command line
+parameter of `runserver.py`. This will start a local web server on port 5000,
+e.g. the page the page `pages/example.md` will be accessible under
+`http://localhost:5000/en/example`.
+
+Note that the test server is inefficient and shouldn't be run in production.
+There you should generate static files as explained below.
Vasily Kuznetsov 2017/12/12 15:35:25 I think it would be better to add a link to `gener
ire 2017/12/13 11:10:24 Good idea. Done.
« docs/structure/static.md ('K') | « docs/usage/syncing-translations.md ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld