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 11 forks source link

Review and evaluate the content of `getting_started.md` #124

Open edvinskis opened 2 weeks ago

edvinskis commented 2 weeks ago

Some unused files have been identified in our directory while porting the guides to Quarto. This issue refers to the file getting_started.md. It is located in the folder docs/infrastructure/.

Tasks:

  1. Review the content of the file thoroughly. Check for any outdated information that may need updating.
  2. Assess the relevance and usefulness of the information for our documentation.
  3. Determine if the content should be (choose appropriate action):
Nr. Situation Action
1 Needs to be integrated into an existing guide Identify the appropriate guide for integration. Rewrite or add the information. Work in a separate branch, then open a pull request and assign a reviewer.
2 Used to create a new guide or archived for future reference Move to the folder docs/_under_development and open a new issue with the required further action.
3 Deleted if outdated or irrelevant Delete and mention this when closing the issue.

Workflow:

  1. Either work in a separate branch or a branch in your fork.
  2. If Situation Nr. 1 applies, 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 render.
      • 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.
  3. 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.

Additional Considerations: