HPC console documentation page #147
Conversation
francescopagnamenta
commented
Jun 6, 2025
francescopagnamenta
commented
- minimal firecrest ui doc with external references
- links from the main page - menus
francescopagnamenta
requested review from
RMeli,
bcumming and
msimberg
as code owners
|
preview available: https://docs.tds.cscs.ch/147 |
docs/services/firecrest-ui.md
Outdated
| [](){#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/). |
There was a problem hiding this comment.
| 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]. |
docs/services/firecrest-ui.md
Outdated
|
|
||
| The FirecREST UI is available and runs on the FirecREST API v2 backend (v1 not supported). | ||
|
|
||
| ## FirecREST UI Deployment on Alps |
There was a problem hiding this comment.
| ## FirecREST UI Deployment on Alps | |
| ## FirecREST UI deployment on Alps |
docs/services/firecrest-ui.md
Outdated
| 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> |
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Ok, I marked the PR as a draft, hopefully the app/deployment name will be decided soon.
docs/services/firecrest-ui.md
Outdated
| <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> |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
docs/services/firecrest-ui.md
Outdated
|
|
||
| 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). |
There was a problem hiding this comment.
| 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. |
docs/services/firecrest-ui.md
Outdated
| * [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/) |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Yes, we might drop most of the links, as the deployment may end up being less closely associated with the FirecREST UI initiative.
docs/services/firecrest-ui.md
Outdated
| </table> | ||
|
|
||
|
|
||
| ## Further Information |
There was a problem hiding this comment.
| ## Further Information | |
| ## Further information |
(if the section stays). See https://docs.cscs.ch/contributing/#headings-are-written-in-sentence-case.
docs/services/firecrest-ui.md
Outdated
| [](){#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/). |
There was a problem hiding this comment.
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].
…available in the Firecrest doc)
|
Thank you all for the feedbacks. I've updated the PR with your suggestions. The final decision on the application name (currently "FirecREST user interface") is pending within IRAM. @jpdorsch will communicate the decision once it's been made. |
|
We have updated the PR with the following changes:
I kindly ask to add @candrea85 to the main repo as he has contributed and he will contribute to the HCP console doc. |
|
@francescopagnamenta could I ask you or @candrea85 to add yourself/ves to |
Co-authored-by: Mikael Simberg <[email protected]>
Co-authored-by: Mikael Simberg <[email protected]>
Co-authored-by: Mikael Simberg <[email protected]>
Co-authored-by: Juan Pablo Dorsch <[email protected]>
Co-authored-by: Juan Pablo Dorsch <[email protected]>
Co-authored-by: Juan Pablo Dorsch <[email protected]>
Co-authored-by: Juan Pablo Dorsch <[email protected]>
|
PR replaced by #270 |
Description - minimal hpc console doc with external references - links from the main page - menus Replaces the PR #147 --------- Co-authored-by: Francesco Pagnamenta <[email protected]> Co-authored-by: Juan Pablo Dorsch <[email protected]>
4 participants
