Skip to content

Commit

Permalink
Render bookdown
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 17, 2024
1 parent 6efea08 commit 3ecd9bf
Show file tree
Hide file tree
Showing 19 changed files with 1,667 additions and 17 deletions.
32 changes: 32 additions & 0 deletions docs/01-what-are-champions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# What are AnVIL Champions?

An AnVIL Champion serves as a point person within a community (institution, consortium, research group, geographic region, etc.) who can be a local resource for people interested in using AnVIL. AnVIL Champions help people in their community to understand the benefits of AnVIL, get started using the platform, and find appropriate resources for learning more. They also help AnVIL better meet the needs of their community by communicating feedback to the AnVIL team.

**An AnVIL Champion does not need to be an expert on all things AnVIL!** Primarily, they need to be able to direct people to appropriate resources for finding help, and to serve as a local knowledge store for any community-specific considerations. Examples of ways in which AnVIL Champions can help their community include:

- [Helping new users get started](#onboard): Help new AnVIL users think through setting up their teams, and direct them to AnVIL's Getting Started resources
- Also provide advice about community-specific considerations, such as explaining an institution’s preferred billing mechanism
- [Guiding users to resources for learning more](#learn): Help community members find and navigate to the broad collection of resources for learning more about how to use AnVIL for their specific needs
- [Pointing users towards support channels](#help): Help community members get answers to their specific questions by directing them towards existing channels for receiving help on AnVIL
- [Communicating feedback](#communicate): Gather feedback from your community and communicate it to the AnVIL team
- Also guide community members to appropriate communication channels if they wish to provide feedback directly to the AnVIL team

::: {.reflection}
Here is what AnVIL Champions' interactions might look like:

Sam is an AnVIL Champion in a research consortium and works closely with an analyst, Alex. Alex messages Sam on Slack to ask about running a workflow on AnVIL. Sam responds by pointing to existing AnVIL tutorials and explains the consortium's billing preferences. Sam isn't an expert on workflows, and directs a few specific questions to the AnVIL team through [help.anvilproject.org](https://help.anvilproject.org).
:::

## What do you need to be an AnVIL Champion?

- Basic understanding of AnVIL
- Comfort with new technology
- Willingness to help new users

## Why be an AnVIL Champion?

- Targeted training opportunities
- Streamlined communication with support and developers
- Help your community
- CV / badge e.g. "Served as AnVIL Champion for Consortium X May 2024 - present"

3 changes: 3 additions & 0 deletions docs/02-become-champion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Become an AnVIL Champion {#become-champion}

We are glad you’re interested! If you would like to be an AnVIL Champion for your community (or would like to know more), fill out this [Google Form](https://docs.google.com/forms/d/1YAtZ9dt5l-77ModVXNsJt6oEuiNR6kDJTf_9Bxntdfg/edit) and we will get in touch with you.
37 changes: 37 additions & 0 deletions docs/03-onboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Onboard New Users {#onboard}

Getting started on AnVIL can be a bit overwhelming. As an AnVIL Champion, you can help new users by:

## Discussing Team Configuration

There are several decisions that need to be made when setting up a new group on AnVIL. These can be challenging for new users because they are unfamiliar with the vocabulary and unclear on the implications of their decisions. As an AnVIL Champion, you can help by being familiar with the decisions faced by new users and helping people think through how to set up their team.

Here are some points that people will need to consider when setting up their group(s) on AnVIL:

- **Billing Account** -- What Google Billing Account will you use? Note that a Billing Account is required to store data, conduct analysis, etc.
- **Cost Monitoring** -- Who will monitor spending? Will this person be able to monitor daily/weekly?
- **Team Management** -- Who will oversee the onboarding and offboarding of members? Will this person track the manifest of workspaces?
- **Data Access** -- Which datasets will you be generating or analyzing? Do you already have access to these datasets?
- **Data Analysis** -- Which tools will you need to do your analysis? Are these already Docker-ized / WDL-ized?

::: {.reflection}
If these are new to you, don't worry! The AnVIL team will train you.
:::

## Directing People to Resources

The [Getting Started on AnVIL](https://jhudatascience.org/AnVIL_Book_Getting_Started) book is a great resource for new users that walks them step-by-step through setting up their group.
See [Learn More](#learn) and [Get Help](#help) for additional resources.

## Explaining Community-Specific Considerations

Most communities will have some specific considerations that people should be aware of when working on AnVIL. As an AnVIL Champion, you can help by being the local expert on common questions and concerns for your community. These can include things like:

- **Preferred billing mechanism**: Do individual groups handle their own billing, or is there e.g. an institutional agreement with Google Cloud Platform or a third-party reseller?
- **Cost reporting requirements**: What, if any, reports need to be submitted, what information should they include, and what’s the easiest way to get that out of GCP? Is there someone who needs to be added to the Billing Account so that they can view the GCP spending reports?
- **Data and tools**: Where do people find and access the data and tools they need to carry out their research? If your community is centered around a particular type of data or field of research, then there may be some common datasets and analysis tools that will be broadly useful to members of the community. You can help your community by explaining where these are maintained, how to import them into AnVIL Workspaces, and where to look for help if they are having problems.
- **Security**: If your community regularly works with sensitive or protected data, you can help new users comply with security requirements by explaining common community practices and by connecting them with other members of the community who have dealt with similar concerns and may be able to give them guidance.

You don’t need to be able to answer every question that comes your way! Sharing your experience of getting started on AnVIL and your choices for setting up your team are a valuable starting point for new users. You can be incredibly helpful by being able to answer some of the most common questions that come up within your community, and by making sure your community members are aware of any local requirements for working with AnVIL.


28 changes: 28 additions & 0 deletions docs/04-learn-more.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Learn More {#learn}

There are many resources for people to learn more about how to use AnVIL. As an AnVIL Champion, you can help people find the resources they need for their specific project. This page lists out resources you can direct people to.

## Videos

- [AnVIL Shorts](https://www.youtube.com/playlist?list=PL6aYJ_0zJ4uCABkMngSYjPo_3c-nUUmio): ~2 minute videos providing quick overviews.
- These can provide brief introductions to specific activities (e.g. "Sequence Read Archive (SRA) data on AnVIL"), or can discuss how AnVIL can be useful for people in their various roles (e.g. "AnVIL for Lead Investigators")
- [AnVIL Demos](https://www.youtube.com/playlist?list=PL6aYJ_0zJ4uC978C57P3TgAAfB38uy58E): 30 min walkthroughs of common tasks on AnVIL
- These are recordings of our live AnVIL Demo sessions, in which a member of the AnVIL team walks through a practical demonstration of how to carry out various activities on AnVIL. Some examples include "Single Cell with Bioconductor", "Epigenetics in AnVIL", and "How to combine data across workspaces".
- An index of our videos can be found [here](https://hutchdatascience.org/AnVIL_Collection/youtube-videos.html). You can also browse the [AnVIL YouTube channel](https://www.youtube.com/@anvilprojectorg).

## Reading

- [Getting Started on AnVIL](https://jhudatascience.org/AnVIL_Book_Getting_Started): Online book walking people through account setup and the basics of how to use AnVIL
- Explains how to set up Google Billing Accounts and Terra Billing Projects, create Workspaces on AnVIL, and add team members with appropriate permissions, as well as how to start up tools like RStudio and Galaxy.
- [Cell Genomics paper](https://www.sciencedirect.com/science/article/pii/S2666979X21001063): The official AnVIL paper
- Explains the motivation and purpose for AnVIL, describes the AnVIL ecosystem and interoperability with other platforms, and highlights how AnVIL contributes to improved genomic data sharing efforts.
- [AnVIL Collection](https://hutchdatascience.org/AnVIL_Collection/): Website listing additional books and videos
- The AnVIL team provides a growing collection of resources to help AnVIL users. The complete list is available at the AnVIL Collection website.

## Activities

- [anvilproject.org/events](http://anvilproject.org/events): Lists upcoming workshops that users can register for
- Includes online events, such as the monthly AnVIL Demos series, as well as in-person events such as workshop sessions held at various conferences.
- [AnVIL Demos (self-study)](https://hutchdatascience.org/AnVIL_Demos/): Materials for some of the AnVIL Demos have been made available for self-study.
- These provide a hands-on walkthrough that users can access at any time, covering topics such as "Create Workflows with Galaxy", and "Single Cell with Bioconductor".

8 changes: 8 additions & 0 deletions docs/05-get-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Get Help {#help}

As an AnVIL Champion, your job is *not* to answer every question about AnVIL. You can help people find answers to their specific questions by directing them towards existing channels for receiving help on AnVIL.

If people have questions, there are a few places they can go to get help:

- [AnVIL Support Forum](https://help.anvilproject.org): The AnVIL Support forum is always available, and the AnVIL team regularly monitors the support forum and responds to questions. By posting in the support forum, other AnVIL users can also benefit from the questions and responses.
- [AnVIL Demos](https://help.anvilproject.org/c/demos/): ~Monthly 30-min Zoom demonstration followed by open Q&A provides an opportunity for live interactions with members of the AnVIL team.
8 changes: 8 additions & 0 deletions docs/06-communicate-feedback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Communicate Feedback {#communicate}

An important part of being an AnVIL Champion is to communicate feedback from your community to the AnVIL team. AnVIL Champions serve as our real-life quality control by helping us understand the needs and challenges of their community. As you help your community members navigate AnVIL, take note of what people find confusing or frustrating and what tools, guides, or features they feel are missing, and let us know!

You can help with this by communicating with the AnVIL team yourself, as well as by directing members of your community towards communication channels where they can contact us themselves. We encourage open communication through

- Posting in the [AnVIL Support forum](http://help.anvilproject.org)
- Contacting one of the [Working Groups](https://anvilproject.org/team/working-groups)
23 changes: 21 additions & 2 deletions docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@



<meta name="date" content="2024-09-16" />
<meta name="date" content="2024-09-17" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -88,9 +88,28 @@
<li class="divider"></li>
<li class="chapter" data-level="" data-path="index.html"><a href="index.html"><i class="fa fa-check"></i>About this Book</a>
<ul>
<li class="chapter" data-level="" data-path="index.html"><a href="index.html#inspired-by"><i class="fa fa-check"></i>Inspired by</a></li>
<li class="chapter" data-level="" data-path="index.html"><a href="index.html#anvil-collection"><i class="fa fa-check"></i>AnVIL Collection</a></li>
</ul></li>
<li class="chapter" data-level="1" data-path="what-are-anvil-champions.html"><a href="what-are-anvil-champions.html"><i class="fa fa-check"></i><b>1</b> What are AnVIL Champions?</a>
<ul>
<li class="chapter" data-level="1.1" data-path="what-are-anvil-champions.html"><a href="what-are-anvil-champions.html#what-do-you-need-to-be-an-anvil-champion"><i class="fa fa-check"></i><b>1.1</b> What do you need to be an AnVIL Champion?</a></li>
<li class="chapter" data-level="1.2" data-path="what-are-anvil-champions.html"><a href="what-are-anvil-champions.html#why-be-an-anvil-champion"><i class="fa fa-check"></i><b>1.2</b> Why be an AnVIL Champion?</a></li>
</ul></li>
<li class="chapter" data-level="2" data-path="become-champion.html"><a href="become-champion.html"><i class="fa fa-check"></i><b>2</b> Become an AnVIL Champion</a></li>
<li class="chapter" data-level="3" data-path="onboard.html"><a href="onboard.html"><i class="fa fa-check"></i><b>3</b> Onboard New Users</a>
<ul>
<li class="chapter" data-level="3.1" data-path="onboard.html"><a href="onboard.html#discussing-team-configuration"><i class="fa fa-check"></i><b>3.1</b> Discussing Team Configuration</a></li>
<li class="chapter" data-level="3.2" data-path="onboard.html"><a href="onboard.html#directing-people-to-resources"><i class="fa fa-check"></i><b>3.2</b> Directing People to Resources</a></li>
<li class="chapter" data-level="3.3" data-path="onboard.html"><a href="onboard.html#explaining-community-specific-considerations"><i class="fa fa-check"></i><b>3.3</b> Explaining Community-Specific Considerations</a></li>
</ul></li>
<li class="chapter" data-level="4" data-path="learn.html"><a href="learn.html"><i class="fa fa-check"></i><b>4</b> Learn More</a>
<ul>
<li class="chapter" data-level="4.1" data-path="learn.html"><a href="learn.html#videos"><i class="fa fa-check"></i><b>4.1</b> Videos</a></li>
<li class="chapter" data-level="4.2" data-path="learn.html"><a href="learn.html#reading"><i class="fa fa-check"></i><b>4.2</b> Reading</a></li>
<li class="chapter" data-level="4.3" data-path="learn.html"><a href="learn.html#activities"><i class="fa fa-check"></i><b>4.3</b> Activities</a></li>
</ul></li>
<li class="chapter" data-level="5" data-path="help.html"><a href="help.html"><i class="fa fa-check"></i><b>5</b> Get Help</a></li>
<li class="chapter" data-level="6" data-path="communicate.html"><a href="communicate.html"><i class="fa fa-check"></i><b>6</b> Communicate Feedback</a></li>
<li class="chapter" data-level="" data-path="about-the-authors.html"><a href="about-the-authors.html"><i class="fa fa-check"></i>About the Authors</a></li>
<li class="divider"></li>
<p style="text-align:center;"> <a href="https://github.com/jhudsl/OTTR_Template" target="blank" > This content was published with</a> <a href="https://bookdown.org/" target="blank"> bookdown by: </a> </p>
Expand Down
2 changes: 1 addition & 1 deletion docs/About.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ These credits are based on our [course contributors table guidelines](https://gi
## collate en_US.UTF-8
## ctype en_US.UTF-8
## tz Etc/UTC
## date 2024-09-16
## date 2024-09-17
## pandoc 3.1.1 @ /usr/local/bin/ (via rmarkdown)
##
## ─ Packages ───────────────────────────────────────────────────────────────────
Expand Down
29 changes: 24 additions & 5 deletions docs/about-the-authors.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@



<meta name="date" content="2024-09-16" />
<meta name="date" content="2024-09-17" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
<meta name="apple-mobile-web-app-status-bar-style" content="black" />

<link rel="shortcut icon" href="assets/AnVIL_style/anvil_favicon.ico" type="image/x-icon" />
<link rel="prev" href="index.html"/>
<link rel="prev" href="communicate.html"/>

<script src="libs/jquery-3.6.0/jquery-3.6.0.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/fuse.min.js"></script>
Expand Down Expand Up @@ -88,9 +88,28 @@
<li class="divider"></li>
<li class="chapter" data-level="" data-path="index.html"><a href="index.html"><i class="fa fa-check"></i>About this Book</a>
<ul>
<li class="chapter" data-level="" data-path="index.html"><a href="index.html#inspired-by"><i class="fa fa-check"></i>Inspired by</a></li>
<li class="chapter" data-level="" data-path="index.html"><a href="index.html#anvil-collection"><i class="fa fa-check"></i>AnVIL Collection</a></li>
</ul></li>
<li class="chapter" data-level="1" data-path="what-are-anvil-champions.html"><a href="what-are-anvil-champions.html"><i class="fa fa-check"></i><b>1</b> What are AnVIL Champions?</a>
<ul>
<li class="chapter" data-level="1.1" data-path="what-are-anvil-champions.html"><a href="what-are-anvil-champions.html#what-do-you-need-to-be-an-anvil-champion"><i class="fa fa-check"></i><b>1.1</b> What do you need to be an AnVIL Champion?</a></li>
<li class="chapter" data-level="1.2" data-path="what-are-anvil-champions.html"><a href="what-are-anvil-champions.html#why-be-an-anvil-champion"><i class="fa fa-check"></i><b>1.2</b> Why be an AnVIL Champion?</a></li>
</ul></li>
<li class="chapter" data-level="2" data-path="become-champion.html"><a href="become-champion.html"><i class="fa fa-check"></i><b>2</b> Become an AnVIL Champion</a></li>
<li class="chapter" data-level="3" data-path="onboard.html"><a href="onboard.html"><i class="fa fa-check"></i><b>3</b> Onboard New Users</a>
<ul>
<li class="chapter" data-level="3.1" data-path="onboard.html"><a href="onboard.html#discussing-team-configuration"><i class="fa fa-check"></i><b>3.1</b> Discussing Team Configuration</a></li>
<li class="chapter" data-level="3.2" data-path="onboard.html"><a href="onboard.html#directing-people-to-resources"><i class="fa fa-check"></i><b>3.2</b> Directing People to Resources</a></li>
<li class="chapter" data-level="3.3" data-path="onboard.html"><a href="onboard.html#explaining-community-specific-considerations"><i class="fa fa-check"></i><b>3.3</b> Explaining Community-Specific Considerations</a></li>
</ul></li>
<li class="chapter" data-level="4" data-path="learn.html"><a href="learn.html"><i class="fa fa-check"></i><b>4</b> Learn More</a>
<ul>
<li class="chapter" data-level="4.1" data-path="learn.html"><a href="learn.html#videos"><i class="fa fa-check"></i><b>4.1</b> Videos</a></li>
<li class="chapter" data-level="4.2" data-path="learn.html"><a href="learn.html#reading"><i class="fa fa-check"></i><b>4.2</b> Reading</a></li>
<li class="chapter" data-level="4.3" data-path="learn.html"><a href="learn.html#activities"><i class="fa fa-check"></i><b>4.3</b> Activities</a></li>
</ul></li>
<li class="chapter" data-level="5" data-path="help.html"><a href="help.html"><i class="fa fa-check"></i><b>5</b> Get Help</a></li>
<li class="chapter" data-level="6" data-path="communicate.html"><a href="communicate.html"><i class="fa fa-check"></i><b>6</b> Communicate Feedback</a></li>
<li class="chapter" data-level="" data-path="about-the-authors.html"><a href="about-the-authors.html"><i class="fa fa-check"></i>About the Authors</a></li>
<li class="divider"></li>
<p style="text-align:center;"> <a href="https://github.com/jhudsl/OTTR_Template" target="blank" > This content was published with</a> <a href="https://bookdown.org/" target="blank"> bookdown by: </a> </p>
Expand Down Expand Up @@ -270,7 +289,7 @@ <h1>About the Authors<a href="about-the-authors.html#about-the-authors" class="a
## collate en_US.UTF-8
## ctype en_US.UTF-8
## tz Etc/UTC
## date 2024-09-16
## date 2024-09-17
## pandoc 3.1.1 @ /usr/local/bin/ (via rmarkdown)
##
## ─ Packages ───────────────────────────────────────────────────────────────────
Expand Down Expand Up @@ -349,7 +368,7 @@ <h1>About the Authors<a href="about-the-authors.html#about-the-authors" class="a
</div>
</div>
</div>
<a href="index.html" class="navigation navigation-prev navigation-unique" aria-label="Previous page"><i class="fa fa-angle-left"></i></a>
<a href="communicate.html" class="navigation navigation-prev navigation-unique" aria-label="Previous page"><i class="fa fa-angle-left"></i></a>

</div>
</div>
Expand Down
Loading

0 comments on commit 3ecd9bf

Please sign in to comment.