Feat: Update documentation to describe project setup #20
Conversation
Signed-off-by: Matthew Watkins <[email protected]>
ModeSevenIndustrialSolutions
force-pushed
the
update-docs
branch
from
980be90 to
16b642d
Compare
| @@ -78,6 +78,19 @@ Or, submit each commit as a separate single commit preserving the git history (S | |||
| - `ORGANIZATION`: The GitHub Organization or Project. | |||
| - `REVIEWER_EMAIL`: Committers' email list (comma-separated list without spaces). | |||
|
|
|||
| ## Deploying to a New Linux Foundation Project | |||
There was a problem hiding this comment.
Instead of having another section, please move these steps to pre-requisites (see ln 10+) above, there is already a well-maintained doc on how to create SSH keys and use them.
https://docs.releng.linuxfoundation.org/en/latest/gerrit.html#register-key-gerrit
| @@ -78,6 +78,19 @@ Or, submit each commit as a separate single commit preserving the git history (S | |||
| - `ORGANIZATION`: The GitHub Organization or Project. | |||
| - `REVIEWER_EMAIL`: Committers' email list (comma-separated list without spaces). | |||
|
|
|||
| ## Deploying to a New Linux Foundation Project | |||
There was a problem hiding this comment.
Please make this generic so that anyone outside of LF can follow the guide.
There was a problem hiding this comment.
Perhaps this should simply be documented on the LF RelEng Confluence Wiki instead? There are concrete steps needed to set this up for LF projects that are NOT for general consumption, which are currently missing. If you want generic documentation, perhaps our internal docs should go elsewhere.
There was a problem hiding this comment.
|
The PR tittle should be "Docs: ..." or "Fix: ..." instead of "Feat: ..." |
We need to be clear about the steps involved in setting this up for new projects at the LF. Happy to take comments on the additions in this PR.