Skip to content

Commit c4efda4

Browse files
Chen2xChen2x
committed
cleaned and merging into main
2 parents fe9b245 + fcc33a2 commit c4efda4

19 files changed

Lines changed: 540 additions & 21 deletions

‎.adr-dir‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
doc/architecture/decisions

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug in the system
4+
title: "[Bug]: "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
### Description
10+
A clear and concise description of the bug.
11+
12+
### Steps to Reproduce
13+
1. Go to '...'
14+
2. Click on '...'
15+
3. See the error.
16+
17+
### Expected Behavior
18+
Explain what you expected to happen.
19+
20+
### Screenshots
21+
Add screenshots if applicable.
22+
23+
### Environment
24+
- OS: [e.g., Windows, macOS, Linux]
25+
- Browser: [e.g., Chrome, Firefox]
26+
- Version: [e.g., 1.0.0]
27+
28+
### Additional Context
29+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
issue_templates:
2+
- name: "Bug Report"
3+
description: "Report a bug in the system."
4+
title: "[Bug]: "
5+
labels: ["bug"]
6+
body: "./ISSUE_TEMPLATE/bug_report.md"
7+
- name: "Feature Request"
8+
description: "Propose a new feature or improvement."
9+
title: "[Feature]: "
10+
labels: ["enhancement"]
11+
body: "./ISSUE_TEMPLATE/feature_request.md"
12+
- name: "Documentation"
13+
description: "Suggest updates or additions to the documentation."
14+
title: "[Docs]: "
15+
labels: ["documentation"]
16+
body: "./ISSUE_TEMPLATE/documentation.md"
17+
- name: "General Report"
18+
description: "Provide general feedback or inquiries."
19+
title: "[General]: "
20+
labels: ["general"]
21+
body: "./ISSUE_TEMPLATE/general_report.md"

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Documentation
3+
about: Suggest updates or additions to documentation
4+
title: "[Docs]: "
5+
labels: documentation
6+
assignees: ''
7+
---
8+
9+
### Documentation Update
10+
What part of the documentation needs to be updated or added?
11+
12+
### Why Is This Needed?
13+
Explain the importance of this update.
14+
15+
### Suggested Changes
16+
Provide a detailed description of the changes.
17+
18+
### Additional Context
19+
Include any related resources.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or improvement
4+
title: "[Feature]: "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
### Feature Description
10+
What feature would you like to see?
11+
12+
### Why Is This Needed?
13+
Explain the problem or need for this feature.
14+
15+
### Suggested Solutions
16+
Describe how this feature could be implemented.
17+
18+
### Additional Context
19+
Add any relevant screenshots, links, or resources.

‎.github/ISSUE_TEMPLATE/general_report.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: General Report
3+
about: Provide general feedback or inquiries
4+
title: "[General]: "
5+
labels: general
6+
assignees: ''
7+
---
8+
9+
### Feedback or Inquiry
10+
Provide your feedback or inquiry.
11+
12+
### Additional Information
13+
Add any other relevant details here.

‎.github/PULL_REQUEST_TEMPLATE/pr.yml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
body:
2+
- type: markdown
3+
attributes:
4+
value: |
5+
# Pull Request Submission Form
6+
7+
Welcome! This form helps you submit pull requests to the GA4GH Tech Team.
8+
9+
**Before you begin:**
10+
- Ensure you have reviewed the pull request
11+
- Have a associated GitHub Issue(s) ready
12+
13+
---
14+
15+
- type: input
16+
id: pr-title
17+
attributes:
18+
label: PR Title
19+
description: Provide a clear, concise title for your pull request
20+
placeholder: "e.g., Pull request for.. "
21+
validations:
22+
required: true
23+
- type: dropdown
24+
id: request-type
25+
attributes:
26+
label: PR type
27+
description: What does this pull request achieve?
28+
options:
29+
- Fix
30+
- Feature
31+
- Refactor
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: summary
36+
attributes:
37+
label: Summary
38+
description: Description of the pull request
39+
placeholder: |
40+
Describe the intent of the pull request, and what are the associated risks
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: change_info
45+
attributes:
46+
label: Change information
47+
description: Files, etc. changed
48+
placeholder: |
49+
List out the changes to be merged
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: test_info
54+
attributes:
55+
label: Steps to test
56+
description: Testing information
57+
placeholder: |
58+
List out the tests
59+
validations:
60+
required: true
61+
- type: input
62+
id: gh_issue
63+
attributes:
64+
label: GitHub Issue
65+
description: Issue #
66+
placeholder:
67+
validations:
68+
required: true
69+

‎README.md‎

Lines changed: 46 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,47 @@
1-
# analytics-dashboard
2-
Embedded analytics dashboard on GA4GH metrics
1+
![](https://www.ga4gh.org/wp-content/themes/ga4gh-theme/gfx/GA-logo-horizontal-tag-RGB.svg)
32

4-
Sources:
5-
- github
6-
- pypi
7-
- pubmed
3+
# GA4GH Analytics Dashboard
4+
[![](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/ga4gh-discovery/ga4gh-service-registry/develop/LICENSE)
5+
6+
> # An Analytics Dashboard for Everything GA4GH
7+
8+
## Table of Contents
9+
10+
- [Overview](#overview)
11+
- [Getting Started](#getting-started)
12+
- [Usage](#usage)
13+
- [Development](#development)
14+
- [Testing](#testing)
15+
- [Deployment](#deployment)
16+
- [Contribute](#contribute)
17+
- [License](#license)
18+
- [Contacts](#contacts)
19+
20+
---
21+
22+
## Overview
23+
Analytics are important for standards organisations like GA4GH as it helps to make data-driven decisions. The GA4GH Tech Team is building an analytics dashboard to enable our community to quantify the impact of standards, policy frameworks and products that have been actively developed over the last 12 years. The ability to make data-driven decisions will enable GA4GH to deploy implementation-focussed resources where they are needed most, and identify opportunities for impact - furthering our ambition of facilitating responsible, voluntary, and secure use of genomic and health data. To understand the power of these contributions, the dashboard will be a one-stop exhibit of the GA4GH impact. Data sourced from, for example PubMed, PyPI, GitHub, etc., will be displayed in a user-friendly graphical interface.
24+
25+
Collaborators across Work Streams can use this to understand how their contributions advance genomic data sharing in a diverse world, gather intelligence to guide future product development, and identify implementation opportunities.
26+
27+
Sources (will expand):
28+
- GitHub
29+
- PyPI
30+
- PubMed
31+
32+
---
33+
34+
## Contribute
35+
Instructions for contributing, raising issues, or submitting pull requests.
36+
37+
---
38+
39+
## License
40+
Licensed under the Apache License, Version 2.0 (the "License").
41+
42+
---
43+
44+
## Contacts
45+
List maintainers or team contact info:
46+
47+
- Email: ga4gh-tech-team@ga4gh.org

‎doc/architecture/decisions/0001-record-architecture-decisions.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 1. Record architecture decisions
2+
3+
Date: 2025-11-20
4+
5+
## Status
6+
7+
Accepted
8+
9+
## Context
10+
11+
We need to record the architectural decisions made on this project.
12+
13+
## Decision
14+
15+
We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
16+
17+
## Consequences
18+
19+
See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).

‎doc/architecture/decisions/0002-formalise-the-setup-instructions-and-api-information-in-all-notebooks.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 2. Formalise the setup instructions and API information in all notebooks
2+
3+
Date: 2025-11-14
4+
5+
## Status
6+
7+
Accepted
8+
9+
## Context
10+
11+
Currently, each notebook has distinct style/format of sharing setup instructions to the user. Additionally, the API information isn't clear. This makes the user journey difficult, as the contrast in style can be confusing especially for first time users.
12+
13+
## Decision
14+
15+
Formalise the syntax of displaying setup instructions and API information across the notebooks so it is uniform for the user.
16+
17+
## Consequences
18+
19+
It will help the users to switch between the notebooks easily, as all the notebooks would be similar in layout and provide uniformity.

0 commit comments

Comments
 (0)