Skip to content

Edits to README to provide instructions to contributors #326

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.

Sign up for GitHub

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

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

Edits to README to provide instructions to contributors #326

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
028778e
Changing readme to be contribution instructions
loricooperhdf Sep 30, 2024
f651c06
Update README.md
loricooperhdf Sep 30, 2024
e24ef59
Changed the table for some better flow
loricooperhdf Oct 1, 2024
d1e488d
aesthetics
loricooperhdf Oct 1, 2024
734d6b2
Update README.md
loricooperhdf Oct 1, 2024
5f68ae6
Update README.md
loricooperhdf Oct 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Link to WWW about us
do we have mission statement on WWW?
I didn't find a "search" feature for WWW conttent?


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 <a href="https://support.hdfgroup.org">https://support.hdfgroup.org</a>, 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 | What is it? | GitHub Repo |
| ----- | ---- | ---|
| HDF5 | High-performance data management and storage suite (<a href="https://www.hdfgroup.org/solutions/hdf5/">More info.</a>) | https://github.com/HDFGroup/hdf5 |
| HDFView | A visual tool written in Java for browsing and editing HDF (HDF5 and HDF4) files (<a href="https://www.hdfgroup.org/download-hdfview/">More info.</a>) | https://github.com/HDFGroup/hdfview |
| HSDS | REST-based solution for reading and writing complex binary data formats within object-based storage environments (<a href="https://www.hdfgroup.org/solutions/highly-scalable-data-service-hsds/">More info.</a>) | https://github.com/HDFGroup/hsds |
| HDF4 | A library and multi-object file format for storing and managing data between machines (<a href="https://www.hdfgroup.org/solutions/hdf4/">More info.</a>) | 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 confusing? Yes. Please edit this page if you have a better way to explain this.
Copy link
Collaborator

Choose a reason for hiding this comment

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

sp - Jekyll
"served via AWS S3 Cloudfront"

Let's add a CONTRIBUTING.md page following https://github.com/HDFGroup/hdf5/blob/develop/CONTRIBUTING.md as a model. Of course with some heavy editing. Most notably adding details about using the devcontainer with Codespaces and VSCode.

Same for CODE_OF_CONDUCT, SECURITY, LICENSE?, etc


## Testing Your Changes Before Submitting a PR

<a href="https://docs.github.com/en/pages/quickstart">Set up GitHub pages</a> on your fork to test your changes before submitting.