mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-08-11 09:28:27 -04:00
Replace documentation link with links to clients
In research we found that developers orientate themselves around the API clients rather than the documentation. We should get them to the client documentation as quickly as possible. We currently link to the API documentation in three places: - API integration page - global footer - template ‘API info’ page For the first two this commit: - removes the link to the documentation - adds links to each of the 5 clients For the last one it just removes the link entirely.
This commit is contained in:
@@ -101,7 +101,15 @@
|
||||
<h2>Documentation</h2>
|
||||
<ul>
|
||||
<li><a href="{{ url_for("main.terms") }}">Terms of use</a></li>
|
||||
<li><a href="{{ url_for('main.documentation') }}">API documentation</a></li>
|
||||
{% for language, url in [
|
||||
('Java', 'https://github.com/alphagov/notifications-java-client'),
|
||||
('Node JS', 'https://github.com/alphagov/notifications-node-client'),
|
||||
('PHP', 'https://github.com/alphagov/notifications-php-client'),
|
||||
('Python', 'https://github.com/alphagov/notifications-python-client'),
|
||||
('Ruby', 'https://github.com/alphagov/notifications-ruby-client')
|
||||
] %}
|
||||
<li><a href="{{ url }}">{{ language }} client</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -58,11 +58,19 @@
|
||||
{{ api_key(current_service.id, "Service ID", thing="service ID") }}
|
||||
</div>
|
||||
|
||||
<h2 class="heading-small">Documentation</h2>
|
||||
<p>
|
||||
See the
|
||||
<a href="{{ url_for('.documentation') }}">
|
||||
API documentation</a> for clients and specfications.
|
||||
</p>
|
||||
<h2 class="heading-small">API clients</h2>
|
||||
<ul class="list list-bullet">
|
||||
{% for name, url in [
|
||||
('Java', 'https://github.com/alphagov/notifications-java-client'),
|
||||
('Node JS', 'https://github.com/alphagov/notifications-node-client'),
|
||||
('PHP', 'https://github.com/alphagov/notifications-php-client'),
|
||||
('Python', 'https://github.com/alphagov/notifications-python-client'),
|
||||
('Ruby', 'https://github.com/alphagov/notifications-ruby-client')
|
||||
] %}
|
||||
<li>
|
||||
<a href="{{ url }}">{{ name }}</a>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
|
||||
{% endblock %}
|
||||
|
||||
@@ -37,8 +37,4 @@
|
||||
{{ personalisation|syntax_highlight_json }}
|
||||
{% endif %}
|
||||
|
||||
<p>
|
||||
<br />See the <a href="{{ url_for(".documentation") }}">developer documentation</a> for full details.
|
||||
</p>
|
||||
|
||||
{% endblock %}
|
||||
|
||||
Reference in New Issue
Block a user