add "Onboarding" page to docs

Open
  • Is something wrong?
#6 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

The issue asks for a new onboarding page in the docs site. The existing Partners page at /docs/90_partners/ is the closest reference for layout and for linking to other pages. Start by reading that page to see how the docs are organised, then add an onboarding page with the five listed steps. Done means the page exists, is reachable from the site navigation, and gives the steps in order. Some steps depend on maintainers, so check with the project before publishing.

Written by the indexing model from the issue text.

Description

We should document how to "onboard" new people to the project:

  • send them an invitation to the Slack channel
  • add them to the mailing list (via @bedroge or @zilverberg)
  • add them to the EESSI GitHub organization
  • let them open a PR to add themselves to the "Partners" page
  • quick introduction via email + next EESSI conf call
Dominant language
Python
Stars
14
Forks
54
Avg merge
11h 2m
Merged PRs (30d)
41

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from EESSI/docs

All issues in EESSI/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.