uabrc / uabrc/uabrc.github.io

Case Study Organization

Open
#577 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

style: article/section 📝
Dominant language
Python
Stars
24
Forks
15
Avg merge
10d 3h
Merged PRs (30d)
1

Description

What would you like to see added?

As of now, the Case Studies page is dedicated to our only case study on Parabricks. As we add more case studies, we should choose one of two organization schemes:

  1. Add a case study pertaining to a subject covered in another article as a subpage under that article.
    • For example, if a case study was written about how to use OSG, the case study would be a page nested under the main OSG page or section. Case Studies would then directly link to this article
  2. Turn Case Studies into a landing page and main section and then list all of the individual case study articles as subarticles under that section.
    • For example, a case study on OSG would be its own article nested under the Case Studies section. The Case Studies landing page would then link to it

In either case, the main Case Studies page would then become a host for links to various case studies either spread across the documentation or nested under the main Case Studies section. The Parabricks case study should become its own page as well.

For case studies where there are not already main sections created on how to use the subject of the case study, those should be nested under the Case Studies section until a main section is created, if at all.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Review the current Case Studies page and the existing Parabricks case study first. Decide which of the two proposed organization schemes fits future case studies, then separate Parabricks into its own page and update the Case Studies links so the chosen hierarchy is represented consistently.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.