From 90f9810d479a0c7dc49029264b56098fce064822 Mon Sep 17 00:00:00 2001 From: John Freeman Date: Mon, 31 Jan 2022 22:47:55 -0600 Subject: [PATCH] JCF: Issue #28: skeleton for onboarding instructions --- docs/README.md | 2 +- docs/onboarding.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 docs/onboarding.md diff --git a/docs/README.md b/docs/README.md index b6b66a31499..b2112902a88 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,7 +3,7 @@ Welcome! The purpose of this website is to provide information on how to use the applications, plugins, base classes, etc. offered by the suite of DUNE DAQ packages. You can learn both how to run the DAQ as well as use various tools to extend its functionality. If you're new to DUNE DAQ software, you'll want to start by reading the [daq-buildtools documentation](packages/daq-buildtools/README.md), which covers [how to set up a development environment](packages/daq-buildtools/README.md#Setup_of_daq-buildtools) and [build a package](packages/daq-buildtools/README.md#Cloning_and_building). Once you've done this, you'll likely want to learn about [how to write DAQ modules](packages/appfwk/README.md#Writing_DAQ_modules) in the [appfwk documentation](packages/appfwk/README.md), units of code which -are meant to perform specific tasks and can be combined to define the overall behavior of a running DAQ application. At some point you may also need to learn about how to create a package from scratch by reading the [daq-cmake documentation](packages/daq-cmake/README.md); this documentation is also very useful for understanding how to get new source code files you've added to compile. +are meant to perform specific tasks and can be combined to define the overall behavior of a running DAQ application. At some point you may also need to learn about how to create a package from scratch by reading the [daq-cmake documentation](packages/daq-cmake/README.md); this documentation is also very useful for understanding how to get new source code files you've added to compile. In order to learn how to join groups within the collaboration and gain write permissions to packages, click [here](onboarding.md). There are five DUNE DAQ software packages which are used to aid developers in creating packages designed for the DAQ itself: diff --git a/docs/onboarding.md b/docs/onboarding.md new file mode 100644 index 00000000000..e23ce2e035d --- /dev/null +++ b/docs/onboarding.md @@ -0,0 +1,3 @@ +# Instructions On How to Join Groups, etc. + +_...can go here..._