From 028778e00504bf2252daa9fde06da581fb0429fe Mon Sep 17 00:00:00 2001 From: Lori Cooper Date: Mon, 30 Sep 2024 13:31:09 -0500 Subject: [PATCH 1/6] Changing readme to be contribution instructions --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 423f20cd..8b149178 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ -# The HDF Group +# The HDF Group Documentation Project Our **non-profit mission** is to ensure efficient and equitable access to science and engineering data across platforms and environments, now and forever. -People around the world rely on open source HDF software and use it to solve some of the most challenging data management problems. +People around the world rely on open source HDF software and use it to solve some of the most challenging data management problems. This repository provides a front end for https://support.hdfgroup.org, the one-stop shop for help and documentation on HDF5 software. These software projects include: -![Map showing HDF5 downloads.](/assets/img/DownloadMapJan2022.png) +| Project Name | About | GitHub Repo | +| ----- | ---- | ---| +| HDF5 | High-performance data management and storage suite | https://github.com/HDFGroup/hdf5 | +| HDFView | HDFView is a visual tool written in Java for browsing and editing HDF (HDF5 and HDF4) files. | https://github.com/HDFGroup/hdfview | +| HSDS | HSDS is a REST-based solution for reading and writing complex binary data formats within object-based storage environments. | https://github.com/HDFGroup/hsds | +| HDF4 | HDF4® is a library and multi-object file format for storing and managing data between machines. | https://github.com/HDFGroup/hdf4 | + +# Contribute + +This repo provides the framework for the introductory pages (i.e. content for the top level pages) of The HDF Group's documentation for the above projects. These pages are build using Jeckyl and served via Github Pages. Feel free to contribute PRs and issues here, however if your contribution is specifically related to the documentation of those projects, those contributions belong in the repo for that project. Is it confusiong? Yes. Please edit this page if you have a better way to explain this. + +# Testing Your Changes Before Submitting a PR + +Set up GitHub pages on your fork to test your changes before submitting. From f651c060be137b0711732bb1691d39d54fff1b02 Mon Sep 17 00:00:00 2001 From: Lori Cooper Date: Mon, 30 Sep 2024 13:31:55 -0500 Subject: [PATCH 2/6] Update README.md typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8b149178..959a0cad 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ People around the world rely on open source HDF software and use it to solve som # Contribute -This repo provides the framework for the introductory pages (i.e. content for the top level pages) of The HDF Group's documentation for the above projects. These pages are build using Jeckyl and served via Github Pages. Feel free to contribute PRs and issues here, however if your contribution is specifically related to the documentation of those projects, those contributions belong in the repo for that project. Is it confusiong? Yes. Please edit this page if you have a better way to explain this. +This repo provides the framework for the introductory pages (i.e. content for the top level pages) of The HDF Group's documentation for the above projects. These pages are build using Jeckyl and served via Github Pages. Feel free to contribute PRs and issues here, however if your contribution is specifically related to the documentation of those projects, those contributions belong in the repo for that project. Is it confusing? Yes. Please edit this page if you have a better way to explain this. # Testing Your Changes Before Submitting a PR From e24ef59a45e9967517a18d08e1c52c0f90f9f851 Mon Sep 17 00:00:00 2001 From: Lori Cooper Date: Tue, 1 Oct 2024 10:35:25 -0500 Subject: [PATCH 3/6] Changed the table for some better flow --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 959a0cad..d2f49a4e 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,12 @@ Our **non-profit mission** is to ensure efficient and equitable access to scienc People around the world rely on open source HDF software and use it to solve some of the most challenging data management problems. This repository provides a front end for https://support.hdfgroup.org, the one-stop shop for help and documentation on HDF5 software. These software projects include: -| Project Name | About | GitHub Repo | +| Project Name | What is it? | GitHub Repo | | ----- | ---- | ---| -| HDF5 | High-performance data management and storage suite | https://github.com/HDFGroup/hdf5 | -| HDFView | HDFView is a visual tool written in Java for browsing and editing HDF (HDF5 and HDF4) files. | https://github.com/HDFGroup/hdfview | -| HSDS | HSDS is a REST-based solution for reading and writing complex binary data formats within object-based storage environments. | https://github.com/HDFGroup/hsds | -| HDF4 | HDF4® is a library and multi-object file format for storing and managing data between machines. | https://github.com/HDFGroup/hdf4 | +| HDF5 | High-performance data management and storage suiteMore info. | https://github.com/HDFGroup/hdf5 | +| HDFView | A visual tool written in Java for browsing and editing HDF (HDF5 and HDF4) files More info. | https://github.com/HDFGroup/hdfview | +| HSDS | REST-based solution for reading and writing complex binary data formats within object-based storage environmentsMore info. | https://github.com/HDFGroup/hsds | +| HDF4 | A library and multi-object file format for storing and managing data between machines More info. | https://github.com/HDFGroup/hdf4 | # Contribute From d1e488d3460855ca6ddd9bf048b2f0d4ccf7ec1c Mon Sep 17 00:00:00 2001 From: Lori Cooper Date: Tue, 1 Oct 2024 10:36:23 -0500 Subject: [PATCH 4/6] aesthetics --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d2f49a4e..03c36b8e 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,10 @@ People around the world rely on open source HDF software and use it to solve som | Project Name | What is it? | GitHub Repo | | ----- | ---- | ---| -| HDF5 | High-performance data management and storage suiteMore info. | https://github.com/HDFGroup/hdf5 | -| HDFView | A visual tool written in Java for browsing and editing HDF (HDF5 and HDF4) files More info. | https://github.com/HDFGroup/hdfview | -| HSDS | REST-based solution for reading and writing complex binary data formats within object-based storage environmentsMore info. | https://github.com/HDFGroup/hsds | -| HDF4 | A library and multi-object file format for storing and managing data between machines More info. | https://github.com/HDFGroup/hdf4 | +| HDF5 | High-performance data management and storage suite (More info.) | https://github.com/HDFGroup/hdf5 | +| HDFView | A visual tool written in Java for browsing and editing HDF (HDF5 and HDF4) files (More info.) | https://github.com/HDFGroup/hdfview | +| HSDS | REST-based solution for reading and writing complex binary data formats within object-based storage environments (More info.) | https://github.com/HDFGroup/hsds | +| HDF4 | A library and multi-object file format for storing and managing data between machines (More info.) | https://github.com/HDFGroup/hdf4 | # Contribute From 734d6b2254b63627e59a9c304e60dcae078cf4cb Mon Sep 17 00:00:00 2001 From: Lori Cooper Date: Tue, 1 Oct 2024 10:36:56 -0500 Subject: [PATCH 5/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 03c36b8e..d248bb95 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,6 @@ People around the world rely on open source HDF software and use it to solve som This repo provides the framework for the introductory pages (i.e. content for the top level pages) of The HDF Group's documentation for the above projects. These pages are build using Jeckyl and served via Github Pages. Feel free to contribute PRs and issues here, however if your contribution is specifically related to the documentation of those projects, those contributions belong in the repo for that project. Is it confusing? Yes. Please edit this page if you have a better way to explain this. -# Testing Your Changes Before Submitting a PR +# # Testing Your Changes Before Submitting a PR Set up GitHub pages on your fork to test your changes before submitting. From 5f68ae6fe0f38c2a8b42f79433f35e3638bc3a5e Mon Sep 17 00:00:00 2001 From: Lori Cooper Date: Tue, 1 Oct 2024 10:37:06 -0500 Subject: [PATCH 6/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d248bb95..72f70752 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,6 @@ People around the world rely on open source HDF software and use it to solve som This repo provides the framework for the introductory pages (i.e. content for the top level pages) of The HDF Group's documentation for the above projects. These pages are build using Jeckyl and served via Github Pages. Feel free to contribute PRs and issues here, however if your contribution is specifically related to the documentation of those projects, those contributions belong in the repo for that project. Is it confusing? Yes. Please edit this page if you have a better way to explain this. -# # Testing Your Changes Before Submitting a PR +## Testing Your Changes Before Submitting a PR Set up GitHub pages on your fork to test your changes before submitting.