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

Update the content of docs/software/project_cards.md #170

Open
edvinskis opened this issue Oct 16, 2024 · 0 comments
Open

Update the content of docs/software/project_cards.md #170

edvinskis opened this issue Oct 16, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation software TOPIC: research software v2.0

Comments

@edvinskis
Copy link
Collaborator

We are updating the current published content of the guides. This issue refers to docs/software/project_cards.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.
@edvinskis edvinskis added documentation Improvements or additions to documentation software TOPIC: research software v2.0 labels Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation software TOPIC: research software v2.0
Projects
None yet
Development

No branches or pull requests

1 participant