Skip to content
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

Reorganize documentation in services #452

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open

Conversation

lexming
Copy link
Collaborator

@lexming lexming commented Jan 27, 2025

This PR reorganizes the documentation in services as discussed in the CUE work group:

  • The 3 main categories stay the same: Compute, Data and Cloud
  • Frontpage re-designed to show small cards for each service inside the 3 main categories
  • Accounts and access converted to VSC Accounts. Now it only covers: Creation of accounts, Cryptographic Keys, MFA and Account Management
  • Documentation on access methods through the terminal moved into new Terminal Interface section under Compute
  • New service added to Compute for Web Portals
  • Infrastructure split into two services Tier-1 Infrastructure and Tier-2 Infrastructure
  • Added redirects for all old paths to their new location

The tooling to generate the documentation is updated as well. Now tabs can be synced across tab panels. This means that whenever the user selects a tab for their home institute, all other tab panels will automatically show that same tab. This does not only work for the opened document, but across the whole documentation site.

Another tooling improvement is the addition of a link checker. Now we can execute make linkchk and sphinx will build the documentation and check the status of all external links. We had many broken links, this PR fixes many many of them.

This new version of the documentation can be checked in https://vscdocumentationbeta.readthedocs.io/

… reredirects are unusable as they require old files to exists, while redirects at least allows to use an external file for definitions
Security Keys
#############
##################
Cryptographic Keys
Copy link
Collaborator

Choose a reason for hiding this comment

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

i would use the term SSH Keys instead, which i think is what most people use, and it's more clear those keys are for SSH authentication.

also, cryptographic keys don't necessarily mean ssh keys.

if you really want to use cryptographic, i would go for SSH Cryptographic Keys

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.

2 participants