iobis / manual

The OBIS manual
5 stars 24 forks source link

list of small issues like broken links and typos #77

Closed sformel-usgs closed 9 months ago

sformel-usgs commented 1 year ago

Elizabeth asked me to put my feedback in one issue. Sorry I don't have time to do a PR right now, but I can pitch in later if time is short for y'all too.

  1. section 1.5 3.
    • [x] Typo in section header: 'Frequency' should be changed to 'Frequently'
  2. section 1.5.0.4
  3. section 1.5.0.6
  4. section 2
    • [x] bad link format: "run a series of quality control measures"
    • [x] replace '.md' with '.html'
  5. section 2.1
    • [x] bad link: "Data from OBIS is accessible in numerous ways[LINK to access section] "
    • [x] needs link
  6. section 2.1:
    • [x] bad link format: "Your dataset can be associated with a DOI"
    • [x] needs link
  7. section 2.3
    • [x] bad link format: "moved into the extendedMeasurementOrFact table"
    • [x] needs link
  8. section 2.4.1.1
  9. section 2.4.1.1
    • [x] link to OBIS xsd resolves to general OBIS website: "an OBIS extension"
    • [x] needs updated link
  10. section 2.4.1.3.1
    • [x] misspelling
    • [x] correct AlphiaID to AphiaID
  11. section 2.4.1.3.1
    • [x] misspelling
    • [x] correct belowe to below
  12. Section 2.4.1.3.1 misspelling
    • [x] 'NO'should be corrected to 'ON' in "The use and definitions for additional NO signs"
  13. section 2.4.1.3.3
    • [x] dissonant guidance with GBIF DNA publishing guide
    • [x] "or MachineObservation (e.g. for occurrences based on automated sensors such as DNA sequencers, image recognition etc)."
    • [x] but DNA publishing guide says use 'MaterialSample'
    • [x] also occurs in section 4.8.1
  14. section 2.4.2.2.3
    • [x] Duncan et al. (2021) resolves to ambiguous search results (or at least I was expecting a single document).
    • [x] other occurences throughout the manual
  15. section 2.4.4
    • [x] link resolves to generic page: "See more information on EML."
    • [x] need to update link
  16. section 2.4.4
    • [x] link resolves to obis homepage: "Also read the guidelines on the sharing and use of data in OBIS."
    • [x] update link
  17. section 4.6.1
    • [x] incorrect link: "will occur within the extendedMeasurementOrFact extension."
    • [x] need to update link
  18. section 4.8.2.1
    • [x] broken link: "The Data Carpentries have produced this exercise"
    • [x] need to update link
  19. section 4.8.4.2.3
    • [x] duplication of the word 'here'
  20. section 4.9.1.2.1
  21. section 4.9.1.3.2
    • [x] subsection 'content' seems like it's just links to the next three subesctions? Not sure of it's function.
  22. section 5.3
    • [x] broken link: "As you are following the guidelines in this manual to format data"
    • [x] need to update link
  23. section 5.4
  24. section 5.6.2
    • [x] bad link format: For information on how to use this tool, see below.
    • [x] need to update link
  25. section 6.2.3.
silasprincipe commented 1 year ago

Adding to the list, on section 2.4.1.3.2 Occurrence, the final example table is not rendering:

image