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

Add an Infrastructure Guide #548

Open
ethanrd opened this issue Oct 3, 2024 · 5 comments · May be fixed by #106
Open

Add an Infrastructure Guide #548

ethanrd opened this issue Oct 3, 2024 · 5 comments · May be fixed by #106
Labels
enhancement Enhancements to the website's presentation or contents

Comments

@ethanrd
Copy link
Member

ethanrd commented Oct 3, 2024

Add an Infrastructure Guide to document how we manage the infrastructure behind the CF Website, the CF Conventions document, the CF Standard Names table, and the CF standardized region list.

We already have a PR (#106). This issue is for discussion and agreement on the changes.

@ethanrd ethanrd added the enhancement Enhancements to the website's presentation or contents label Oct 3, 2024
@ethanrd ethanrd linked a pull request Oct 3, 2024 that will close this issue
@ethanrd ethanrd linked a pull request Oct 3, 2024 that will close this issue
@ethanrd
Copy link
Member Author

ethanrd commented Oct 3, 2024

There appears to be general agreement that this change/addition is needed. Some details have been discussed and folded into the PR.

Are there some changes that still need to be agreed and folded into the PR?

@DocOtak
Copy link
Member

DocOtak commented Oct 3, 2024

Would the website itself be the most appropriate place for this? My feeling is that the CONTRIBUTING.md is a better place: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

@JonathanGregory
Copy link
Contributor

In conventions issue 369 Daniel @erget and I have proposed merging the conventions rules page on the website with CONTRIBUTING.md in the conventions repo. I suggest we could take the same approach with the website repo i.e. put the infrastructure guide in an obviously named file in the repo (maybe CONTRIBUTING.md, as @DocOtak suggests), and also link this file from the website. That gives people two ways to find the same thing.

@ethanrd
Copy link
Member Author

ethanrd commented Oct 7, 2024

The Infrastructure Guide and the CONTRIBUTING.md file seem distinct to me. The CONTRIBUTING.md file describes the ways contributors can contribute and the rules for going about that. Whereas the Infrastructure Guide describes how the maintainers go about converting the content of the repos into the end products. The CONTRIBUTING.md file might refer to the Infrastructure Guide but I don't think it should contain it.

@JonathanGregory
Copy link
Contributor

Fair enough. If the infrastructure guide is a different file, we can still both link it from the web and give it a name in capitals in the repo, so that it will be noticed there too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancements to the website's presentation or contents
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants