CNCF website guidelines checklist into sandbox on-boarding template #294
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…checklist Signed-off-by: Nate W <[email protected]>
nate-double-u
commented
Sep 26, 2024
| - [ ] Submit a [pull request](https://github.com/cncf/artwork) with your artwork. | ||
| - [ ] Transfer website analytics to <[email protected]>. CNCF staff can help. | ||
| - [ ] Submit a [pull request](https://github.com/cncf/artwork) with your existing artwork. | ||
| _Note_: If you don't have artwork, CNCF can help design some. |
There was a problem hiding this comment.
Should we include more info about our design services and how to access them?
| - [ ] Transfer website analytics to <[email protected]>. CNCF staff can help. | ||
| - [ ] Submit a [pull request](https://github.com/cncf/artwork) with your existing artwork. | ||
| _Note_: If you don't have artwork, CNCF can help design some. | ||
| - [ ] Transfer website analytics to <[email protected]>, if applicable. CNCF staff can help. |
There was a problem hiding this comment.
If applicable as not all projects will have analytics, and for those that do, it may not be Google Analytics so another transfer method may need to be used.
|
|
||
| ## Update and document | ||
|
|
||
| - [ ] Ensure that [DCO](https://github.com/apps/dco) (preferred) or [CLA](https://github.com/cncf/cla) are enabled for all GitHub repositories of the project. | ||
| - [ ] Ensure that that the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md) (or your adopted version of it) are explicitly referenced at the project's `README` on GitHub. | ||
| - [ ] Ensure LF footer is on your website and [guidelines](https://github.com/cncf/foundation/blob/main/website-guidelines.md) are followed (if your project doesn't have a dedicated website, please adopt those guidelines for the `README` file). |
There was a problem hiding this comment.
moved to the Websites section.
Comment on lines
+53
to
+61
| - [ ] Ensure website is | ||
| - [ ] [Hosted in an open source repo](https://github.com/cncf/techdocs/blob/main/docs/repo-setup.md) | ||
| - [ ] Hosted in the same organization as the main project | ||
| - [ ] Setup with [DCO](https://github.com/apps/dco) or CLA (DCO recommended) | ||
| [CNCF's IP policy](https://github.com/cncf/foundation/blob/master/charter.md#11-ip-policy) | ||
| requires all projects to use either CLA (Contributor License Agreements) | ||
| or [DCO (Developer Certificate of Origin)](https://github.com/apps/dco). | ||
| Unless there's a strong necessity to use CLA, we encourage projects to | ||
| use DCO as it's easier to setup and use. |
Comment on lines
+67
to
+68
| - [ ] No links or forms for capturing enterprise support leads should be present | ||
| _Note_: It is fine to have an enterprise support, commercial partners, or similar page. |
There was a problem hiding this comment.
Suggested change
| - [ ] No links or forms for capturing enterprise support leads should be present | |
| _Note_: It is fine to have an enterprise support, commercial partners, or similar page. | |
| - [ ] Remove any links or forms for capturing enterprise support leads | |
| _Note_: It is fine to have an enterprise support, commercial partners, or similar page. |
Comment on lines
+73
to
+74
| - [ ] Links to companies offering support go to a page that at least mentions | ||
| support of the project |
There was a problem hiding this comment.
Suggested change
| - [ ] Links to companies offering support go to a page that at least mentions | |
| support of the project | |
| - [ ] Any links to companies offering support go to a page that _at least_ mentions | |
| support of the project |
Signed-off-by: Daniel Krook <[email protected]>
|
Merged in the latest changes to the template that happened while this PR was opened. @nate-double-u given that there is a lot of content added here, what do you think about moving it to an external document? Kind of like how we refer projects to review other readmes? I'd say we should keep a hand full of first class checklist items in this template, but then leave other more minor items in an external doc. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding information from CNCF website guidelines checklist to sandbox on-boarding tepmplate
* Draft for discussion