Skip to content

Commit

Permalink
[Documentation] fix broken links (#627)
Browse files Browse the repository at this point in the history
* byebye dead links

* fix what is broken

* fix the links! add the jsons!

* add helpful website

* fix spacing issue
  • Loading branch information
sage-wright authored Oct 2, 2024
1 parent 8c91ecd commit dcdc5ec
Show file tree
Hide file tree
Showing 26 changed files with 113 additions and 99 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Many more workflows are available, and are documented in detail in the [Theiagen

The PHB repository would not be possible without its predecessors. We would like to acknowledge the following repositories, individuals, and contributors for their influence on the development of these workflows:

The PHB repository originated from collaborative work with Andrew Lang, PhD & his [Genomic Analysis WDL workflows](https://github.com/AndrewLangvt/genomic_analyses). The workflows and task development were influenced by The Broad's [Viral Pipes](https://github.com/broadinstitute/viral-pipelines) repository. The TheiaCoV workflows for viral genomic characterization were influenced by UPHL's [Cecret](https://github.com/UPHL-BioNGS/Cecret) & StaPH-B's [Monroe](https://staph-b.github.io/staphb_toolkit/workflow_docs/monroe/) workflows. The TheiaProk workflows for bacterial genomic characterization were influenced by Robert Petit's [bactopia](https://github.com/bactopia/bactopia). Most importantly, the PHB user community drove the development of these workflows and we are grateful for their feedback and contributions.
The PHB repository originated from collaborative work with Andrew Lang, PhD & his [Genomic Analysis WDL workflows](https://github.com/AndrewLangvt/genomic_analyses). The workflows and task development were influenced by The Broad's [Viral Pipes](https://github.com/broadinstitute/viral-pipelines) repository. The TheiaCoV workflows for viral genomic characterization were influenced by UPHL's [Cecret](https://github.com/UPHL-BioNGS/Cecret) & StaPH-B's Monroe (now deprecated) workflows. The TheiaProk workflows for bacterial genomic characterization were influenced by Robert Petit's [bactopia](https://github.com/bactopia/bactopia). Most importantly, the PHB user community drove the development of these workflows and we are grateful for their feedback and contributions.

If you would like to provide feedback, please raise a [GitHub issue](https://github.com/theiagen/public_health_bioinformatics/issues/new).

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_fasta.organism":"rsv_a"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_fasta.organism":"rsv_b"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_fasta.organism":"WNV"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_fasta.organism":"flu"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_illumina_pe.organism":"HIV","theiacov_illumina_pe.hiv_primer_version":"v1"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_illumina_pe.organism":"HIV","theiacov_illumina_pe.hiv_primer_version":"v2"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_illumina_pe.organism":"rsv_a"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_illumina_pe.organism":"rsv_b"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_illumina_pe.organism":"WNV"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_illumina_pe.organism":"flu"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_illumina_se.organism":"WNV"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_ont.organism":"HIV","theiacov_ont.hiv_primer_version":"v1"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_ont.organism":"HIV","theiacov_ont.hiv_primer_version":"v2"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"theiacov_ont.organism":"flu"}
1 change: 1 addition & 0 deletions docs/contributing/doc_contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Here are some VSCode Extensions can help you write and edit your markdown files

- [Excel to Markdown Table](https://tableconvert.com/excel-to-markdown) - This website will convert an Excel table into markdown format, which can be copied and pasted into your markdown file.
- [Material for MkDocs Reference](https://squidfunk.github.io/mkdocs-material/reference/) - This is the official reference for the Material for MkDocs theme, which will help you understand how to use the theme's features.
- [Broken Link Check](https://www.brokenlinkcheck.com/) - This website will scan your website to ensure that all links are working correctly. This will only work on the deployed version of the documentation, not the local version.

## Documentation Structure

Expand Down
7 changes: 3 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ title: Home

The PHB repository contains workflows for the characterization, genomic epidemiology, and sharing of pathogen genomes of public health concern. Workflows are available for viruses, bacteria, and fungi.

All workflows in the PHB repository end with `_PHB` in order to differentiate them from earlier versions and from the original tools they
incorporate.
All workflows in the PHB repository end with `_PHB` in order to differentiate them from earlier versions and from the original tools they incorporate.

<center>[Explore our workflows](workflows_overview/workflows_type.md){ .md-button .md-button--primary }</center>

Expand All @@ -28,7 +27,7 @@ incorporate.
</div>

!!! dna "Our Open Source Philosophy"
PHB source code is publicly available on [GitHub](https://github.com/theiagen/public_health_bioinformatics) and available under [GNU Affero General Public License v3.0](https://github.com/theiagen/public_health_viral_genomics/blob/main/LICENSE)!
PHB source code is publicly available on [GitHub](https://github.com/theiagen/public_health_bioinformatics) and available under [GNU Affero General Public License v3.0](https://github.com/theiagen/public_health_bioinformatics/blob/main/LICENSE)!

All workflows can be imported directly to [Terra](https://terra.bio/) via the [**Dockstore PHB collection**](https://dockstore.org/organizations/Theiagen/collections/public-health-bioinformatics)!

Expand Down Expand Up @@ -90,7 +89,7 @@ We would like to gratefully acknowledge the following individuals from the publi

The PHB repository would not be possible without its predecessors. We would like to acknowledge the following repositories, individuals, and contributors for their influence on the development of these workflows:

The PHB repository originated from collaborative work with Andrew Lang, PhD & his [Genomic Analysis WDL workflows](https://github.com/AndrewLangvt/genomic_analyses). The workflows and task development were influenced by The Broad's [Viral Pipes](https://github.com/broadinstitute/viral-pipelines) repository. The TheiaCoV workflows for viral genomic characterization were influenced by UPHL's [Cecret](https://github.com/UPHL-BioNGS/Cecret) & StaPH-B's [Monroe](https://staph-b.github.io/staphb_toolkit/workflow_docs/monroe/) workflows. The TheiaProk workflows for bacterial genomic characterization were influenced by Robert Petit's [bactopia](https://github.com/bactopia/bactopia). Most importantly, the PHB user community drove the development of these workflows and we are grateful for their feedback and contributions.
The PHB repository originated from collaborative work with Andrew Lang, PhD & his [Genomic Analysis WDL workflows](https://github.com/AndrewLangvt/genomic_analyses). The workflows and task development were influenced by The Broad's [Viral Pipes](https://github.com/broadinstitute/viral-pipelines) repository. The TheiaCoV workflows for viral genomic characterization were influenced by UPHL's [Cecret](https://github.com/UPHL-BioNGS/Cecret) & StaPH-B's Monroe (now deprecated) workflows. The TheiaProk workflows for bacterial genomic characterization were influenced by Robert Petit's [bactopia](https://github.com/bactopia/bactopia). Most importantly, the PHB user community drove the development of these workflows and we are grateful for their feedback and contributions.

If you would like to provide feedback, please raise a [GitHub issue](https://github.com/theiagen/public_health_bioinformatics/issues/new) or contact us at <[email protected]>.

Expand Down
Loading

0 comments on commit dcdc5ec

Please sign in to comment.