Merge pull request #1230 from RainbowMango/pr_orgnize_docs

Orgnize documents about cherry-picks
karmada-io · Jan 10, 2022 · 27f5bc5 · 27f5bc5
2 parents 6cb3e99 + 8c564f7
commit 27f5bc5
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -20,7 +20,9 @@ Refer to [Installing Karmada](./installation/installation.md).
 
 ## Developer Guide
 
-## Contribute
+## Contributors
+
+- [Cherry Pick Overview](./contributors/devel/cherry-picks.md)
 
 ## Reference
 

diff --git a/docs/userguide/cherry-picks.md → docs/contributors/devel/cherry-picks.md b/docs/userguide/cherry-picks.md → docs/contributors/devel/cherry-picks.md
@@ -115,3 +115,5 @@ cherry pick.
 ## Cherry Picks for Unsupported Releases
 
 The community supports & patches releases need to be discussed.
+
+[cherry-pick-script]: https://github.com/karmada-io/karmada/blob/master/hack/cherry_pick_pull.sh
diff --git a/hack/cherry_pick_pull.sh b/hack/cherry_pick_pull.sh
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Usage Instructions: https://github.com/karmada-io/karmada/blob/master/docs/userguide/cherry-picks.md
+# Usage Instructions: https://github.com/karmada-io/karmada/blob/master/docs/contributors/devel/cherry-picks.md
 
 # Checkout a PR from GitHub. (Yes, this is sitting in a Git tree. How
 # meta.) Assumes you care about pulls from remote "upstream" and
@@ -64,7 +64,7 @@ if [[ "$#" -lt 2 ]]; then
   echo "  Set UPSTREAM_REMOTE (default: upstream) and FORK_REMOTE (default: origin)"
   echo "  to override the default remote names to what you have locally."
   echo
-  echo "  For merge process info, see https://github.com/karmada-io/karmada/blob/master/docs/userguide/cherry-picks.md"
+  echo "  For merge process info, see https://github.com/karmada-io/karmada/blob/master/docs/contributors/devel/cherry-picks.md"
   exit 2
 fi
 
@@ -146,7 +146,7 @@ function make-a-pr() {
     cat <<EOF
 Cherry pick of ${PULLSUBJ} on ${rel}.
 ${numandtitle}
-For details on the cherry pick process, see the [cherry pick requests](https://github.com/karmada-io/karmada/blob/master/docs/userguide/cherry-picks.md) page.
+For details on the cherry pick process, see the [cherry pick requests](https://github.com/karmada-io/karmada/blob/master/docs/contributors/devel/cherry-picks.md) page.
 \`\`\`release-note
 \`\`\`
 EOF
Original file line number	Diff line number	Diff line change
Expand Up		@@ -115,3 +115,5 @@ cherry pick.
		## Cherry Picks for Unsupported Releases

		The community supports & patches releases need to be discussed.

		[cherry-pick-script]: https://github.com/karmada-io/karmada/blob/master/hack/cherry_pick_pull.sh