CERN Accelerating science

Documentation

We have migrated out documentation to a Git repository, from which online HTML pages are generated using GitBook automatically every night.

Keeping the documentation in Git allows us to keep history, and tag the documentation together with the software they document. We believe this helps to keep track of how the service has changed with time. Also, documentation for older versions will remain easily reachable in case someone needs them.

New experimental feature: self-documenting API

Now the develop branch of the FTS3 RESTful API implements the auto-generation of documentation using the Swagger format, which is based on JSON.

The advantage of using this specific format is the possibility of using the Swagger UI, which allows to render more nicely the documentation.

You can see it in action in http://aalvarez.web.cern.ch/aalvarez/fts3api/