Skip to content

Johnfreeman/daq deliverables issue108 onboarding page #298

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.

Sign up for GitHub

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

Open
jcfreeman2 wants to merge 6 commits into
base: develop
Choose a base branch
from
Open

Johnfreeman/daq deliverables issue108 onboarding page #298

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ebd0985
JCF: DUNE-DAQ/daq-deliverables#108: a very rough draft of what an onb…
jcfreeman2 Aug 31, 2023
43c5f17
JCF: DUNE-DAQ/daq-deliverables#108: Update onboarding_page.md
jcfreeman2 Aug 31, 2023
8f7a7d8
JCF: DUNE-DAQ/daq-deliverables#108: Update onboarding_page.md
jcfreeman2 Sep 2, 2023
8100675
JCF: DUNE-DAQ/daq-deliverables#108: Update onboarding_page.md
jcfreeman2 Oct 13, 2023
7fa070a
JCF: DUNE-DAQ/daq-deliverables#108: incorporate Kurt, Alex and Marco'…
jcfreeman2 Dec 15, 2023
f1f8015
JCF: DUNE-DAQ/daq-deliverables#108: drop the "Big Picture" section to…
jcfreeman2 Dec 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions docs/onboarding_page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@

# Onboarding Page for New DUNE DAQ Collaborators

**Who this page is for:** If you're brand new to the DUNE DAQ consortium, you're in the right place!

## Accounts and Memberships

You'll need a few accounts to work with the DUNE DAQ consortium. These include:

### For Communication

* Access to [Slack](https://slack.com)'s [dunescience.slack.com](https://dunescience.slack.com) workspace. Much of the day-to-day communication between developers takes place here. Within the workspace, start by joining these channels:
* **#daq-sw-librarians**: the channel where you request membership in [the DUNE-DAQ organization on GitHub](https://github.com/DUNE-DAQ) as well as membership on a particular development team. It helps speed things up if you have your local institution's DUNE DAQ group leader vouch for you on this channel.
* **#dunedaq-integration**: general activity in DUNE DAQ development

* Using [Fermilab's listserv service](https://listserv.fnal.gov/), subscribe to `[email protected]`. This is where important messages about meetings, etc. are sent to the consortium.


### For Coding

* A user account on [GitHub](https://github.com/). This is where we store DUNE DAQ package code in [git version controlled](https://git-scm.com/) repositories. _Make sure you can be easily identified by your username, otherwise change it or open a new GitHub account._ This generally means that your first name (or at the very least your first initial) appears in your username followed by your last name and then any additional characters to make your username unique on GitHub. E.g., if your name is Alain Berset, examples of acceptable usernames would be `aberset41` and `alainberset41`.

* Membership in the [GitHub DUNE-DAQ organization](https://github.com/DUNE-DAQ) as well as one or more development teams within the organization.

### For Computing

* Access to the np04 computing cluster based in CERN's EHN1 building. This is where the heart of DUNE DAQ development, running and testing takes place. You need to access the nodes in this cluster from...
* ...[CERN's lxplus cluster](https://abpcomputing.web.cern.ch/computing_resources/lxplus/), where you'll first need to get an account
* ...and to do that, you'll need to start with a [CERN user account](https://account.cern.ch/account/). You'll want a standard computing account, not the "Lightweight" one. Contact the DUNE collaboration coordinator, Maxine Hronek, at `[email protected]` if you have questions. This should also give you a Zoom account, enabling you to attend online meetings.
* See more about accessing the np04 computing cluster at https://twiki.cern.ch/twiki/bin/view/CENF/AccessRequirements


## Websites

* Documentation for end users of DUNE DAQ software can be found in the [official DUNE DAQ documentation page](https://dune-daq-sw.readthedocs.io/en/latest/)

* The [list of DUNE-DAQ teams and the repositories they have write access to](https://dune-daq-sw.readthedocs.io/en/latest/packages/daq-release/team_repos/); note that this page is bookmarked at the top of the **#daq-sw-librarians** channel

* The [description of our standard development workflow](https://dune-daq-sw.readthedocs.io/en/latest/packages/daq-release/development_workflow_gitflow/)

* Documentation for developers of a particular DUNE DAQ package should be put in the GitHub Wiki for that package's repo (see an example [here](https://github.com/DUNE-DAQ/dpdklibs/wiki)). But note...

* ...the [daqconf Wiki](https://github.com/DUNE-DAQ/daqconf/wiki) is special in that it not only provides specific info for daqconf developers but **general info for all DUNE DAQ developers**

* The [Indico website for DUNE DAQ meetings](https://indico.fnal.gov/category/700/). Note that you'll generally be going to the page which you access by clicking "General Meetings", though certain types of domain-specific meetings (technical, software release coordination, etc.) will be contained in the "Technical Meetings" page.

## Next steps

Read the introduction to DUNE DAQ software at the top of the [official documentation](https://dune-daq-sw.readthedocs.io/en/latest/) as well as the useful day-to-day setup info provided in the `daqconf` package wiki [here](https://github.com/DUNE-DAQ/daqconf/wiki/Instructions-for-setting-up-an-FD-development-software-area).