xx references into the doc - Githubissues

tango-controls / tango-doc

The official documentation for Tango controls

http://tango-controls.readthedocs.io

8 stars 27 forks source link

xx references into the doc #144

Open PhilLAL opened 6 years ago

PhilLAL commented 6 years ago

Here I list the "anonymous" references I found into the doc:

"See xx to know more on this Pogo tool." (https://tango-controls.readthedocs.io/en/latest/development/device-api/device-server-writing.html#writing-a-device-server-process)

2 steps tasks:

[ ] "manual" checking of the documentation pages to correct every pages with unavailable links
[ ] automatically check dead links at each documentation build (continuous integration)

PhilLAL commented 5 years ago

Several references I found in the doc :

In https://tango-controls.readthedocs.io/en/latest/administration/deployment/starting.html#without-database, a link is not correctly interpreted "See [sec:Device-server-without]"
In https://tango-controls.readthedocs.io/en/latest/administration/deployment/without-sql-db.html#device-server-using-file-as-database, a link is not correctly interpreted "See [DeviceNaming]"
In https://tango-controls.readthedocs.io/en/latest/tutorials-and-howtos/how-tos/how-to-use-tango-servers-without-db.html?highlight=nodb#solution-overview, a link is not correctly interpreted "see 9.10 in the Tango book"
In https://tango-controls.readthedocs.io/en/latest/development/advanced/rest-api.html?highlight=nodb#further-steps, 2 links are not correctly interpreted "[reference]", the references are below

HelgaMond commented 5 years ago

In https://tango-controls.readthedocs.io/en/dev/administration/deployment/without-sql-db.html See appendix [DeviceNaming] for all details about Tango object naming.

HelgaMond commented 5 years ago

https://tango-controls.readthedocs.io/en/dev/administration/deployment/starting.html#with-database See [Env variable] to find how starting a device server

https://tango-controls.readthedocs.io/en/dev/administration/deployment/starting.html#with-file-used-as-database See [sec:Device-server-file] to find informations

HelgaMond commented 5 years ago

https://tango-controls.readthedocs.io/en/dev/development/advanced/reference.html see [TangoRefMan]_ .

PhilLAL commented 5 years ago

Hi, I noticed some similar artefacts at the end of section https://tango-controls.readthedocs.io/en/dev/development/debugging-and-testing/testing-tango-using-docker.html#tango-docker-stack a [reference] is lost inside sentence "For instance, one can start jive [reference] (assuming it is installed on the system)."

A few lines below, one can see [link] into "Currently only mtangorest.server [link]" in https://tango-controls.readthedocs.io/en/dev/development/debugging-and-testing/testing-tango-using-docker.html#tango-docker-stack-for-tango-rest-api

There is also a [TODO script] probably waiting for its script in https://tango-controls.readthedocs.io/en/dev/development/debugging-and-testing/testing-tango-using-docker.html#extending-existing-containers

I put this here since this is similar to the bugs of this issue.