Edits to README to provide instructions to contributors #326
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
loricooperhdf
requested review from
derobins,
byrnHDF,
lkurz and
bmribler
as code owners
lkurz
reviewed
Oct 21, 2024
| @@ -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. | |||
There was a problem hiding this comment.
Link to WWW about us
do we have mission statement on WWW?
I didn't find a "search" feature for WWW conttent?
lkurz
reviewed
Oct 21, 2024
|
|
||
| # 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. |
There was a problem hiding this comment.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I feel like this still needs work but perhaps better than what's there currently. Requested in issue #313.