Commit 94ab09e4 authored by m_goet09's avatar m_goet09

adds executable part

parent a35a09df
......@@ -43,12 +43,13 @@
<div class="container">
<h1 id="licence">Licencing Information Badge</h1>
<div class="col-md-6">
<img src="images/license_noData_code.svg" /></br>
<img src="images/shields_io/licence_open.svg" />
<img src="images/shields_io/licence_mostly_open.svg" />
<img src="images/shields_io/licence_partially_open.svg" />
<img src="images/shields_io/licence_closed.svg" />
<img src="images/shields_io/licence_no_Information.svg" />
<img src="images/license_noData_code.svg" />
</div>
<div class="col-md-6">
<h3>Full size badges</h3>
......@@ -64,7 +65,7 @@
if two of three are open, it retrieves a yellow badge. Orange badges represent partially open compendia, with one of three licences open. A red badge signals
every single category with non open-source licences. If no information is available for all categories, the badge is grey.
</p>
<h3>Shields IO badges</h3>
<h3>Shields IO badges License</h3>
<p>These are small representations of the full-size badges. They are used to give a brief overview on the licencing information.
The same colour-scheme is used as with the full-size badges.
</p>
......@@ -78,10 +79,27 @@
<img src="images/shields_io/Peer review-Blind-brightgreen.svg" />
</div>
<div class="col-md-6">
<h3>Shields IO badges</h3>
<p>For peer review status, there are no full-sized badge and the information is included in Shields.IO badges. Moreover, there are no set number of return badges since the DOI is passed to the DOAJ API and can receive numerous results regarding the peer-reviewed status of a research. Nonetheless, 4 possible examples are shown here. The API DOAJ contains peer-reviewed only, therefore if a research title matches it will return the "Peer Review - YES" green badge. Likewise, if the research is not found it will return the "Peer Review - NO" red badge. Unknown shall be returned for researches hosted on DOAJ that do not have peer review information associated with them. Lastly, the "Peer Review - Blind" badge, is returned for researches in which the names of reviewers are hidden from the author. Either single Blind review or double blind review is considered, as explained <a href="https://www.elsevier.com/reviewers/what-is-peer-review">here.</a>
<h3>Shields IO badges Peer Review</h3>
<p>For the the peer review status, there are no full-sized badge and the information is included in Shields.IO badges. Moreover, there are no set number of return badges since the DOI is passed to the DOAJ API and can receive numerous results regarding the peer-reviewed status of a research. Nonetheless, 4 possible examples are shown here. The API DOAJ contains peer-reviewed only, therefore if a research title matches it will return the "Peer Review - YES" green badge. Likewise, if the research is not found it will return the "Peer Review - NO" red badge. Unknown shall be returned for researches hosted on DOAJ that do not have peer review information associated with them. Lastly, the "Peer Review - Blind" badge, is returned for researches in which the names of reviewers are hidden from the author. Either single Blind review or double blind review is considered, as explained <a href="https://www.elsevier.com/reviewers/what-is-peer-review">here.</a>
</p>
</div>
<h1 id="executability">Executability Badge</h1>
<div class="col-md-6">
<img src="images/shields_io/executable-yes-brightgreen.svg" />
<img src="images/shields_io/executable-no.svg" />
<img src="images/shields_io/executable-running.svg" />
<img src="images/shields_io/executable-noInfo.svg" />
</div>
<div class="col-md-6">
<h3>Shields IO badges Executability</h3>
<p>For the executable status, there are also no full-sized badge and the information is included in Shields.IO badges.
After the request from a client with an doi was done, the corresponding o2r id is matched to it.
If the code in a compendium is executable, the status is "success" the green badge is sent to the client. The yellow badge
is used for compendia, which have a running code, but the execution of the code isn't finished yet, the status then is "running.
For a "fail" the red badge is sent if no information are available, the grey badge is sent.
</p>
</div>
</div><!-- /.container -->
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment