Merge pull request #309 from alphagov/move-documentation-page

Move documentation into footer, not behind login
This commit is contained in:
Chris Hill-Scott
2016-03-21 13:14:04 +00:00
6 changed files with 51 additions and 18 deletions

View File

@@ -88,3 +88,23 @@ td {
.heading-xlarge {
margin-bottom: 20px;
}
#footer {
.footer-categories {
@extend %site-width-container;
&-wrapper {
padding: 0 0 $gutter * 2;
margin: 0 0 $gutter;
border-bottom: 1px solid $border-colour;
}
h2 {
margin: 0 0 $gutter-two-thirds;
}
}
}

View File

@@ -6,10 +6,9 @@ from app import api_key_api_client
from app.utils import user_has_permissions
@main.route("/services/<service_id>/documentation")
@login_required
def documentation(service_id):
return render_template('views/documentation.html', service_id=service_id)
@main.route("/documentation")
def documentation():
return render_template('views/documentation.html')
@main.route("/services/<service_id>/api-keys")

View File

@@ -72,10 +72,31 @@
</div>
{% endblock %}
{% block footer_top %}
<div class="footer-categories">
<div class="footer-categories-wrapper">
<div class="grid-row">
<div class="column-one-third">
<h2>Contact</h2>
<ul>
<li><a href="https://docs.google.com/forms/d/1AL8U-xJX_HAFEiQiJszGQw0PcEaEUnYATSntEghNDGo/viewform">Support and feedback</a></li>
</ul>
</div>
<div class="column-one-third">
<h2>About</h2>
<a href="{{ url_for("main.help") }}">Help</a>
</div>
<div class="column-one-third">
<h2>Developers</h2>
<a href="{{ url_for('main.documentation') }}">API documentation</a>
</div>
</div>
</div>
</div>
{% endblock %}
{% block footer_support_links %}
<nav class="footer-nav">
<a href="{{ url_for("main.help") }}">Help</a>
<a href="https://docs.google.com/forms/d/1AL8U-xJX_HAFEiQiJszGQw0PcEaEUnYATSntEghNDGo/viewform">Support and feedback</a>
<a href="{{ url_for("main.cookies") }}">Cookies</a>
Built by the <a href="https://www.gov.uk/government/organisations/government-digital-service">Government Digital Service</a>
</nav>

View File

@@ -22,7 +22,6 @@
{% if current_user.has_permissions(['manage_api_keys', 'access_developer_docs']) %}
<ul>
<li><a href="{{ url_for('.api_keys', service_id=service_id) }}">API keys</a></li>
<li><a href="{{ url_for('.documentation', service_id=service_id) }}">Developer documentation</a></li>
</ul>
{% endif %}
<ul>

View File

@@ -1,15 +1,15 @@
{% extends "withnav_template.html" %}
{% extends "withoutnav_template.html" %}
{% from "components/page-footer.html" import page_footer %}
{% from "components/api-key.html" import api_key %}
{% block page_title %}
Developer documentation GOV.UK Notify
API documentation GOV.UK Notify
{% endblock %}
{% block maincolumn_content %}
<h1 class="heading-large">
Set up API integration
Developer documentation
</h1>
<div class="grid-row">
@@ -81,7 +81,7 @@
{{
"""
{
'to': '+441234123123',
'to': '+447700900404',
'template': 1
}
"""|syntax_highlight_json
@@ -164,10 +164,6 @@
https://api.notify.works
</p>
<p>
<a href="{{ url_for('.api_keys', service_id=service_id) }}">API keys for your service</a>
</p>
</div>
</div>