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

Fix broken links #259

Merged
merged 21 commits into from
Aug 29, 2023
Merged

Fix broken links #259

merged 21 commits into from
Aug 29, 2023

Conversation

ocefpaf
Copy link
Member

@ocefpaf ocefpaf commented Aug 18, 2023

This one is ready but it is best merged after #212 so we can test the GHA here.

@ocefpaf
Copy link
Member Author

ocefpaf commented Aug 18, 2023

The https://compliance.ioos.us/index.html broken link is on us:

Screenshot from 2023-08-18 20-41-28

xref.: ioos/compliance-checker-web#119

@ocefpaf
Copy link
Member Author

ocefpaf commented Aug 19, 2023

For 3 we need to check:

find . -type f -name "*.md" -exec grep "kerfoot" '{}' \; -print  | grep \.\/    

> [Wiki](https://github.com/kerfoot/ioosngdac/wiki) ▸ **Glider Background and Sampling Terminology**
<!-- ![Glider Sampling Patterns and Terms](https://raw.githubusercontent.com/kerfoot/ioosngdac/master/doco/glider-sampling-terminology.png) -->
 + **Profile**: A single vertically oriented track of a glider, either upward or downward through the water column.  A profile is one-half of a **dive**.  The profile is the fundamental atomic data type used by the **NGDAC**.  All data submitted to the **NGDAC** is submitted as individual profiles, containing the various water column properties or sensor values.  Examples of the file format description can be found as [CDL](https://github.com/kerfoot/ioosngdac/blob/master/nc/template/IOOS_Glider_NetCDF_v2.0.cdl), [NetCDF file](https://github.com/kerfoot/ioosngdac/blob/master/nc/template/IOOS_Glider_NetCDF_v2.0.nc) and [ncml](https://github.com/kerfoot/ioosngdac/blob/master/nc/template/IOOS_Glider_NetCDF_v2.0.ncml) can be found [here](https://github.com/kerfoot/ioosngdac/tree/master/nc/template).
./glider-background-and-sampling-terminology.md

> [Wiki](https://github.com/kerfoot/glider-dac/wiki) ▸ **Data Provider Links**
./useful-links.md

> [Wiki](https://github.com/kerfoot/ioosngdac/wiki) ▸ **NGDAC File Submission Process**
./ngdac-netcdf-file-submission-process.md

> [Wiki](https://github.com/kerfoot//glider-dac//wiki) ▸ **NGDAC Architecture**
./ngdac-architecture.md

The first one we need to decided what are we doing with the files their are pointing to:

Screenshot from 2023-08-21 08-26-54

The rest are all links to the wiki. I believe the wiki will be retired so we need to edit these pages to reflect that.

_docs/data-workflow.md Outdated Show resolved Hide resolved
_docs/faqs.md Outdated Show resolved Hide resolved
_docs/glider-background-and-sampling-terminology.md Outdated Show resolved Hide resolved
_docs/glider-background-and-sampling-terminology.md Outdated Show resolved Hide resolved
_docs/glider-background-and-sampling-terminology.md Outdated Show resolved Hide resolved
_docs/glider-dac-communications-plan.md Outdated Show resolved Hide resolved
_docs/index.md Outdated Show resolved Hide resolved
@ocefpaf ocefpaf marked this pull request as ready for review August 21, 2023 11:24
@ocefpaf ocefpaf requested a review from kbailey-noaa August 21, 2023 11:33
_docs/data-workflow.md Outdated Show resolved Hide resolved
_docs/index.md Outdated Show resolved Hide resolved
![Glider Sampling Patterns and Terms](/glider-dac/glider-sampling-terminology.png)

+ **Profile**: A single vertically oriented track of a glider, either upward or downward through the water column. A profile is one-half of a **dive**. The profile is the fundamental atomic data type used by the **NGDAC**. All data submitted to the **NGDAC** is submitted as individual profiles, containing the various water column properties or sensor values. Examples of the file format description can be found as [CDL](https://github.com/kerfoot/ioosngdac/blob/master/nc/template/IOOS_Glider_NetCDF_v2.0.cdl), [NetCDF file](https://github.com/kerfoot/ioosngdac/blob/master/nc/template/IOOS_Glider_NetCDF_v2.0.nc) and [ncml](https://github.com/kerfoot/ioosngdac/blob/master/nc/template/IOOS_Glider_NetCDF_v2.0.ncml) can be found [here](https://github.com/kerfoot/ioosngdac/tree/master/nc/template).
+ **Profile**: A single vertically oriented track of a glider, either upward or downward through the water column. A profile is one-half of a **dive**. The profile is the fundamental atomic data type used by the **NGDAC**. All data submitted to the **NGDAC** is submitted as individual profiles, containing the various water column properties or sensor values. Examples of the file format description can be found as [CDL](/glider-dac/nc/template/IOOS_Glider_NetCDF_v2.0.cdl), [NetCDF file](/glider-dac/nc/template/IOOS_Glider_NetCDF_v2.0.nc) and [ncml](/glider-dac/nc/template/IOOS_Glider_NetCDF_v2.0.ncml) can be found [here](https://github.com/ioos/glider-dac/tree/gh-pages/nc/template).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll probably have to iterate on this relative link. I'm not sure how Jekyll behaves on local vs remote builds. (It has been a while that I used it.) Regardless, after this one is merged, I should probably change these to full links instead of relative ones.

@@ -29,42 +29,36 @@ The following is a list of links for data providers and web applications develop

The IOOS Compliance Checker is a python based tool for data providers to check for completeness and community standard compliance of local or remote netCDF files against metadata standards. This web based tool can be used to check your GliderDAC netCDF files for compliance. Be sure to select **GliderDAC** in the list of available tests to run.

- [**FTP script**](https://github.com/ioos/glider-dac/blob/master/util/ncFtp2ngdac.pl)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@benjwadams can you give your 👍 or 👎 here? As far as I remember this is deprecated, right?

Copy link
Contributor

@kbailey-noaa kbailey-noaa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Numerous comments throughout about link changes and some minor text updates.

_docs/index.md Outdated Show resolved Hide resolved
_docs/ngdac-architecture.md Outdated Show resolved Hide resolved
_docs/ngdac-netcdf-file-format-version-2.md Outdated Show resolved Hide resolved
@@ -94,7 +94,7 @@ Ideally, the <strong>glider_yyyymmddTHHMMSS.nc</strong> files will be provided b
## Global Attributes

The following is the list of required global attributes that must be included in each NetCDF file submitted to the **NGDAC**. This list was created from a variety of sources with the goal of providing a complete metadata record of the data set. More information on these sources can be found at the following locations:
- **CF1.6**: Section 2.6 of v1.6 Climate and Forecast [conventions](http://cfconventions.org/cf-conventions/v1.6.0/cf-conventions.html)
- **CF1.6**: Section 2.6 of v1.6 Climate and Forecast [conventions](https://cfconventions.org/cf-conventions/v1.6.0/cf-conventions.html
- **ACDD**: Attribute Conventions for Dataset Discovery [Home page](http://wiki.esipfed.org/index.php?title=Category:Attribute_Conventions_Dataset_Discovery) and [Current Standard](http://wiki.esipfed.org/index.php/Attribute_Convention_for_Data_Discovery_%28ACDD%29)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -94,7 +94,7 @@ Ideally, the <strong>glider_yyyymmddTHHMMSS.nc</strong> files will be provided b
## Global Attributes

The following is the list of required global attributes that must be included in each NetCDF file submitted to the **NGDAC**. This list was created from a variety of sources with the goal of providing a complete metadata record of the data set. More information on these sources can be found at the following locations:
- **CF1.6**: Section 2.6 of v1.6 Climate and Forecast [conventions](http://cfconventions.org/cf-conventions/v1.6.0/cf-conventions.html)
- **CF1.6**: Section 2.6 of v1.6 Climate and Forecast [conventions](https://cfconventions.org/cf-conventions/v1.6.0/cf-conventions.html
- **ACDD**: Attribute Conventions for Dataset Discovery [Home page](http://wiki.esipfed.org/index.php?title=Category:Attribute_Conventions_Dataset_Discovery) and [Current Standard](http://wiki.esipfed.org/index.php/Attribute_Convention_for_Data_Discovery_%28ACDD%29)
- **NCEI**: Guidance from NOAA's National Centers for Environmental Information on netCDF templates to promote good stewardship and archiving. [NCEI Templates](http://www.nodc.noaa.gov/data/formats/netcdf/) and [global attribute suggestions](http://www.nodc.noaa.gov/data/formats/netcdf/#guidancetable).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to:
NOAA National Centers for Environmental Information (NCEI) netCDF Templates: Guidance from NCEI on netCDF templates to promote good stewardship and archiving. NCEI Templates and global attribute suggestions.

_docs/useful-links.md Outdated Show resolved Hide resolved
@@ -29,7 +29,7 @@ The following is a list of links for data providers and web applications develop

The IOOS Compliance Checker is a python based tool for data providers to check for completeness and community standard compliance of local or remote netCDF files against metadata standards. This web based tool can be used to check your GliderDAC netCDF files for compliance. Be sure to select **GliderDAC** in the list of available tests to run.

- [**FTP script**](https://github.com/ioos/ioosngdac/blob/master/util/ncFtp2ngdac.pl)
- [**FTP script**](https://github.com/ioos/glider-dac/blob/master/util/ncFtp2ngdac.pl)

For automating uploads of [conforming](ngdac-netcdf-file-format-version-2.html) NetCDF files to the DAC ftp server. The script is written in Perl and requires the following non-core modules:
+ [Readonly](http://search.cpan.org/~roode/Readonly-1.03/Readonly.pm)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove or comment out rows 34 -35

@@ -39,13 +39,13 @@ The following is a list of links for data providers and web applications develop
## Submitting Data
- [**Deployment Registration**](https://gliders.ioos.us/providers)

This link will redirect you to the GliderDAC providers page. From there you can login and create deployments. See the wiki section on [New Deplyment Registration](/ioosngdac/ngdac-netcdf-file-submission-process.html#new-deployment-registration) for more details.
This link will redirect you to the GliderDAC providers page. From there you can login and create deployments. See the wiki section on [New Deplyment Registration](/glider-dac/ngdac-netcdf-file-submission-process.html#new-deployment-registration) for more details.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can't point to a separate wiki located elsewhere. Also there's a typo in 'deployment.'
Change the sentence "See the wiki..." to: "See the section on New Deployment Registration for more details.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this linked somewhere?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a "catch-all" link in

**Examples** of the file specification are available as [**NetCDF**](https://github.com/ioos/ioosngdac/blob/master/nc/template/IOOS_Glider_NetCDF_v2.0.nc), [**CDL**](https://github.com/ioos/ioosngdac/blob/master/nc/template/IOOS_Glider_NetCDF_v2.0.cdl), and [**ncml**](https://github.com/ioos/ioosngdac/blob/master/nc/template/IOOS_Glider_NetCDF_v2.0.ncml) are available [here](https://github.com/ioos/ioosngdac/tree/master/nc/template).
pointing to the folder. So I guess that we needed all the files in that folder.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, change row 55 - Dataset Status
to Dataset Status

@kbailey-noaa kbailey-noaa merged commit f59aa4b into ioos:gh-pages Aug 29, 2023
@ocefpaf ocefpaf deleted the fix_links branch August 29, 2023 20:39
ocefpaf added a commit to ocefpaf/ioos-metadata that referenced this pull request Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants