# Preview.apidocs.slicer.org status

**URL:** <https://discourse.slicer.org/t/preview-apidocs-slicer-org-status/6108>\
**Category:** Development\
**Tags:** web-infrastructure\
**Created:** [March 11, 2019, 5:55pm UTC](https://discourse.slicer.org/t/preview-apidocs-slicer-org-status/6108 "2019-03-11T17:55:14Z")\
**Posts on this page:** 8\
**Page:** 1

<div class="post-metadata">

**Author:** ![fedorov](https://sea2.discourse-cdn.com/flex002/user_avatar/discourse.slicer.org/fedorov/32/14_2.png) [@fedorov](https://discourse.slicer.org/u/fedorov)\
**Post date:** [March 11, 2019, 5:55pm UTC](https://discourse.slicer.org/t/preview-apidocs-slicer-org-status/6108/1 "2019-03-11T17:55:14Z")

</div>

Is [preview.apidocs.slicer.org](https://github.com/Slicer/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](https://us1.discourse-cdn.com/flex002/uploads/slicer/original/3X/0/8/086f9ff29e1aa67183b9b079b27ff6bff34e2a15.png)

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

> This project hosts the Slicer API documentation served from [http://preview.apidocs.slicer.org](http://preview.apidocs.slicer.org/)

---

<div class="post-metadata">

**Author:** ![fedorov](https://sea2.discourse-cdn.com/flex002/user_avatar/discourse.slicer.org/fedorov/32/14_2.png) [@fedorov](https://discourse.slicer.org/u/fedorov)\
**Post date:** [March 11, 2019, 5:57pm UTC](https://discourse.slicer.org/t/preview-apidocs-slicer-org-status/6108/2 "2019-03-11T17:57:45Z")

</div>

Maybe it is superseded by [http://apidocs.slicer.org/](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.

---

<div class="post-metadata">

**Author:** ![jcfr](https://sea2.discourse-cdn.com/flex002/user_avatar/discourse.slicer.org/jcfr/32/17825_2.png) [@jcfr](https://discourse.slicer.org/u/jcfr)\
**Post date:** [March 11, 2019, 6:12pm UTC](https://discourse.slicer.org/t/preview-apidocs-slicer-org-status/6108/3 "2019-03-11T18:12:40Z")

</div>

- [https://apidocs.slicer.org](https://apidocs.slicer.org) is the released documentation associated Github project with more details is [GitHub - Slicer/apidocs.slicer.org: This project hosts and serves the Slicer API documentation](https://github.com/Slicer/apidocs.slicer.org)

- [https://preview.apidocs.slicer.org](https://preview.apidocs.slicer.org) is for “previewing” documentation associated with PR. Associated github project with more details is [GitHub - Slicer/preview.apidocs.slicer.org: This project hosts and serves a preview version of Slicer API documentation](https://github.com/Slicer/preview.apidocs.slicer.org)

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

 ![image](https://us1.discourse-cdn.com/flex002/uploads/slicer/original/3X/9/9/99400e5d6f520c4677f67acb349de22fe0acbff7.png)

---

<div class="post-metadata">

**Author:** ![jcfr](https://sea2.discourse-cdn.com/flex002/user_avatar/discourse.slicer.org/jcfr/32/17825_2.png) [@jcfr](https://discourse.slicer.org/u/jcfr)\
**Post date:** [March 11, 2019, 6:15pm UTC](https://discourse.slicer.org/t/preview-apidocs-slicer-org-status/6108/4 "2019-03-11T18:15:14Z")

</div>

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](https://github.com/Slicer/preview.apidocs.slicer.org/blob/gh-pages-reset/index.html)

---

<div class="post-metadata">

**Author:** ![fedorov](https://sea2.discourse-cdn.com/flex002/user_avatar/discourse.slicer.org/fedorov/32/14_2.png) [@fedorov](https://discourse.slicer.org/u/fedorov)\
**Post date:** [March 11, 2019, 6:41pm UTC](https://discourse.slicer.org/t/preview-apidocs-slicer-org-status/6108/5 "2019-03-11T18:41:52Z")

</div>

> [@jcfr](#):
>
> [https://preview.apidocs.slicer.org](https://preview.apidocs.slicer.org) is for “previewing” documentation associated with PR.

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](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](http://preview.apidocs.slicer.org/)

?

---

<div class="post-metadata">

**Author:** ![jcfr](https://sea2.discourse-cdn.com/flex002/user_avatar/discourse.slicer.org/jcfr/32/17825_2.png) [@jcfr](https://discourse.slicer.org/u/jcfr)\
**Post date:** [March 11, 2019, 7:03pm UTC](https://discourse.slicer.org/t/preview-apidocs-slicer-org-status/6108/6 "2019-03-11T19:03:00Z")

</div>

> [@fedorov](#):
>
> Should I make a pull request

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

- [preview.apidocs.slicer.org/index.html at gh-pages-reset · Slicer/preview.apidocs.slicer.org · GitHub](https://github.com/Slicer/preview.apidocs.slicer.org/blob/gh-pages-reset/index.html)
- [preview.apidocs.slicer.org/index.html at gh-pages · Slicer/preview.apidocs.slicer.org · GitHub](https://github.com/Slicer/preview.apidocs.slicer.org/blob/gh-pages/index.html)

To understand the rational for updating the two files, you could read [here](https://github.com/Slicer/preview.apidocs.slicer.org#reset-of-gh-pages-branch-using-travisci-cron-job)

---

<div class="post-metadata">

**Author:** ![fedorov](https://sea2.discourse-cdn.com/flex002/user_avatar/discourse.slicer.org/fedorov/32/14_2.png) [@fedorov](https://discourse.slicer.org/u/fedorov)\
**Post date:** [March 11, 2019, 7:10pm UTC](https://discourse.slicer.org/t/preview-apidocs-slicer-org-status/6108/7 "2019-03-11T19:10:51Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![jcfr](https://sea2.discourse-cdn.com/flex002/user_avatar/discourse.slicer.org/jcfr/32/17825_2.png) [@jcfr](https://discourse.slicer.org/u/jcfr)\
**Post date:** [March 11, 2019, 7:25pm UTC](https://discourse.slicer.org/t/preview-apidocs-slicer-org-status/6108/8 "2019-03-11T19:25:48Z")

</div>

> [@fedorov](#):
>
> If I am the only one confused, no need to make any changes

The change makes complete sense 👍