Skip to content

firecrest ui doc #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

francescopagnamenta
Copy link

  • minimal firecrest ui doc with external references
  • links from the main page - menus

Verified

This commit was signed with the committer’s verified signature.
snyk-bot Snyk bot
Copy link

github-actions bot commented Jun 6, 2025

preview available: https://docs.tds.cscs.ch/147

[](){#ref-firecrest-ui}
# FirecREST UI

FirecREST UI is a web application designed to provide essential functionalities for interacting with [FirecREST API v2 backend](https://docs.cscs.ch/services/firecrest/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
FirecREST UI is a web application designed to provide essential functionalities for interacting with [FirecREST API v2 backend](https://docs.cscs.ch/services/firecrest/).
FirecREST UI is a web application designed to provide essential functionalities for interacting with [FirecREST API v2 backend][ref-firecrest].


The FirecREST UI is available and runs on the FirecREST API v2 backend (v1 not supported).

## FirecREST UI Deployment on Alps
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## FirecREST UI Deployment on Alps
## FirecREST UI deployment on Alps

Comment on lines +23 to +41
FirecREST UI is currently available on two [Alps platforms][ref-alps-platforms].

<table>
<tr>
<th>Platform</th>
<th>UI URL</th>
<th>Clusters</th>
</tr>
<tr>
<td>HPC Platform</td>
<td>https://my.hpcp.cscs.ch/</td>
<td><a href="../../clusters/daint">Daint</a>, <a href="../../clusters/eiger">Eiger</a></td>
</tr>
<tr>
<td>ML Platform</td>
<td>https://my.mlp.cscs.ch/</td>
<td><a href="../../clusters/bristen">Bristen</a>, <a href="../../clusters/clariden">Clariden</a></td>
</tr>
</table>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a must, but I'm thinking: would it make sense to put this right in the intro? Right now the page isn't very long, so it doesn't matter much, but I quite like the idea of having it more prominent. At least I think I'd be more likely to click one of the links if it's right at the top (bottom of the intro section).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I’ll have a chat with @jpdorsch about this. The PR will likely take some time, as the FirecREST UI deployment at CSCS will probably have a different name.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's ok. Ping us again when you think it's ready for another look. You might want to mark the PR a draft until then?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I marked the PR as a draft, hopefully the app/deployment name will be decided soon.

<tr>
<td>HPC Platform</td>
<td>https://my.hpcp.cscs.ch/</td>
<td><a href="../../clusters/daint">Daint</a>, <a href="../../clusters/eiger">Eiger</a></td>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you try a regular mkdocs table first? That'd allow you to use the regular linking mechanisms of markdown. If the html table does something significantly nicer than the regular markdown tables we can of course keep that.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thx for the tip, I reused the template from the FirecREST page, even though a slightly more complex template would have been more appropriate in this context. Yes, we could consider using a markup table instead.


Starting early 2025, CSCS has introduced a new version of the API: [FirecREST version 2](https://eth-cscs.github.io/firecrest-v2).

The FirecREST UI is available and runs on the FirecREST API v2 backend (v1 not supported).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The FirecREST UI is available and runs on the FirecREST API v2 backend (v1 not supported).
The FirecREST UI is available and runs on the FirecREST API v2 backend. v1 is not supported.

Comment on lines +49 to +55
* [FirecREST OpenAPI Specification](https://eth-cscs.github.io/firecrest-v2/openapi)
* [FirecREST Official Docs](https://eth-cscs.github.io/firecrest-v2)
* [Documentation of pyFirecREST](https://pyfirecrest.readthedocs.io/)
* [FirecREST repository](https://github.com/eth-cscs/firecrest-v2)
* [What are JSON Web Tokens](https://jwt.io/introduction)
* [Python Requests](https://requests.readthedocs.io/en/master/user/quickstart)
* [Python Async API Calls](https://docs.aiohttp.org/en/stable/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As someone who doesn't know much about firecrest ui, it's not immediately clear why these are useful links here. I guess they're the same links as on the firecrest page? If yes, I think they could maybe be left out? You could also link to the firecrest ui docs with a link right in the intro, and the hpc and ml platform links are anyway already mentioned earlier.

What do you think?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we might drop most of the links, as the deployment may end up being less closely associated with the FirecREST UI initiative.

</table>


## Further Information
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Further Information
## Further information

(if the section stays). See https://docs.cscs.ch/contributing/#headings-are-written-in-sentence-case.

@francescopagnamenta francescopagnamenta marked this pull request as draft June 12, 2025 15:25
[](){#ref-firecrest-ui}
# FirecREST UI

FirecREST UI is a web application designed to provide essential functionalities for interacting with [FirecREST API v2 backend](https://docs.cscs.ch/services/firecrest/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest to spell 'UI' at least once as User Interface, e.g. and take a user point of view, i.e. what it provides

Firecrest User Interface (UI) is a web application that provides a convenient access to information, data and functionalities for a particular cluster. Its implementation is based on the [FirecREST API v2 backend][ref-firecrest].

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants