[improve][doc] added instructions about how to run ci from fork #15535
Conversation
heesung-sohn
changed the title
github-actions
bot
added
the
doc
site2/website/contributing.md
Outdated
| limit-access-to-actor: true | ||
| ``` | ||
| and inline composite action [implementation](https://github.com/apache/pulsar/blob/master/.github/actions/ssh-access/action.yml). | ||
| The ssh acccess is secured with the ssh key registered in Github. |
There was a problem hiding this comment.
| The ssh acccess is secured with the ssh key registered in Github. | |
| The ssh access is secured with the ssh key registered in GitHub. |
There was a problem hiding this comment.
+1
and "SSH, SSH key", please pay attention to the capitalization for proper nouns
site2/website/contributing.md
Outdated
| and inline composite action [implementation](https://github.com/apache/pulsar/blob/master/.github/actions/ssh-access/action.yml). | ||
| The ssh acccess is secured with the ssh key registered in Github. | ||
| For example, your public keys are https://github.com/horizonzy.keys. | ||
| You will first have to register a ssh public key in GitHub for that to work. |
There was a problem hiding this comment.
| You will first have to register a ssh public key in GitHub for that to work. | |
| You will first have to register an ssh public key in GitHub for that to work. |
site2/website/contributing.md
Outdated
| ``` | ||
| B.) You can also create a PR to your own fork in the GitHub UI when opening | ||
| a new PR. To do so, first click on "compare across forks" and then choose | ||
| your own fork as both the fork repository and head repository. |
There was a problem hiding this comment.
| your own fork as both the fork repository and head repository. | |
| your own fork as both the forked repository and head repository. |
site2/website/contributing.md
Outdated
|
|
||
| Here's one way to sync your fork's master branch with apache/pulsar's | ||
| master branch: | ||
| Let's say if you have git remotes called "upstream" for apache/pulsar and |
There was a problem hiding this comment.
| Let's say if you have git remotes called "upstream" for apache/pulsar and | |
| Let's say you have git remotes called "upstream" for apache/pulsar and |
|
Thank you for checking this PR. I resolved the above comments. |
|
@heesung-sn @Anonymitaet It looks like these instructions have been dropped and aren't on the new website. Would it be possible to get the content to the new website too? |
Raised a PR to the new website repo, apache/pulsar-site#111 |
sure, commented in your new PR. |
4 participants
Motivation
As commented here, moving this instruction,
how to run Pulsar CI from fork, to the contribution page in order to make it more accessible for new contributors.Modifications
Added instructions about how to run Pulsar CI from forked github repositories in the contribution page.
Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
If
yeswas chosen, please highlight the changesDocumentation
Check the box below or label this PR directly.
Need to update docs?
doc-required(Your PR needs to update docs and you will update later)
no-need-doc(Please explain why)
doc(Your PR contains doc changes)
doc-added(Docs have been already added)