Skip to content

Commit dbccdc6

Browse files
committed
feat (internal): updating 'new group onboarding' guidance for SciComp team
1 parent b4d9904 commit dbccdc6

File tree

1 file changed

+36
-30
lines changed

1 file changed

+36
-30
lines changed

internal/new-wg-setup.qmd

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -10,51 +10,57 @@ Feel free to [contact us](https://lter.github.io/scicomp/staff.html) if you find
1010

1111
When new working groups are funded, our team takes a number of setup steps to create some of the infrastructure that past groups have requested/found useful. This is mainly an attempt to help the group avoid spending their precious in-person meeting time doing relatively dry technical steps that we can easily accomplish early-on. Some of these steps also set a useful 'tone' in terms of facilitating groups' adherence to reproducibility best practices.
1212

13-
## Shared Google Drive
13+
## 1. Attend LTER Network Office 'New Group Onboarding' Meeting
1414

15-
Many groups gravitate towards using Google Drive for storing data, relevant scientific literature, and (eventually) manuscript drafts. One advantage of a true Shared Drive over simply creating a folder and sharing that is that the distributed ownership of the Shared Drive makes it very difficult to accidentally delete/lose important files.
15+
Once the decision is made for which group(s) to fund, Marty Downs will schedule an onboarding meeting for group PIs to talk about NCEAS / LTER Network Office resources. A SciComp team member needs to be there to give a brief introduction and pitch for the kinds of support that our team can offer.
1616

17-
Some groups have experience serious heartbreak when one member's Google identity gets closed by their institution and all files/folders created by that member vanish. A Shared Drive makes this horror story an impossibility.
17+
## 2. Create the Infrastructure for the Group
1818

19-
### Creating the Shared Drive
19+
:::{.panel-tabset}
20+
### Google Group
2021

21-
Our `@nceas.ucsb.edu` email addresses are empowered to create Shared Drives. Navigate to your Google Drive, then in the left sidebar click "Shared drives". Once there you can click the "+ New" button to create a brand new Shared Drive.
22+
**Rationale:** Google Groups centralize all group members' Google identities. This makes sharing access to a piece of the Google ecosystem with an entire team really simple.
2223

23-
The naming convention you should use is `LTER-WG_<WG-Abbreviation>` or `LTER-SPARC_WG-Abbreviation` for full synthesis working groups and SPARC groups respectively.
24+
**Naming Convention:**
2425

25-
Note that for groups with longer names you will want to abbreviate so that the Shared Drive name doesn't get ambiguously cropped in a default browser window.
26+
- "LTER-WG_\<Abbreviated-Group-Name\>"
27+
- "LTER-SPARC_\<Abbreviated-Group-Name\>"
2628

27-
### Adding Users
29+
Note that the group abbreviation should be title case (e.g., "Ecological-Synthesis")
2830

29-
Once the Shared Drive exists, add the following people as "Content Managers":
31+
### Shared Drive
3032

31-
- <u>All</u> members of the Scientific Computing team
32-
- Marty Downs (LTER Network Office Director)
33-
- Thomas Hetmank (NCEAS Programmer/Analyst)
33+
**Rationale:** A Shared Google Drive is a great place to store raw data as well as preserve documentation and script outputs. A true Shared Drive also distributes ownership in a way that makes it safe even when individual Google accounts get deactivated (as is the case when someone changes institutions).
3434

35-
When you reach out to the working groups you can also make a note of their emails and add them as well though you may want to first tell them about the Shared Drive before sending them a semi-random Shared Drive invite.
35+
**Naming Convention:** Same as the Google Group!
3636

37-
### Content Creation
37+
**Other Notes:** Add the Google Group as 'maintainers' and add Marty Downs and Thomas Hetmank as 'administrators'. Also, move copies of [the critical LTER template Google files](https://drive.google.com/drive/folders/1g9n1A7XgCeYduB3LdO1JGDktrvu-rWj0) into the top-level of the Shared Drive. Groups are not required to use these but they generally have been useful to groups in the past.
3838

39-
We want to use as light a touch as possible here to make sure that groups feel empowered to make their Shared Drive whatever they need it to be but there are a few things we can do.
39+
### GitHub Repository
4040

41-
Copy the template Google Sheets we've created (found in [this Drive folder](https://drive.google.com/drive/folders/1g9n1A7XgCeYduB3LdO1JGDktrvu-rWj0?usp=sharing)) and move the copies into their Shared Drive.
41+
**Rationale:** GitHub is _the_ way we recommend collaborating on code. This emphasis is made more particularly clear elsewhere so we'll leave it at that here.
4242

43-
## GitHub Repository
43+
**Naming Convention:**
4444

45-
We encourage all groups to engage with GitHub for--at minimum--storing their final code products. We have found that creating a GitHub repository at this stage tends to increase adoption of GitHub and is therefore very much worthwhile even if no group members use it at the time that their group gets funded.
45+
- "lter / lterwg-\<abbreviated-group-name>\"
46+
- "lter / lter-sparc-\<abbreviated-group-name>\"
4647

47-
### Initialize Repository
48+
Note that the group abbreviation should be entirely lowercase.
4849

49-
Make a repository in the [LTER GitHub Organization](https://github.com/lter) with the following information:
50+
**Other Notes:** Create the repository in the LTER GitHub organization and use the [working group template repository](https://github.com/lter/lterwg-template) as the starting point. Add any usernames that you have from the group to this repository.
5051

51-
1. Begin with the [working group template repository](https://github.com/lter/lterwg-template)
52-
- When you make a new repo it'll provides an option for whether you want to use a template
53-
2. Create a name that fits one of the following naming conventions
54-
- For full working groups (3-4 meetings): "lterwg-`abbreviated-group-name`"
55-
- For SPARC groups (1 meeting): "lter-sparc-`abbreviated-group-name`"
56-
3. Set the "Description" to the title of the working group
57-
- As indicated on [the LTER Network Office website](https://lternet.edu/current-working-groups/)
58-
4. Add a README
59-
4. Create a `.gitignore` <u>using the R template</u>
60-
- R is the most common working group language and the `.gitignore` is easily changed in the event the group is primarily using a different language
52+
### NCEAS Server Account
53+
54+
Don't do this unless it is needed! The server is another account/login/workflow group members have to keep in mind. If you make this part of the group's intitial infrastructure, you risk overwhelming them for the really vital stuff when the server is not always necessary for all projects.
55+
56+
If it is needed, contact Thomas Hetmank or Nick Outin to get a 'team' set up on Aurora for the working group.
57+
58+
:::
59+
60+
## 3. Offer SciComp-Specific Onboarding
61+
62+
After the group has done the LNO onboarding, schedule a time to do SciComp specific onboarding. You'll discuss the types of support the SciComp team can offer as well as the workshops we're currently capable of offering. You'll share the infrastructure you've made with the group.
63+
64+
Critically, _ask the group if they have any tasks on their collective mind already!_
65+
66+
Finally, if this onboarding meeting is for a SPARC group, reiterate that they get one (1) year of SciComp support but they choose when to start that clock. Some groups use the entire year before their in-person meeting while others don't ask for support until after that meeting.

0 commit comments

Comments
 (0)