Validate raw links

This commit is contained in:
cytopia 2018-07-25 08:56:45 +02:00
parent ed36d8b709
commit 0514c38e54
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
10 changed files with 57 additions and 18 deletions

View File

@ -187,6 +187,7 @@ script:
cd docs/;
make build;
make linkcheck;
make linkcheck2;
else
.tests/test_single.sh . "${S1}" "${V1}" "${S2}" "${V2}";
fi

View File

@ -48,6 +48,8 @@ help:
# warning and sphinx-build exits with exit status 1.
linkcheck2:
./linkcheck.sh
build:
sphinx-build -a -E -n -j auto -q -W . _build/html

View File

@ -1,35 +1,35 @@
.. |ext_lnk_docker_image_cockroach| raw:: html
<a target="_blank" href="https://hub.docker.com/r/cockroachdb/cockroach">
<a target="_blank" href="https://hub.docker.com/r/cockroachdb/cockroach/">
Cockroachc DB <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
</a>
.. |ext_lnk_docker_image_grafana| raw:: html
<a target="_blank" href="https://hub.docker.com/r/grafana/grafana">
<a target="_blank" href="https://hub.docker.com/r/grafana/grafana/">
Grafana <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
</a>
.. |ext_lnk_docker_image_postgres| raw:: html
<a target="_blank" href="https://hub.docker.com/_/postgres">
<a target="_blank" href="https://hub.docker.com/_/postgres/">
PostgreSQL <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
</a>
.. |ext_lnk_docker_image_redis| raw:: html
<a target="_blank" href="https://hub.docker.com/_/redis">
<a target="_blank" href="https://hub.docker.com/_/redis/">
Redis <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
</a>
.. |ext_lnk_docker_image_memcached| raw:: html
<a target="_blank" href="https://hub.docker.com/_/memcached">
<a target="_blank" href="https://hub.docker.com/_/memcached/">
Memcached <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
</a>
.. |ext_lnk_docker_image_mongodb| raw:: html
<a target="_blank" href="https://hub.docker.com/_/mongo">
<a target="_blank" href="https://hub.docker.com/_/mongo/">
MongoDB <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
</a>

View File

@ -78,6 +78,6 @@
.. |ext_lnk_example_zend_documentation| raw:: html
<a target="_blank" href="https://docs.zendframework.com/tutorials/getting-started/skeleton-application">
<a target="_blank" href="https://docs.zendframework.com/tutorials/getting-started/skeleton-application/">
Official Zend Documentation <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
</a>

View File

@ -6,6 +6,6 @@
.. |ext_lnk_ssl_blog_chrome_dev_hsts| raw:: html
<a target="_blank" href="https://ma.ttias.be/chrome-force-dev-domains-https-via-preloaded-hsts">
<a target="_blank" href="https://ma.ttias.be/chrome-force-dev-domains-https-via-preloaded-hsts/">
Chrome & Firefox now force .dev domains to HTTPS via preloaded HSTS <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
</a>

View File

@ -218,3 +218,15 @@
<a target="_blank" href="https://github.com/devilbox/vhost-gen">
vhost-gen <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
</a>
.. |ext_lnk_project_watcherd| raw:: html
<a target="_blank" href="https://github.com/devilbox/watcherd">
watcherd <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
</a>
.. |ext_lnk_project_watcherp| raw:: html
<a target="_blank" href="https://github.com/devilbox/watcherp">
watcherp <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
</a>

View File

@ -1,3 +1,5 @@
.. include:: /_includes/all.rst
.. _features:
********
@ -92,7 +94,7 @@ each Apache..., each Nginx... you get the idea.
Project specific configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Even down to projects, the Devilbox allows for full customization when it comes to virtual host
settings via `vhost-gen <https://github.com/devilbox/vhost-gen>`_.
settings via |ext_lnk_project_vhost_gen|.
Intranet
@ -105,10 +107,8 @@ port exposures, hostnames and any errors including how they can be resolved.
Third-party tools
^^^^^^^^^^^^^^^^^
Mandatory web projects are also shipped:
`phpMyAdmin <https://www.phpmyadmin.net>`_,
`Adminer <https://www.adminer.org>`_ and
`OpcacheGui <https://github.com/amnuts/opcache-gui>`_ as well as a web GUI to view all sent emails.
Mandatory web projects are also shipped: |ext_lnk_tool_phpmyadmin|, |ext_lnk_tool_adminer| and
|ext_lnk_tool_opcachegui| as well as a web GUI to view all sent emails.
Dockerized

20
docs/linkcheck.sh Executable file
View File

@ -0,0 +1,20 @@
#!/usr/bin/env bash
RETURN=0
for url in $(find _includes/ -name \*.rst -exec grep -Eo 'http(s)?://[-?:,._a/#-Z0-9]+' {} \; | sort -u ); do
header="$( curl -I "${url}" 2>/dev/null )"
line="$( echo "${header}" | grep -E '^HTTP/(1|2)' )"
stat="$( echo "${line}" | awk '{print $2}' )"
if [ "${stat}" != "200" ]; then
printf "\e[0;31m[ERR]\e[0m %s %s\n" "${url}" "${line}"
RETURN=1
else
printf "\e[0;32m[OK]\e[0m %s\n" "${url}"
fi
done
exit ${RETURN}

View File

@ -1,3 +1,5 @@
.. include:: /_includes/all.rst
.. _customize_specific_virtual_host:
*******************************
@ -26,9 +28,9 @@ listening ports.
If you intend to use ``vhost-gen`` for your own projects, have a look at its project page and
its sister projects:
* `vhost-gen <https://github.com/devilbox/vhost-gen>`_
* `watcherd <https://github.com/devilbox/watcherd>`_
* `watcherp <https://github.com/devilbox/watcherp>`_
* |ext_lnk_project_vhost_gen|
* |ext_lnk_project_watcherd|
* |ext_lnk_project_watcherp|
Where do I find templates

View File

@ -1,3 +1,5 @@
.. include:: /_includes/all.rst
.. _example_add_sub_domains:
************************
@ -53,8 +55,8 @@ When you want to have multiple domains and/or sub domains for one project (such
case of Wordpress multi-sites), you will need to customize your virtual host config for this
project and make the web server allow to serve your files by different server names.
Each web server virtual host is auto-generated by a tool called
`vhost-gen <https://github.com/devilbox/vhost-gen>`_. ``vhost-gen`` allows you to overwrite its
Each web server virtual host is auto-generated by a tool called |ext_lnk_project_vhost_gen|.
``vhost-gen`` allows you to overwrite its
default generation process via templates. Those templates can be added to each project, giving
you the option to customize the virtual host of this specific project.