Skip to content
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.

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

Update FAQ on maintaining CF #296

Closed
erget opened this issue Sep 22, 2022 · 10 comments · Fixed by #401
Closed

Update FAQ on maintaining CF #296

erget opened this issue Sep 22, 2022 · 10 comments · Fixed by #401
Labels
defect Content mistake on the website

Comments

@erget
Copy link
Member

erget commented Sep 22, 2022

The last section, "Maintaining the CF standard", needs some serious updating to bring it into the GitHub era. Or needs removing or to be replaced with a pointer to CONTRIBUTING.md and/or rules.md.

Originally posted by @ethanrd in #278 (comment)

Referring to faq.md.

I think this is a good idea too. Unfortunately I'm a bit short on time so won't get to it right away but am happy that it's been proposed, and will happily support it once I find a few minutes if nobody has in the interim!

@JonathanGregory JonathanGregory added the defect Content mistake on the website label Nov 14, 2022
@JonathanGregory
Copy link
Contributor

I would say the same, and likewise would like to spend some time on the FAQ, when I can.

@sadielbartholomew
Copy link
Member

I also agree, and maybe I can help a bit too (making suggestions here and there, perhaps reviewing an eventual PR, etc.).

@JonathanGregory
Copy link
Contributor

The link checker repeatedly finds these broken links, which I'm recording here for reference, to be dealt with when time allows.

[faq.md]:
✗ [404] https://mailman.cgd.ucar.edu/pipermail/cf-metadata/2010/048064.html | Failed: Network error: Not Found
✗ [404] https://mailman.cgd.ucar.edu/pipermail/cf-metadata/2008/052705.html | Failed: Network error: Not Found
✗ [404] https://mailman.cgd.ucar.edu/pipermail/cf-metadata/2009/047768.html | Failed: Network error: Not Found
✗ [404] https://mailman.cgd.ucar.edu/pipermail/cf-metadata/2010/053657.html | Failed: Network error: Not Found
✗ [404] https://mailman.cgd.ucar.edu/pipermail/cf-metadata/2008/052334.html | Failed: Network error: Not Found
✗ [404] https://mailman.cgd.ucar.edu/pipermail/cf-metadata/2012/055875.html | Failed: Network error: Not Found

@JonathanGregory
Copy link
Contributor

Dear Andrew @DocOtak

This is great! Thanks a lot for your time and effort. That's a big step towards fixing the final missing links.

I think the posting from Rob Raskin that you found is the correct one. The reference to it says "list post mention". He mentions it just in the last sentence, saying it's the subject of another communication. I too cannot find anything else from him about it, though Russ Rew mentioned something similar in https://cfconventions.org/mailing-list-archive/Data/0418.html. In this case, the link to the posting isn't useful, I would say, but the document could be of interest.

For the final one also, I think you have found the only possibility. Piasecki is not mentioned anywhere else. In this case, we don't have a link to the document concerned, so I suppose we might as well delete this item - would you agree?

I see that the FAQ mentions the pipermail archive in a few places. We should change them as well.

Best wishes

Jonathan

@JonathanGregory
Copy link
Contributor

Dear Andrew @DocOtak

I have prepared PR 401 to replace the mailing list links, and remove some other references to the mailing list. There are plenty of other updates of content needed, but I didn't change anything else, except for referring to the CF repos in a consistent way. I believe that once these changes are implemented, the website won't have any missing links.

Would you mind checking the PR? I would be grateful. Thanks for your work on this issue.

Cheers

Jonathan

@JonathanGregory
Copy link
Contributor

Dear all

I'm rather keen to see whether this PR fixes the remaining broken links on the website, which are all in the FAQ, so I'd be happy if anyone has a minute to check and merge it if it looks OK. It implements the fixes that @DocOtak helpfully identified.

Thanks

Jonathan

@erget
Copy link
Member Author

erget commented Sep 14, 2023

Thanks all for the hard work - it looks good for me so I will merge.

@JonathanGregory
Copy link
Contributor

Thanks, @erget

@DocOtak
Copy link
Member

DocOtak commented Sep 15, 2023

Glad to see my suggestions go in, thanks for doing it @JonathanGregory

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
defect Content mistake on the website
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants