From 08e2f2925cfc251a38d5e592e274d8709d38a956 Mon Sep 17 00:00:00 2001 From: JonathanGregory Date: Tue, 5 Nov 2024 08:38:45 +0000 Subject: [PATCH 1/5] update about questions and discussions --- faq.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/faq.md b/faq.md index 59644613..c8e593a6 100644 --- a/faq.md +++ b/faq.md @@ -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 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)? @@ -78,20 +78,17 @@ 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. +A possible change to the CF standard may be suggested and debated initially as a [CF GitHub Discussion](cf-discussions]. When there is a definite proposal, it 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. 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 accepting a change to the CF convention? @@ -343,13 +340,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? @@ -592,3 +589,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 From f9c3a41fe6cc688d6dcc1a53303819ba1f8ee208 Mon Sep 17 00:00:00 2001 From: JonathanGregory Date: Tue, 5 Nov 2024 08:42:26 +0000 Subject: [PATCH 2/5] typo --- faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/faq.md b/faq.md index c8e593a6..71f9ae03 100644 --- a/faq.md +++ b/faq.md @@ -78,7 +78,7 @@ 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 GitHub Discussions](cf-discussions], or in the archives listed on the [discussion page][cf-discussion-page]. +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? From 4ba18c789a31f860760a10b654a9753efbe6f57e Mon Sep 17 00:00:00 2001 From: JonathanGregory Date: Tue, 5 Nov 2024 08:44:13 +0000 Subject: [PATCH 3/5] typo --- faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/faq.md b/faq.md index 71f9ae03..de573e74 100644 --- a/faq.md +++ b/faq.md @@ -88,7 +88,7 @@ CF community members usually respond within a day to simple questions, but allow ### How do I propose a change? -A possible change to the CF standard may be suggested and debated initially as a [CF GitHub Discussion](cf-discussions]. When there is a definite proposal, it 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. 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. +A possible change to the CF standard may be suggested and debated initially as a [CF GitHub Discussion][cf-discussions]. When there is a definite proposal, it 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. 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 accepting a change to the CF convention? From a2924cfd395ffd81bac7712acd5b1e1d81b97679 Mon Sep 17 00:00:00 2001 From: JonathanGregory Date: Tue, 5 Nov 2024 09:00:24 +0000 Subject: [PATCH 4/5] improvements --- faq.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/faq.md b/faq.md index de573e74..d896b991 100644 --- a/faq.md +++ b/faq.md @@ -86,21 +86,19 @@ First, please see whether your question has already been answered (see [question 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? - -A possible change to the CF standard may be suggested and debated initially as a [CF GitHub Discussion][cf-discussions]. When there is a definite proposal, it 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. 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 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? From 85014ea337d366bf645673019dbc81ffe514c008 Mon Sep 17 00:00:00 2001 From: JonathanGregory Date: Tue, 5 Nov 2024 09:03:15 +0000 Subject: [PATCH 5/5] improvement --- faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/faq.md b/faq.md index d896b991..a2ed4e9b 100644 --- a/faq.md +++ b/faq.md @@ -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, continues to develop through discussions involving 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)?