Preview.apidocs.slicer.org status

web-infrastructure

(Andrey Fedorov) #1

Is preview.apidocs.slicer.org something that is supposed to be usable or “previewable”?

Currently, the link shows the below, which I am not sure corresponds to the description of that resource:

image

According to the readme at https://github.com/Slicer/preview.apidocs.slicer.org:

This project hosts the Slicer API documentation served from http://preview.apidocs.slicer.org


(Andrey Fedorov) #2

Maybe it is superseded by http://apidocs.slicer.org/? Should we remove “preview” from the github organization if this is the case? Some users may discover this resource by browsing the Slicer GitHub organization content.


(Jean Christophe Fillion Robin) #3

The “Details” link leads to the https://preview.apidocs.slicer.org website.


(Jean Christophe Fillion Robin) #4

If you would like to add more details, you could update the index.html page available at: https://github.com/Slicer/preview.apidocs.slicer.org/blob/gh-pages-reset/index.html


(Andrey Fedorov) #5

Makes sense now that you explain it! Thanks! Should I make a pull request to replace

This project hosts the Slicer API documentation served from http://preview.apidocs.slicer.org

with

This project hosts the preview of Slicer API documentation associated with PRs, served from http://preview.apidocs.slicer.org

?


(Jean Christophe Fillion Robin) #6

In fact, no need for a PR, I suggest you directly update these two files (you already have push access):

To understand the rational for updating the two files, you could read here


(Andrey Fedorov) #7

Sounds good, I will look later. If I am the only one confused, no need to make any changes. Let’s leave as is.


(Jean Christophe Fillion Robin) #8

The change makes complete sense :+1: