Skip to content

Conversation

@jpdorsch
Copy link
Contributor

@jpdorsch jpdorsch commented Sep 1, 2025

In this PR:

  • added services/devportal as documentation for the Developer Portal (before attached to FirecREST docs)
  • Updated list of github users as CODEOWNERS of firecrest and devportal
  • Moved images from firecrest to services with the prefix devportal-*

https://docs.tds.cscs.ch/251/services/devportal/#creating-an-application

@github-actions

This comment has been minimized.

@github-actions
Copy link

github-actions bot commented Sep 1, 2025

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

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions
Copy link

github-actions bot commented Sep 1, 2025

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

@github-actions

This comment has been minimized.

@msimberg
Copy link
Collaborator

msimberg commented Sep 1, 2025

Thanks @jpdorsch! I'll have a closer look later, but for the spell checker you can add oauth, oidc, and wso to https://github.com/eth-cscs/cscs-docs/blob/main/.github/actions/spelling/allow.txt.

@github-actions

This comment has been minimized.

@github-actions
Copy link

github-actions bot commented Sep 1, 2025

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

@github-actions

This comment has been minimized.

@jpdorsch
Copy link
Contributor Author

jpdorsch commented Sep 1, 2025

Hi @msimberg ,

I see that WSO2 is not allowed, but instead I should set WSO. Is this correct?

Cheers

@github-actions
Copy link

github-actions bot commented Sep 1, 2025

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

@msimberg
Copy link
Collaborator

msimberg commented Sep 1, 2025

Hi @msimberg ,

I see that WSO2 is not allowed, but instead I should set WSO. Is this correct?

Cheers

Ah right. Depends, is "WSO" on its own a valid term? If yes, then you can indeed leave WSO as is in allow.txt. If "WSO2" is the only correct term, then add it to patterns.txt instead. The spell checker splits words in what is normally a reasonable way (think e.g. CamelCase42; should check "camel", "case", and ignore "42"). E.g. "aarch64" is also in patterns.txt to have it recognized as one standalone term: https://github.com/jpdorsch/cscs-docs/blob/ea74dff462c0148294193c38cceedae4a5bf3f7a/.github/actions/spelling/patterns.txt#L16.

Same goes for "OAuth" vs "OAuth2".

@jpdorsch
Copy link
Contributor Author

jpdorsch commented Sep 1, 2025

I see, let me change it then, because WSO doesn't make sense by itself. OAuth does, though.

@github-actions
Copy link

github-actions bot commented Sep 1, 2025

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

Copy link
Collaborator

@msimberg msimberg left a comment

Choose a reason for hiding this comment

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

Only minor nits from my side on the text.

Please add the developer portal to the index page of "Services" as well.

@github-actions
Copy link

github-actions bot commented Sep 2, 2025

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

@jpdorsch jpdorsch requested a review from msimberg September 2, 2025 09:43
Copy link
Member

@bcumming bcumming left a comment

Choose a reason for hiding this comment

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

I have a comment about the screenshots. Most of the shots are really useful for readers, but I have marked a few that might not be needed.

https://docs.cscs.ch/contributing/#screenshots

The suggestion is to keep screenshots to a minimum to make docs clearer, and keep the repo size down. Feel free to argue for their inclusion, or zoom / label some to better integrate them with the text.

@github-actions
Copy link

github-actions bot commented Sep 2, 2025

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

@jpdorsch jpdorsch requested a review from bcumming September 2, 2025 12:28
@github-actions
Copy link

github-actions bot commented Sep 2, 2025

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

@github-actions
Copy link

github-actions bot commented Sep 2, 2025

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

@github-actions
Copy link

github-actions bot commented Sep 2, 2025

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

Copy link
Member

@bcumming bcumming left a comment

Choose a reason for hiding this comment

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

Looks good!

@bcumming bcumming enabled auto-merge September 3, 2025 09:17
@bcumming bcumming added this pull request to the merge queue Sep 3, 2025
Merged via the queue into eth-cscs:main with commit 771cce2 Sep 3, 2025
3 checks passed
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.

3 participants