remove help view, move project info to docs, make about view use settings

help: there was only a link to the rtd documentation (now directly linked from a "Documentation" navbar entry)
and some duplicate router configuration that was also shown (even with the correct values) when adding a host.

the help page html was not valid due to the values inserted into the router configuration help.

help/documentation policy: add static help to the docs, add dynamic help directly at the places (in the views) where needed
This commit is contained in:
Thomas Waldmann 2013-11-03 00:02:02 +01:00
parent c8d6c6605b
commit 2b0e70e59f
6 changed files with 45 additions and 23 deletions

View File

@ -1,11 +1,14 @@
About nsupdate.info About nsupdate.info
=================== ===================
http://nsupdate.info is a free dynamic dns service. https://nsupdate.info is a free dynamic dns service.
nsupdate.info is also the name of the software used to implement it. nsupdate.info is also the name of the software used to implement it.
If you like, you can use it to host the service on your own server. If you like, you can use it to host the service on your own server.
The software project lives at:
https://github.com/nsupdate-info/nsupdate.info
Features Features
======== ========

View File

@ -12,6 +12,7 @@ Welcome to nsupdate.info's documentation!
intro intro
user user
admin admin
project
standards standards
security security

31
docs/project.rst Normal file
View File

@ -0,0 +1,31 @@
==================================
The nsupdate.info software Project
==================================
History
=======
The initial version of the nsupdate.info software was developed in 48h in the DjangoDash 2013 contest by:
* `Arne Schauf <https://github.com/asmaps/>`_
* `Fabian Faessler <https://github.com/Samuirai/>`_
* `Thomas Waldmann <https://github.com/ThomasWaldmann/>`_
Project site
============
https://github.com/nsupdate-info/nsupdate.info
Contributing
============
Feedback is welcome.
If you find some issue, have some idea or some patch, please submit them via the issue tracker.
Or even better: if you use git, fork our repo, make your changes and submit a pull request.
For small fixes, you can even just edit the files on github (github will then fork, change and submit a pull request
automatically).

View File

@ -16,6 +16,7 @@ def add_settings(request):
context['WWW_HOST'] = settings.WWW_HOST context['WWW_HOST'] = settings.WWW_HOST
context['WWW_IPV4_HOST'] = settings.WWW_IPV4_HOST context['WWW_IPV4_HOST'] = settings.WWW_IPV4_HOST
context['WWW_IPV6_HOST'] = settings.WWW_IPV6_HOST context['WWW_IPV6_HOST'] = settings.WWW_IPV6_HOST
context['SERVICE_CONTACT'] = settings.SERVICE_CONTACT # about view
return context return context

View File

@ -2,20 +2,23 @@
{% load bootstrap %} {% load bootstrap %}
{% block content %} {% block content %}
<h1>About the nsupdate.info service</h1> <h1>About the {{ WWW_HOST }} service</h1>
<h2>What's this?</h2> <h2>What's this?</h2>
<p> <p>
nsupdate.info is a dynamic dns service. {{ WWW_HOST }} is a dynamic dns service.
</p> </p>
<p> <p>
You usually need it so your router (or other dyndns2-compatible You usually need it so your router (or other dyndns2-compatible
client) can update a hostname, so you don't need to know or find client) can update a hostname, so you don't need to know or find
out your current IP address. out your current IP address.
</p> </p>
<h2>Screenshots?</h2> <h2>Screenshots and Documentation?</h2>
<p> <p>
We made some We made some
<a href="{% url 'screenshots' %}">screenshots</a> <a href="{% url 'screenshots' %}">screenshots</a>
and
<a href="http://nsupdateinfo.readthedocs.org/"
title="Open docs in new window" target="_blank">Documentation</a>
for you so you can see what you get without having to create an account first. for you so you can see what you get without having to create an account first.
</p> </p>
<h2>Why another one?</h2> <h2>Why another one?</h2>
@ -49,27 +52,9 @@
This is a free service, there are no warranties. If it breaks, it breaks. This is a free service, there are no warranties. If it breaks, it breaks.
</p> </p>
<h1>About the nsupdate.info software project</h1>
<h2>Where does the project live?</h2>
The <a href="https://github.com/nsupdate-info/nsupdate.info">nsupdate.info project on GitHub</a>.
<h2>Found some issue or want to help?</h2>
<p>
Feedback and help is welcome. Please use github to file issues to the
issue tracker or contribute changes (either do a pull request [preferred]
or attach a patch to an issue).
</p>
<h2>Who developed the software?</h2>
<p>
<a href="https://github.com/asmaps/">Arne Schauf</a>,
<a href="https://github.com/Samuirai/">Fabian Faessler</a> and
<a href="https://github.com/ThomasWaldmann/">Thomas Waldmann</a>
developed the initial version of the nsupdate.info software in 48h in the DjangoDash 2013 contest.
</p>
<h1>Contact</h1> <h1>Contact</h1>
<p> <p>
info AT nsupdate DOT info {{ SERVICE_CONTACT }}
</p> </p>
{% endblock %} {% endblock %}

View File

@ -33,6 +33,7 @@ DATABASES = {
} }
BASEDOMAIN = 'nsupdate.info' BASEDOMAIN = 'nsupdate.info'
SERVICE_CONTACT = 'info AT nsupdate DOT info' # shown on "about" page
WWW_HOST = BASEDOMAIN WWW_HOST = BASEDOMAIN
WWW_IPV4_HOST = 'ipv4.' + BASEDOMAIN WWW_IPV4_HOST = 'ipv4.' + BASEDOMAIN
WWW_IPV6_HOST = 'ipv6.' + BASEDOMAIN WWW_IPV6_HOST = 'ipv6.' + BASEDOMAIN