CF Conventions
Creation of a github orgnization profile README (landing page) #469
Replies: 1 comment
-
|
Good idea @DocOtak! I have seen this used nicely for other GitHub organisations and recently I added a short one to @NCAS-CMS in the way you describe.
I think it would be best to have a persistent one, to inform GitHub users about who and what we are under the GitHub/infra realm. My only concern would be that we need to make sure nothing on there gets out of date, so it would need to be kept an eye on (perhaps a virtual/CI eye) though that should only require a quick glance over and link-check at release-time (or some similar schedule for light maintenance). Your ideas and mock-up look great to me so I'd happily take those as the content to use, unless anyone can point out any issues. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
Topic for discussion
While the website is down (and perhaps continuing after it is back up), we could customize the "landing page" that folks see when they first go to https://github.com/cf-convention by adding some special repositories. See for example github's own organizational profile.
To do this, we would create a repository named
.githuband in a directory called profile, add a file in there called README.md. See the instructions in the docs.I modified the homepage markdown a little to potentially fit this role
Potential contents of the README.md based on the index.md homepage
Not sure why the "IMPORTANT" note isn't actually rendering in the following, it should look nice.
Rendered version README.md based on the index.md homepage
CF Metadata Conventions
The CF metadata conventions are designed to promote the processing and sharing of files created with the NetCDF API.
The conventions define metadata that provide a definitive description of what the data in each variable represents, and the spatial and temporal properties of the data.
This enables users of data from different sources to decide which quantities are comparable, and facilitates building applications with powerful extraction, regridding, and display capabilities.
The CF convention includes a standard name table, which defines strings that identify physical quantities.
Initially CF was developed for gridded data from climate and forecast models (hence “CF”) of the atmosphere and ocean, but its use has subsequently extended to other geosciences, and to observations as well as numerical models.
The use of CF is recommended where applicable by Unidata.
Working Draft
Latest release
Latest vocabularies
Questions or comments❓
CF GitHub Discussions is the place for asking questions about how to use CF,
and for discussions and announcements
Other resources
See also the links in the navigation bar at the top of this page.
Proposals for changing CF (GitHub issues):
vocabulary (including standard names), conventions, website and governance
CF GitHub organisation
FAQ
List of software for working with CF
List of projects and activities that use the CF metadata conventions
Paper describing the CF data model and reference software
Overview of CF, presented at 2025 AGU: DOI PDF
More detailed presentation and paper about CF basics
Get involved
CF is developed through open discussion on GitHub.
If you would like to propose a change, make a suggestion, report a problem or ask a question, please see here.
Changes are decided according to the CF governance arrangements.
The CF community embraces a philosophy of producing excellence by maintaining an open and welcoming culture and an environment that promotes debate and inquiry in a respectful, bold and intellectually rigorous fashion.
@cf-convention/info-mgmt
Beta Was this translation helpful? Give feedback.
All reactions