ga4gh / ga4gh/TASC

[Issue]: Product documentation url standards revision

Open
#85 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
12
Forks
9
Avg merge
1m
Merged PRs (30d)
1

Description

### Issue Title

Create a uniform url and possible website integration for all product online documentation sites

### Issue Type

Product Harmonization

### Problem Statement

Current State:

Various product teams use various platforms such as MKDocs and Readthedocs and github.io etc. but some are using ga4gh sub-domains.

Expected state:

Set up a system of uniform URL aliases for all product documentation sites regardless of platform.

### Scope Validation

Harmonization of Product representation
Easier for GA4GH Web developer to mange changes and additions

### Proposed Solution(s)

Develop a system within the pathways of ga4gh.org to map the documentation sites rather than subdomains.

Shouldn't need any input from other work streams until launch when a list of product doc urls will be required for mapping.

### Estimated Effort Level

Low (1-2 months, minimal resources)

### Success Criteria

When all product documentation sites have uniform url pathways and they are mapped and linked fomr each website product page.

### How will this issue aid GA4GH harmonization?

This enables an easy to find source for all product documentation rather than currently varied and non-unform documentation urls. It also allows quick and easy management of changes within the direct control of GA4GH staff.

### Additional context

Please provide any additional pieces of information you feel is relevant to this issue

### Work Streams Raising This Issue

- [ ] Clinical & Phenotypic Data (Clin/Pheno)
- [ ] Cloud Work Stream
- [ ] Data Security
- [ ] Data Use & Researcher IDs (DURI)
- [ ] Discovery
- [ ] Genomic Knowledge Standards (GKS)
- [ ] Large Scale Genomics (LSG)
- [ ] Regulatory & Ethics (REWS)
- [ ] Data Models & Schemas Committee (DaMaSC)
- [ ] Genomic Implementation Forum (GIF)
- [x] Technical Team
- [ ] Other (specify below)

### Other Groups Raising This Issue

Web Developer

### Work Streams That Will Be Impacted

- [x] Clinical & Phenotypic Data (Clin/Pheno)
- [x] Cloud Work Stream
- [x] Data Security
- [x] Data Use & Researcher IDs (DURI)
- [x] Discovery
- [x] Genomic Knowledge Standards (GKS)
- [ ] Large Scale Genomics (LSG)
- [x] Regulatory & Ethics (REWS)
- [x] Data Models & Schemas Committee (DaMaSC)
- [x] Genomic Implementation Forum (GIF)
- [x] Technical Team
- [x] Other (specify below)

### Other Groups That Will Be Impacted

Web Developer and Communications

### Key Stakeholders to Consult

Product Documentation managers
Sanger web-team

### Products affected

All with documentation

### Additional Context

_No response_

### Priority Level

Medium (should be addressed within 3-6 months)

### Additional Tags

- [x] Documentation
- [ ] API
- [ ] Schema
- [ ] Security
- [ ] Performance
- [ ] Interoperability
- [ ] Compliance
- [x] User Experience
- [ ] Infrastructure
- [ ] Testing

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inventorying the product documentation URLs and platforms mentioned in the issue, then review the existing ga4gh.org product-page pathways. Consult product documentation managers and the Sanger web team to define the alias and mapping requirements. Done means all product documentation sites have uniform URL pathways and are linked from their product pages.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.