Skip to content

Commit

Permalink
Merge pull request #552 from JonathanGregory/faq241104
Browse files Browse the repository at this point in the history
Update FAQ for GitHub Discussions
  • Loading branch information
JonathanGregory authored Nov 10, 2024
2 parents 7e6ed38 + 85014ea commit 06c1550
Showing 1 changed file with 17 additions and 19 deletions.
36 changes: 17 additions & 19 deletions faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Many of the principles of CF operations follow the proposals at these [rules for
### How long has CF been around? Is it mature?

Work began on CF in 2001 and [Version 1.0](/Data/cf-conventions/cf-conventions-1.0/build/cf-conventions.html) was released in October 2003.
Now at Version 1.11, it has been used for tens of thousands of distinct netCDF products, has an active discussion list with hundreds of participants, and is a mature technical specification.
Now at Version 1.11, it has been used for tens of thousands of distinct netCDF products, continues to develop through [discussions][cf-discussion-page] involving hundreds of participants, and is a mature technical specification.
Because it is community-supported and community-driven, turnaround on questions and changes can take a little time, but are generally thoroughly considered.

### How does CF relate to other conventions/specifications (especially COARDS and netCDF)?
Expand Down Expand Up @@ -78,32 +78,27 @@ So for example the CF Standard Names attempt to be as general and well-defined a

### How do I find previously asked questions about CF?

The first way is to check this FAQ. If you can't find your question answered here, you could search for it in the [CF discussion GitHub repository][cf-discuss-issues] for questions asked since 2020, or for earlier questions in the [CF mailing list][mailing-list-archive].
The first way is to check this FAQ. If you can't find your question answered here, you could search for it in the [CF GitHub Discussions][cf-discussions], or in the archives listed on the [discussion page][cf-discussion-page].

### How do I ask questions about CF?

First, please see whether your question has already been answered (see [question above](#how-do-i-find-previously-asked-questions-about-cf)).
Questions about the CF Convention, including its Standard Names list, may be asked by raising new `question` issues in the [CF discussion GitHub repository][cf-discuss-issues].
Questions about the CF Convention, including its Standard Names list, may be asked by [starting a new Q&A discussion](https://github.com/orgs/cf-convention/discussions/new?category=q-a-about-using-cf).
CF community members usually respond within a day to simple questions, but allow more time if you have an advanced technical topic.

### How do I propose a change?

Changes to the CF standard and the Standard Names are generally proposed first on the [CF discussion GitHub repository][cf-discuss-repo] as an [issue][cf-discuss-issues].
See [How do I ask for a new standard name?](#how-do-i-ask-for-a-new-standard-name) to learn more about changes to the Standard Names list.

A change to the CF standard itself may be discussed initially in an issue in the [CF discussion GitHub repository][cf-discuss-issues], but must be presented and agreed to in detail as a [CF conventions issue][cf-conventions-issues], where the explicit change being requested can be refined.

### What is the process for accepting a change to the CF convention?

The community discusses requests for changes via the mail list and trac site, and may ask questions or recommend changes.
If no one raises objections or concerns about the change (modified as needed to address any issues) for the period of time required for that document, it is considered accepted.
The moderators of the list typically make a final statement of acceptance once that stage has been reached.
### How do I propose a change to the CF convention?

A possible change to the CF standard may be suggested and debated initially as a [CF GitHub Discussion][cf-discussions], though this is not mandatory.
Once there is a definite proposal, it must be presented and agreed in detail as a new `enhancement` [issue in the CF conventions repository][cf-conventions-issues].
In the issue, anyone may ask questions or make suggestions, and the proposed change to the text may be developed and refined, until consensus is achieved.
More detailed information can be found in the [Rules for CF Conventions Changes](rules.md).

### What is the process for fixing errors?
See [How do I ask for a new standard name?](#how-do-i-ask-for-a-new-standard-name) about changes to the Standard Names list.

### What is the process for fixing errors in the CF convention?

Errors have a simpler workflow, but still use a community process, as described in the [Rules for Correcting Errors in CF Documents](errors.md).
A change to correct a typo or mistake in the wording or to clarify the text (without changing its intended meaning) may be proposed as a new `defect` [issue in the CF conventions repository][cf-conventions-issues].
The workflow is described in the [Rules for Correcting Errors in CF Documents](errors.md), and is simpler than for enhancements.

### When are changes added to the CF Convention?

Expand Down Expand Up @@ -343,13 +338,13 @@ If you can't find any matches, send an email to the CF-Metadata list describing

### How do I ask for a new standard name?

You ask for a new standard name by raising a new `standard name` issue in the [CF discussion GitHub repository][cf-discuss-issues]. In your issue, specify the following for each standard name you want to request:
You ask for a new standard name by raising a new `standard name` issue in the [CF vocabularies repository][cf-vocab-issues]. In your issue, specify the following for each standard name you want to request:

* its name,
* its description, and
* its canonical units.

Use other examples from the Standard Names table to model your request, or review past requests in the mail list archives.
Use the [standard names guidelines](http://cfconventions.org/Data/cf-standard-names/docs/guidelines.html), examples from the Standard Names table, and previous proposals to model your request.

### How detailed should a standard name be?

Expand Down Expand Up @@ -592,3 +587,6 @@ However, as noted above, this should first be agreed with the person overseeing
[cf-website-issues]: https://github.com/cf-convention/cf-convention.github.io/issues
[cf-website-pulls]: https://github.com/cf-convention/cf-convention.github.io/pulls
[mailing-list-archive]: https://cfconventions.org/mailing-list-archive/Data
[cf-discussions]: https://github.com/orgs/cf-convention/discussions
[cf-discussion-page]: http://cfconventions.org/discussion.html
[cf-vocab-issues]: https://github.com/cf-convention/vocabularies/issues

0 comments on commit 06c1550

Please sign in to comment.