Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing links and references update at the bibliography section #266

Closed
cofinoa opened this issue May 7, 2020 · 5 comments · Fixed by #455
Closed

Missing links and references update at the bibliography section #266

cofinoa opened this issue May 7, 2020 · 5 comments · Fixed by #455
Labels
defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors

Comments

@cofinoa
Copy link
Contributor

cofinoa commented May 7, 2020

Title

Missing links and references update at the bibliography section

Moderator

None

Requirement Summary

References needs an update and fixing

Technical Proposal Summary

Better and appropriate references

Benefits

Who or what will benefit from this proposal?

Status Quo

The documentation has some broken links and old style references

Detailed Proposal

These are the changes:
master...cofinoa:cofinoa-fix-biblio-section
and these are the corresponding commits:

  1. 5c50736
  2. 0ea0cc3
  3. 465ee75 (Added @lesserwhirls url for NUG)

With the following major changes:

  1. [NETCDF] reference use DOI conforming UNIDATA's citing requirement. https://www.unidata.ucar.edu/community/index.html#acknowledge
  2. [NUG] reference pointed to a broken link. Now points to a valid link and the right version (4.4.1.1) and release date has been added
  3. [OGC_WKT-CRS] updated link and doc id
  4. [OGP-EPSG_GN7_2] update link and reference to last version form september 2019.
  5. [SCH02] DOI link added
  6. [Snyder] URL it's broken. Added link to pdf document. Added DOI (but it forwards to broken link at USGS, we should just left the DOI number and remove link?)
  7. [UDUNITS] same as [NETCDF]
  8. Some extra white spaces has been removed.
@cofinoa cofinoa added the defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors label May 7, 2020
@lesserwhirls
Copy link
Contributor

This is great! I would only add that we (mostly @WardF) have been working on breaking out the NUG from the netCDF-C/C++ documentation, and it is currently available at:

https://www.unidata.ucar.edu/software/netcdf/documentation/NUG/

The hope is that it will be useful beyond a language agnostic description of netCDF (the data model, file format specification, best practices, etc.), which is critical on its own, but also serve as an entry point for community advancement of netCDF in general.

@JonathanGregory
Copy link
Contributor

JonathanGregory commented Sep 14, 2023

Dear all

Most of the updates to the bibliography prepared by @cofinoa have already been implemented. Since it's two years since he opened this, as a defect, we can implement the rest. I have prepared PR 455 to do this, namely

  • Use DOIs as the links for NetCDF and UDUNITS.
  • Add the DOI for SCH02.
  • Revise the link for ESPG Guidance Note 7 Part 2. For this one, I've put the link to the ESPG Guidance Note as a whole, for future-proofing, instead of a link directly to the latest version of Part 2.

In addition, I have

  • Deleted the bibliography entry for OGC-EPSG, because it's never used in the conventions document.
  • Used the DOI as the link for IEEE_754, which was given in the text.
  • Deleted the DOIs in the text, because they are used as the links, so we don't need to see them as well (the document was inconsistent about this).
  • Used italic for the journal name in CFDM, to match SCH02.

Please could someone check this and merge if OK?

Thanks

Jonathan

@larsbarring
Copy link
Contributor

This is looking good, one small comment though: Despite what they (IEEE) themselves suggest, I think that we should change this slightly:

[IEEE_754] IEEE Standard for Floating-Point Arithmetic, in IEEE Std 754-2019 (Revision of IEEE 754-2008), vol., no., pp.1-84, 22 July 2019, doi: 10.1109/IEEESTD.2019.8766229.

@JonathanGregory
Copy link
Contributor

Yes, good point, @larsbarring! The page and volume number are non-existent, and 1-84 is the complete page range of the document! I have updated the PR as you suggest.

@larsbarring
Copy link
Contributor

Closing this as resolved via PR #455

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants