search

hubmapconsortium / software-docs

2 stars 2 forks source link

Confirm that each document is linked to from the top level #9

Open mccalluc opened 3 years ago

mccalluc commented 3 years ago

Follow-up from https://github.com/hubmapconsortium/portal-ui/pull/1967

schwenk102 commented 3 years ago

hubmapconsortium/portal-ui#1967 seemed like it is redirected to docs/technical.

schwenk102 commented 3 years ago

@cebriggs7135 and @schwenk102 are waiting for deliverables to be specified.

cebriggs7135 commented 3 years ago

@mccalluc RE; linking to top level of a doc (rather than a section within?), which docs need this fix? Where have you seen links to a section rather than the top of a doc?

mccalluc commented 3 years ago

Clarifying:

$ for MD in *.md; do STEM=`echo $MD | perl -pne 's/.md$//'`; echo "Looking for docs/$STEM..."; fgrep "docs/$STEM)" *.md > /dev/null || echo "No reference to $MD"; done
Looking for docs/README...
No reference to README.md
Looking for docs/about...
No reference to about.md
Looking for docs/apis...
Looking for docs/assays...
Looking for docs/consent...
Looking for docs/data-states...
No reference to data-states.md
Looking for docs/datasets...
Looking for docs/donor...
Looking for docs/faq...
Looking for docs/feedback...
No reference to feedback.md
Looking for docs/infrastructure...
Looking for docs/metadata...
Looking for docs/pipelines...
Looking for docs/release-summer-2020...
No reference to release-summer-2020.md
Looking for docs/software...
No reference to software.md
Looking for docs/technical...
No reference to technical.md

No reference to README.md: Not a problem. No reference to about.md: Not a problem: In menu. No reference to data-states.md: Problem -- Nothing seems to reference this. No reference to feedback.md: Problem -- Nothing seems to reference this. No reference to release-summer-2020.md: Problem -- Nothing seems to reference this. No reference to software.md: Problem -- Nothing seems to reference this. No reference to technical.md: Not a problem: In menu.

pecan88 commented 3 years ago

@schwenk102 - would you please review or turf this to JH within Pitt-DBMI?

pecan88 commented 3 years ago

@JAH386 - heads up re: this discussion. Would you please work with @schwenk102 to resolve?