HPC console documentation page #147
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,55 @@ | ||||||
| [](){#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/). | ||||||
|
||||||
|
|
||||||
| ## Features | ||||||
|
|
||||||
| - A modern web interface built on FirecREST API functionalities. | ||||||
| - A dashboard offering an overview of configured clusters and their statuses. | ||||||
| - A dedicated view for creating and monitoring jobs. | ||||||
| - A file navigator with basic file management functionalities, including upload and download features. | ||||||
|
|
||||||
| A description of the views and functionalities can be found [here](https://eth-cscs.github.io/firecrest-ui/documentation/). | ||||||
|
|
||||||
| ## FirecREST supported version | ||||||
|
|
||||||
| 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). | ||||||
|
||||||
| 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. |
Outdated
There was a problem hiding this comment.
| ## FirecREST UI Deployment on Alps | |
| ## FirecREST UI deployment on Alps |
Outdated
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.
Outdated
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.
Outdated
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.
Outdated
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.