=== added file 'Makefile' --- Makefile 1970-01-01 00:00:00 +0000 +++ Makefile 2014-01-16 11:16:25 +0000 @@ -0,0 +1,12 @@ +PORT ?= 8000 + +server: + - @python -m SimpleHTTPServer ${PORT} 2>/dev/null + +browser: + @xdg-open 'http://localhost:${PORT}/htmldocs/getting-started.html' + +lint: + @python tools/lint.py + +test: browser server === modified file 'htmldocs/contributing.html' --- htmldocs/contributing.html 2013-12-16 14:54:13 +0000 +++ htmldocs/contributing.html 2014-01-16 11:16:25 +0000 @@ -21,12 +21,6 @@ - - - - - -
@@ -118,11 +112,12 @@The documentation makes use of Javascript for some functionality, so in order to test the docs properly or serve them localy, you will need to have an http server set up.
-On Ubuntu this is easy. Install (if you need to) and start the apache2 web server, then just copy the htmnldocs directory to a convenient location -
-sudo cp -R htmldocs /var/www/htmldocs-
You can then point your web browser at your local machine (127.0.0.1/htmldocs) to view the files.
-Alternatively, you can use Python to start a simple HTTP server on the docs directory. Navigate to the htmldocs directory of juju-core docs and run the following:
-python -m SimpleHTTPServer+
You can enable a server by running
+make server+
From the root of the repository. In addition to make server
you can run:
make test+
Which will start the server and open your browser window to the newly created server. In the event you get a port conflict, you can override the port used by setting the PORT
env variable:
+
PORT=8080 make test
We love it when the community contributes to documentation, here's how to get the code, branch it, modify it, and submit it back. First off get the code: