search

TU-Delft-DCC / TU-Delft-DCC.github.io

Community for developing data and software solutions for researchers
https://TU-Delft-DCC.github.io
Creative Commons Attribution 4.0 International
2 stars 12 forks source link

Update the content of `docs/infrastructure/VPS_SSH.md` #153

Open edvinskis opened 4 weeks ago

edvinskis commented 4 weeks ago

We are updating the current published content of the guides. This issue refers to docs/infrastructure/VPS_SSH.md.

Tasks:

  1. Review the content of the file thoroughly.
  2. Assess the relevance and usefulness of the information.
  3. Check for any outdated information that may need updating.
  4. If the documentation is marked as "Under Construction", do a full write-up.
  5. Verify that the updated content is consistent with our overall documentation.

Workflow:

  1. Either work in a separate branch or a branch in your fork.
  2. Install Quarto if you don’t already have it installed on your machine. You can find the installation instructions here.
  3. Then:
    • Edit the .md file in any editor you prefer.
    • To preview the changes you made:
      • Navigate to the root of this repo in your terminal.
      • Run quarto preview.
      • You will see the live edits in a browser window.
      • Commit the changes you made. When making commits add the issue number (e.g. git commit -m "#19 your commit message") to your commits, so they are referenced in this issue.
      • Open a pull request, and assign a reviewer.
  4. If you do not wish to spend time with formatting the Quarto syntax, ensure that the content itself is correct, and @ me in this issue. I'll format it accordingly.