Skip to content

[Issue]: Product documentation url standards revision #85

Description

@JonTurnerGA4GH

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)
  • Technical Team
  • Other (specify below)

Other Groups Raising This Issue

Web Developer

Work Streams That Will Be Impacted

  • 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)
  • Technical Team
  • 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

  • Documentation
  • API
  • Schema
  • Security
  • Performance
  • Interoperability
  • Compliance
  • User Experience
  • Infrastructure
  • Testing

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions