nf-core / nf-core/website

Add Github codespaces documentation

Open
#3,248 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
MDX
Stars
98
Forks
298
Avg merge
14h 38m
Merged PRs (30d)
38

Description

We should update the documentation to give codespaces the same level of coverage as Gitpod has, as many users are now using this instead.

"Other alternatives" should be removed, and codespaces given its own dropdown:

Image

Gitpod pages should be updated, to reflect the new costs.

We should mention which method is preferred currently

Maybe this update could be started by a beginner at the nf-core hackathon March. With review and help by core?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the nf-core website documentation and locate the pages that describe Gitpod and other development-environment alternatives. Give GitHub Codespaces its own dropdown with comparable coverage, remove the “Other alternatives” section, update Gitpod pricing, and state which method is currently preferred; confirm the resulting navigation and links render correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.