diff --git a/lib/search/indexes/github-docs-3.0-cn-records.json.br b/lib/search/indexes/github-docs-3.0-cn-records.json.br index 648ac50e86..04f6d2cb39 100644 --- a/lib/search/indexes/github-docs-3.0-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.0-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4d1e501e0348c6d7454fb2b4d9ff6457de1b19669537024ed70cb5af452cd151 -size 610675 +oid sha256:1a5d3a3ccc2216c070370ab7604ba06ef342157cabac87dc9b2979495bdc5601 +size 610870 diff --git a/lib/search/indexes/github-docs-3.0-cn.json.br b/lib/search/indexes/github-docs-3.0-cn.json.br index c34082b12e..1b64287de9 100644 --- a/lib/search/indexes/github-docs-3.0-cn.json.br +++ b/lib/search/indexes/github-docs-3.0-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:de26a4c641a99cd9d8bac96d70623cd721c1178712037d6da7b848ed1eed87a7 -size 1658604 +oid sha256:36acbb974eb02ed43af68b64649df4ed634afdcb53320b1eb55b9f56d8d8b8e9 +size 1658799 diff --git a/lib/search/indexes/github-docs-3.0-en-records.json.br b/lib/search/indexes/github-docs-3.0-en-records.json.br index 8296a8b8ce..88ead9aa30 100644 --- a/lib/search/indexes/github-docs-3.0-en-records.json.br +++ b/lib/search/indexes/github-docs-3.0-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:19e9bf047eacd39ba76a589dde52a39d7635091816d21bfa5dd5ec0455b97d79 -size 952777 +oid sha256:68a8dde1afcddca73d7b55ef4b0161f7eb6c818c769df808bbac2261f01ef616 +size 952248 diff --git a/lib/search/indexes/github-docs-3.0-en.json.br b/lib/search/indexes/github-docs-3.0-en.json.br index a95b62e9f9..19ebcd69ef 100644 --- a/lib/search/indexes/github-docs-3.0-en.json.br +++ b/lib/search/indexes/github-docs-3.0-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e8c739e4c5a3c3284de9f4728ebae5831b517469e710fda18fc6f3b6690a07c4 -size 3903375 +oid sha256:dbaff4b180f1cdcb1a5613ee7f02fe363c8d9c43007434e6c35e8310c9f055c4 +size 3902631 diff --git a/lib/search/indexes/github-docs-3.0-es-records.json.br b/lib/search/indexes/github-docs-3.0-es-records.json.br index 006dbdafd0..ae3286d6aa 100644 --- a/lib/search/indexes/github-docs-3.0-es-records.json.br +++ b/lib/search/indexes/github-docs-3.0-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e8cf2e1914f290a6854367da381d4ed431a144cc63b9d8e2186054a5e248de7c -size 584431 +oid sha256:8c94138496497ecbf8ede9be3885fb56d71ff05fbe5a94a52e0b9a3e4adfedd8 +size 584328 diff --git a/lib/search/indexes/github-docs-3.0-es.json.br b/lib/search/indexes/github-docs-3.0-es.json.br index af05acd506..34fed88397 100644 --- a/lib/search/indexes/github-docs-3.0-es.json.br +++ b/lib/search/indexes/github-docs-3.0-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a79ed22abe1734fb5ef312f3aaecca6b3209397d38dbe2af2a1111b0b5bcb699 -size 2703444 +oid sha256:c3d305f16be274040a2f85b2800f7320f95d378c3aa97b955addfb8f154e7a65 +size 2703886 diff --git a/lib/search/indexes/github-docs-3.0-ja-records.json.br b/lib/search/indexes/github-docs-3.0-ja-records.json.br index c1c79c6e97..6309486762 100644 --- a/lib/search/indexes/github-docs-3.0-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.0-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7707fe34b12bbfcdf7f45d774076a93089d343100ff942f62ed2c56fc7178543 -size 616771 +oid sha256:efdffa7bf12763da18f7c8cfb6f7943712eeccdf6cf2cb1d22461a0eda95a670 +size 616670 diff --git a/lib/search/indexes/github-docs-3.0-ja.json.br b/lib/search/indexes/github-docs-3.0-ja.json.br index 97422a2db7..ac68142768 100644 --- a/lib/search/indexes/github-docs-3.0-ja.json.br +++ b/lib/search/indexes/github-docs-3.0-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b47ba8a38823bf30130015894b076e4fced460e987b002b3e820dc76503efdb4 -size 3419013 +oid sha256:854a680d1906124a8229717da9d45e6877143fb59cbad9626fc40a2b5de23aa7 +size 3419203 diff --git a/lib/search/indexes/github-docs-3.0-pt-records.json.br b/lib/search/indexes/github-docs-3.0-pt-records.json.br index de018b267c..0fa33cd1d8 100644 --- a/lib/search/indexes/github-docs-3.0-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.0-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:57bd4b1c2f5962413427e091b518d0df3762dfdaa7cb8e714dd987ceb5054ffb -size 596255 +oid sha256:efabd15a7be2726fabda9893077625d004ac1c8a8af6fedc9d440c388ec9b5b2 +size 596335 diff --git a/lib/search/indexes/github-docs-3.0-pt.json.br b/lib/search/indexes/github-docs-3.0-pt.json.br index 01d4664bae..67ddbff7ec 100644 --- a/lib/search/indexes/github-docs-3.0-pt.json.br +++ b/lib/search/indexes/github-docs-3.0-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:18eb04a78a9c0ac9ddc7b0c4b8b60101f2e291a102abeddc3d8741c1af7b68f8 -size 2807440 +oid sha256:538ca77d3d24f7b6860fa21f130c72c604e3e6ef4d99137f8bcff76a553cf4b5 +size 2807923 diff --git a/lib/search/indexes/github-docs-3.1-cn-records.json.br b/lib/search/indexes/github-docs-3.1-cn-records.json.br index abbcbbe50f..9b93ca6076 100644 --- a/lib/search/indexes/github-docs-3.1-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.1-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1e5cb92860261eeef9f7c772e0a7c129631db313e8c4a36b558bfb206220dfd4 -size 624363 +oid sha256:96c30a1e7a7eef4844dad35a6af25d379e22c6feab3920d6f205597ed9116eff +size 624214 diff --git a/lib/search/indexes/github-docs-3.1-cn.json.br b/lib/search/indexes/github-docs-3.1-cn.json.br index 84edfde129..1cebabcfe3 100644 --- a/lib/search/indexes/github-docs-3.1-cn.json.br +++ b/lib/search/indexes/github-docs-3.1-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0b5a96c694daaddf417899f232db2cf5428b3a97751960cca44cbcb634b72ba5 -size 1700922 +oid sha256:2ea318c405e971b66ea13afa588603a52b219fb8e340406bde1c5e582c2b0c48 +size 1699851 diff --git a/lib/search/indexes/github-docs-3.1-en-records.json.br b/lib/search/indexes/github-docs-3.1-en-records.json.br index 6eeffb6928..0163ea3dfa 100644 --- a/lib/search/indexes/github-docs-3.1-en-records.json.br +++ b/lib/search/indexes/github-docs-3.1-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6f49641d10d05a261da6b8889fb5c874a5e000f1be0c611e7fa594f3aaa3fb13 -size 977421 +oid sha256:c6966b41e6e697828cb83f68d6e3934e48c1dcd9c99e18fb8aeadbf12dd851e3 +size 977386 diff --git a/lib/search/indexes/github-docs-3.1-en.json.br b/lib/search/indexes/github-docs-3.1-en.json.br index 8bc614451d..ca7047977b 100644 --- a/lib/search/indexes/github-docs-3.1-en.json.br +++ b/lib/search/indexes/github-docs-3.1-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a50bc0d1c1d68b46afccdff317bbfeca0e47493cdac70c1cff369255a1eaf64a -size 3996100 +oid sha256:92d1059b4fba1bfceedd31ac77865b9653ff0d64f25c8b2ddd1108cae1bd92de +size 3995150 diff --git a/lib/search/indexes/github-docs-3.1-es-records.json.br b/lib/search/indexes/github-docs-3.1-es-records.json.br index e1973c3c4d..15aa176c1b 100644 --- a/lib/search/indexes/github-docs-3.1-es-records.json.br +++ b/lib/search/indexes/github-docs-3.1-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:886daea21c1092bd6cf48b25cdb58860a5625b0aa0886c72788109858fbafc5f -size 596543 +oid sha256:d7e70bd1256b07ced5dda153e0ff418e8d1aa92dddd1565fea6f2c6e5c013a50 +size 596636 diff --git a/lib/search/indexes/github-docs-3.1-es.json.br b/lib/search/indexes/github-docs-3.1-es.json.br index a1e2ae3037..ce242fb545 100644 --- a/lib/search/indexes/github-docs-3.1-es.json.br +++ b/lib/search/indexes/github-docs-3.1-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cd71bdb4499fd85624115815b64b2cc145f26d686addc25031101efc615ea966 -size 2766239 +oid sha256:ea4d5f1c25db5f72820acdc2a3291101fb073a674f3f8d0aca531108eeacb1d0 +size 2766871 diff --git a/lib/search/indexes/github-docs-3.1-ja-records.json.br b/lib/search/indexes/github-docs-3.1-ja-records.json.br index 1e8e324fd8..85f62293dd 100644 --- a/lib/search/indexes/github-docs-3.1-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.1-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6d117122c7be4f8c576705368f458d35639224006bfa82a908fcaf0a63719fda -size 630151 +oid sha256:c8af6debc99c329a91a267e2f246b06173b58a0fe54ea255060c9b30a9bfd5da +size 629982 diff --git a/lib/search/indexes/github-docs-3.1-ja.json.br b/lib/search/indexes/github-docs-3.1-ja.json.br index 15d4edb701..b1d3c57d5b 100644 --- a/lib/search/indexes/github-docs-3.1-ja.json.br +++ b/lib/search/indexes/github-docs-3.1-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cdeee32bb55707536ad34a37c5771187f0b51620397d1694063926ddb1dea8b0 -size 3496433 +oid sha256:5d996de5d4d0c9bfdea0575f187be87b4ed28e3b1c485c1a34d2e7e3358ed6b3 +size 3496918 diff --git a/lib/search/indexes/github-docs-3.1-pt-records.json.br b/lib/search/indexes/github-docs-3.1-pt-records.json.br index 99cefd7131..a285c62fb3 100644 --- a/lib/search/indexes/github-docs-3.1-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.1-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:53653a82aa915196e959d831b9f7e34a5033e18e97db31990a581b7d10ec7a12 -size 608654 +oid sha256:893bb389935826265d16ce7b18f40f9d46697aae171f1b5f08fa6f73bde3f6a3 +size 608573 diff --git a/lib/search/indexes/github-docs-3.1-pt.json.br b/lib/search/indexes/github-docs-3.1-pt.json.br index 6c40cc2c9f..f60db00f21 100644 --- a/lib/search/indexes/github-docs-3.1-pt.json.br +++ b/lib/search/indexes/github-docs-3.1-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:68543177a76f896746e9167f50c8e28811273d49593cedb4d2df7978631c3604 -size 2870290 +oid sha256:2a542126dc6a85f0c79119063171c2691416ae0b7de50653b5873816592eb2ca +size 2870122 diff --git a/lib/search/indexes/github-docs-3.2-cn-records.json.br b/lib/search/indexes/github-docs-3.2-cn-records.json.br index a9385b466f..2b21443c51 100644 --- a/lib/search/indexes/github-docs-3.2-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.2-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:834963cc3927f24d4c901655e65425808c83fd6ce3ee135f0d4c7aeaf1b2de71 -size 635690 +oid sha256:3e96b667916711a4d1cd5a2c8fbe437db57d40787b638747d8da6a4b0ab43ef0 +size 635762 diff --git a/lib/search/indexes/github-docs-3.2-cn.json.br b/lib/search/indexes/github-docs-3.2-cn.json.br index d5532f5960..47a3dacde7 100644 --- a/lib/search/indexes/github-docs-3.2-cn.json.br +++ b/lib/search/indexes/github-docs-3.2-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1d574a3d0d0270feac2a83578ad82329c44d187f56ab585e1d0aefa800a236a7 -size 1726666 +oid sha256:179ffa0d449fd0224aefcc29c965a92dfb06c9de6f6bd3d3f558a008eac18d87 +size 1726549 diff --git a/lib/search/indexes/github-docs-3.2-en-records.json.br b/lib/search/indexes/github-docs-3.2-en-records.json.br index 91e7daab6f..9c130a4381 100644 --- a/lib/search/indexes/github-docs-3.2-en-records.json.br +++ b/lib/search/indexes/github-docs-3.2-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ece9dc9722b618850bc529b34fcf6c227b685d9440dded2339361052d97493e2 -size 1008468 +oid sha256:be5a21ac63689f5994523954df5729dea57332ea60a272e11c79b0522a6d1e02 +size 1012199 diff --git a/lib/search/indexes/github-docs-3.2-en.json.br b/lib/search/indexes/github-docs-3.2-en.json.br index 7d154dee6a..c0f1a880e9 100644 --- a/lib/search/indexes/github-docs-3.2-en.json.br +++ b/lib/search/indexes/github-docs-3.2-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e67d86dcf96178384dae255df19a0ffc521d968aa8de5a9dca7d26571b6b7946 -size 4116943 +oid sha256:762d47fcb78f9002872745972e996e14280920367aa84d1512a3680fa6a057fb +size 4116785 diff --git a/lib/search/indexes/github-docs-3.2-es-records.json.br b/lib/search/indexes/github-docs-3.2-es-records.json.br index b177cc0645..5f07ed753c 100644 --- a/lib/search/indexes/github-docs-3.2-es-records.json.br +++ b/lib/search/indexes/github-docs-3.2-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:aae756e02564d6bf070cada81f1ef94400c227c258a3e1fbac1e17ae4bd43e7b -size 606987 +oid sha256:0f6fbb4fc4c485e674b045cd2681909ac785fe8cac429fed72aeb7616327cc8b +size 606991 diff --git a/lib/search/indexes/github-docs-3.2-es.json.br b/lib/search/indexes/github-docs-3.2-es.json.br index 8363364aea..5ccd994e68 100644 --- a/lib/search/indexes/github-docs-3.2-es.json.br +++ b/lib/search/indexes/github-docs-3.2-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ca762eec26edccd7845e8495121680658a500e656401ed597a09eac87f88f741 -size 2821100 +oid sha256:676e9843a9607eeb13ae1da4fe199d778bbd08a8a66332fcfa0f0a5518b2c62b +size 2820863 diff --git a/lib/search/indexes/github-docs-3.2-ja-records.json.br b/lib/search/indexes/github-docs-3.2-ja-records.json.br index 0a4eda215a..e42ec4e402 100644 --- a/lib/search/indexes/github-docs-3.2-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.2-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:aad4b77d9156b05049760e7c4ca479abac140dfc9db9fe597fad69d1c483df61 -size 641573 +oid sha256:2db4205fb2f7897cbecb32b7c07c5086be50a219f82404019ac57c63e5a40e17 +size 641640 diff --git a/lib/search/indexes/github-docs-3.2-ja.json.br b/lib/search/indexes/github-docs-3.2-ja.json.br index 2e10002436..01ba895878 100644 --- a/lib/search/indexes/github-docs-3.2-ja.json.br +++ b/lib/search/indexes/github-docs-3.2-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cc49a4bbb03709a6bba0bc9e02aafc4eee6e7c730290ebd077a1df809222e5b2 -size 3562799 +oid sha256:ef94698e6083d2bf614ae39c0a91fa02dba350d5b08421d2f368cbccf22d9fc1 +size 3564138 diff --git a/lib/search/indexes/github-docs-3.2-pt-records.json.br b/lib/search/indexes/github-docs-3.2-pt-records.json.br index 88276861c1..1656758662 100644 --- a/lib/search/indexes/github-docs-3.2-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.2-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2d30b5eb1175c450058af9cb4a33585cd0015a6a20990cdff54263a56038ef7a -size 619978 +oid sha256:b13e2a8e6095cfc48182652bcbc7c27c7152b5531abc00bffba70ed1416d7796 +size 620030 diff --git a/lib/search/indexes/github-docs-3.2-pt.json.br b/lib/search/indexes/github-docs-3.2-pt.json.br index 3b203ef3ee..e5eaeac8a4 100644 --- a/lib/search/indexes/github-docs-3.2-pt.json.br +++ b/lib/search/indexes/github-docs-3.2-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4b3ab52190ed72dbe2a3f4cd4e831bb4bb4ffe5b41f1a82afb5e8a684d368ffa -size 2919687 +oid sha256:a0261828d9927193d4c658a11aa1fd3631bbd14bf62ba74add5ac974e0499e17 +size 2920327 diff --git a/lib/search/indexes/github-docs-3.3-cn-records.json.br b/lib/search/indexes/github-docs-3.3-cn-records.json.br index 8bcc23575e..2a7ca574cb 100644 --- a/lib/search/indexes/github-docs-3.3-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.3-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:557b5bb980d3d8cc18a69b1bca54612787ba41ad8347e02e7ad156eb895c067c -size 656269 +oid sha256:5fe6101a26baa845a3f307183e8541da44b11b391a9d37bd2f67ff5a9860e649 +size 655883 diff --git a/lib/search/indexes/github-docs-3.3-cn.json.br b/lib/search/indexes/github-docs-3.3-cn.json.br index cfbe877e37..0dd91d5107 100644 --- a/lib/search/indexes/github-docs-3.3-cn.json.br +++ b/lib/search/indexes/github-docs-3.3-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:86e41961bae2de3f8d770bcbde1dd5b6d0714f87d8d11758ecd55add0d832e8e -size 1784419 +oid sha256:7b7d270dfd6ed73c8c0487818e159d28fa04962031297928bbcdb8dc37e9edca +size 1784609 diff --git a/lib/search/indexes/github-docs-3.3-en-records.json.br b/lib/search/indexes/github-docs-3.3-en-records.json.br index 1d399dd640..3918dae618 100644 --- a/lib/search/indexes/github-docs-3.3-en-records.json.br +++ b/lib/search/indexes/github-docs-3.3-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:fd55ef90a8895960f805d66b5734d481c46e4ba8d44b74b5b913805923a76992 -size 1042489 +oid sha256:bad14d5dea157f0ca43d3202df038cb320cd4c7042d99fff9c38d0018c9cd6b8 +size 1042029 diff --git a/lib/search/indexes/github-docs-3.3-en.json.br b/lib/search/indexes/github-docs-3.3-en.json.br index 0d4d5f7cff..b8e5634332 100644 --- a/lib/search/indexes/github-docs-3.3-en.json.br +++ b/lib/search/indexes/github-docs-3.3-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:55b47b6e8a29710b6b57f27f02650b482bc0fcd4c17836ee84359d6f4be1b429 -size 4217061 +oid sha256:0a3bd4c8e22dc62c65a9fc9a62ccc16816a87c33f47944a2a8839c7f26330094 +size 4216610 diff --git a/lib/search/indexes/github-docs-3.3-es-records.json.br b/lib/search/indexes/github-docs-3.3-es-records.json.br index fe61a05977..68b0db5967 100644 --- a/lib/search/indexes/github-docs-3.3-es-records.json.br +++ b/lib/search/indexes/github-docs-3.3-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a86df7ffb3f8e8b4ff129e61112336e6ae1c7dfbef4e7293900097ce6c7157e5 -size 625243 +oid sha256:07102915ea10a4cfe3139b58252c281f4d3d10a7cc509a429a00bda3ab23a198 +size 625081 diff --git a/lib/search/indexes/github-docs-3.3-es.json.br b/lib/search/indexes/github-docs-3.3-es.json.br index e824fc8876..f420d30072 100644 --- a/lib/search/indexes/github-docs-3.3-es.json.br +++ b/lib/search/indexes/github-docs-3.3-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3f804c3ca90d52541cd1fa7a07bbb42bb56ed529aa5772ee8daa86694de1f8ba -size 2918857 +oid sha256:7ae6611ac2e1203c0de2537eb55fd83ef6d82404d3abd4fdabc241096523943b +size 2919857 diff --git a/lib/search/indexes/github-docs-3.3-ja-records.json.br b/lib/search/indexes/github-docs-3.3-ja-records.json.br index b5a3fe4bd2..1c6749270c 100644 --- a/lib/search/indexes/github-docs-3.3-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.3-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d70826e54408b2dabd02c5614407ec5eae1d958c68e843b10b8fff96eb48a7cc -size 663272 +oid sha256:40c32b2ab6912b90f65b305e229c4cf28ce93a49e6ab7d3b96d8501b82790033 +size 663177 diff --git a/lib/search/indexes/github-docs-3.3-ja.json.br b/lib/search/indexes/github-docs-3.3-ja.json.br index bcd8eb656a..1b5c1f4fc2 100644 --- a/lib/search/indexes/github-docs-3.3-ja.json.br +++ b/lib/search/indexes/github-docs-3.3-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:62348c413618e243a7d4a62b395078d0a41c6dbd2c21efc86b902a4ccb91d20c -size 3682705 +oid sha256:7f2278696a418b65381861a0559769ae3ce9b13e41de168f1ab9972f0304fc5a +size 3682810 diff --git a/lib/search/indexes/github-docs-3.3-pt-records.json.br b/lib/search/indexes/github-docs-3.3-pt-records.json.br index e4554566fa..995a705fbd 100644 --- a/lib/search/indexes/github-docs-3.3-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.3-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e236bb3e1d6406ee0f4a242fa25823e46479601d5018e25d7d74757c1fede5fc -size 639005 +oid sha256:8ada660b18081cfca90a9f3122f0c9a0d01df3e7746f632fe53f79ef37656c27 +size 638952 diff --git a/lib/search/indexes/github-docs-3.3-pt.json.br b/lib/search/indexes/github-docs-3.3-pt.json.br index 350deac93b..861e6df4ed 100644 --- a/lib/search/indexes/github-docs-3.3-pt.json.br +++ b/lib/search/indexes/github-docs-3.3-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:aa11b795e3b468f91b55b23dd18dcaa972b57ef45490b6cf05d02b0e954c2e3f -size 3006823 +oid sha256:8b9a94f6bc23cee4f5480c88e72ed05b2ac732c2c1585d7a5ee4cca938a39144 +size 3006541 diff --git a/lib/search/indexes/github-docs-dotcom-cn-records.json.br b/lib/search/indexes/github-docs-dotcom-cn-records.json.br index 59dd745864..48c036f041 100644 --- a/lib/search/indexes/github-docs-dotcom-cn-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:62a7f2e4f66df357c261e85c156c01f3df8ee0a049c917f425655f717d7330f7 -size 846358 +oid sha256:dc298a2023686b9d84da8651238ca899cfeaadfe44ef562f43b246d1f80db2e5 +size 846485 diff --git a/lib/search/indexes/github-docs-dotcom-cn.json.br b/lib/search/indexes/github-docs-dotcom-cn.json.br index 85434c8652..7ac783a0ad 100644 --- a/lib/search/indexes/github-docs-dotcom-cn.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:bff1c921b710f2e7ac1074af931f4f45bde90e5ddf10c0296b90c5b21add0bd6 -size 1971460 +oid sha256:49f6fa7a872e9a59b8abeb69f7076073e6eaa181eae2bef5157f0ed44683c631 +size 1972475 diff --git a/lib/search/indexes/github-docs-dotcom-en-records.json.br b/lib/search/indexes/github-docs-dotcom-en-records.json.br index 856239b6a0..6567b8a673 100644 --- a/lib/search/indexes/github-docs-dotcom-en-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:482fbbeb4be48ac7d3686babba7b9361f514a43aba3b16176dc91e67267201a1 -size 1318344 +oid sha256:608791d15597850ab5f99799656a3eec3759ed20366d082401039bde47ebfa30 +size 1325110 diff --git a/lib/search/indexes/github-docs-dotcom-en.json.br b/lib/search/indexes/github-docs-dotcom-en.json.br index b52c7d9046..5a984add07 100644 --- a/lib/search/indexes/github-docs-dotcom-en.json.br +++ b/lib/search/indexes/github-docs-dotcom-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:307252ac9c404aa14830d908ea3b2cf033320b079b06922db18a1b5145468bf2 -size 5061680 +oid sha256:1c8a04a47ebde877bc242a185bfeaf748fd85b02ea5e278581b86b132ae7b5c9 +size 5062996 diff --git a/lib/search/indexes/github-docs-dotcom-es-records.json.br b/lib/search/indexes/github-docs-dotcom-es-records.json.br index 6d0fd9d0a6..008644c332 100644 --- a/lib/search/indexes/github-docs-dotcom-es-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d71b9489dff2523ba510387d24d8f4147e56752286aacb00b32167ac33a76b31 -size 795919 +oid sha256:76cb6a4cc7b9db561bf25653ac64e21700c7cf936c83ab82c37753202224632a +size 796100 diff --git a/lib/search/indexes/github-docs-dotcom-es.json.br b/lib/search/indexes/github-docs-dotcom-es.json.br index 5be41cd42d..e3efef5e7c 100644 --- a/lib/search/indexes/github-docs-dotcom-es.json.br +++ b/lib/search/indexes/github-docs-dotcom-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4ec201ed0b1cfea9baed94c0ab0639a0da39cc08a5098bc8f5c479da8aea826e -size 3505760 +oid sha256:aa758352dc58204d8429573b43a7cca571f5612c9fb05656e69060cec6407013 +size 3504286 diff --git a/lib/search/indexes/github-docs-dotcom-ja-records.json.br b/lib/search/indexes/github-docs-dotcom-ja-records.json.br index 846b70e854..1df66047e6 100644 --- a/lib/search/indexes/github-docs-dotcom-ja-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2350992d5e90e09ee37d187a0c17d53ce3d38559e5411b56679dcf07ce831d5c -size 858691 +oid sha256:df9cad269c9dcb283fb408b83ccac978a735c07effce04f0143ff7c7f204bb49 +size 858827 diff --git a/lib/search/indexes/github-docs-dotcom-ja.json.br b/lib/search/indexes/github-docs-dotcom-ja.json.br index 6ff578d6e9..d74b2ed6f0 100644 --- a/lib/search/indexes/github-docs-dotcom-ja.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:04d4e93c1ba7d318e70e971bfc58c5df40f021efe87183c1c96594a15a93763b -size 4501066 +oid sha256:5ce2a91b742770566b572f79d65963cfe74ee978f33eb87db5da2093f79c512f +size 4501058 diff --git a/lib/search/indexes/github-docs-dotcom-pt-records.json.br b/lib/search/indexes/github-docs-dotcom-pt-records.json.br index 6cb5893aa3..6e343982f2 100644 --- a/lib/search/indexes/github-docs-dotcom-pt-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a702f3af4db73a54e2905786e9baf156488f5be4764913b8566765af4ffae621 -size 810483 +oid sha256:4bb761cfc58e0fa0b01bf5dba72ee77ab3c142f49e4b3dd5f12efebd9edfc3e3 +size 810174 diff --git a/lib/search/indexes/github-docs-dotcom-pt.json.br b/lib/search/indexes/github-docs-dotcom-pt.json.br index 924d37abb8..fed9023e57 100644 --- a/lib/search/indexes/github-docs-dotcom-pt.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:bfba688a45fb872ab6a5a240718e7207688e5d2a1c7424e42b765631faf5b85f -size 3594461 +oid sha256:ab14a6f241e74b6071925f90ef62432a0fcffe35d6a86665ae3d34b1d29a8835 +size 3593914 diff --git a/lib/search/indexes/github-docs-ghae-cn-records.json.br b/lib/search/indexes/github-docs-ghae-cn-records.json.br index 968cdd856c..39195928e6 100644 --- a/lib/search/indexes/github-docs-ghae-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghae-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a4da7dfd5f79d15c4faa70deb05a3d8240df00bde941c584800cae7416a38c21 -size 509983 +oid sha256:61819e4d386853aa9cd47953d7abf7f21dbf6a814ee2bf80bd7307bfd17a367b +size 510081 diff --git a/lib/search/indexes/github-docs-ghae-cn.json.br b/lib/search/indexes/github-docs-ghae-cn.json.br index 4472976756..f90a67becb 100644 --- a/lib/search/indexes/github-docs-ghae-cn.json.br +++ b/lib/search/indexes/github-docs-ghae-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9ebd2296c564d0c13d52e1500520cf9950cbcc49aa9a414d677f694562afc494 -size 1330088 +oid sha256:b95cb9b8820ce80a802aeadfd27a00152b959da81e8436ef04b8abaadca2c161 +size 1330024 diff --git a/lib/search/indexes/github-docs-ghae-en-records.json.br b/lib/search/indexes/github-docs-ghae-en-records.json.br index afc784cd02..86f9e7f703 100644 --- a/lib/search/indexes/github-docs-ghae-en-records.json.br +++ b/lib/search/indexes/github-docs-ghae-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:aad570cba2ba8f28e68ae96f6a2f21d8eabb3864abdd165b5dc45db512e52a06 -size 831221 +oid sha256:f82dd88890220541328a396fd72eeb4de1895d0dd03eb56bc194a51ae206362d +size 831173 diff --git a/lib/search/indexes/github-docs-ghae-en.json.br b/lib/search/indexes/github-docs-ghae-en.json.br index 83c17c994a..f89978089d 100644 --- a/lib/search/indexes/github-docs-ghae-en.json.br +++ b/lib/search/indexes/github-docs-ghae-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2a8049cb57d006c72a0794ac7ac0ff90f7c704485c57519f35f6c93bd5e11d38 -size 3335205 +oid sha256:3de6a6e352bd272beaec58e992aa43587ad491c8b507ecc91fb29b6deb643ff8 +size 3336379 diff --git a/lib/search/indexes/github-docs-ghae-es-records.json.br b/lib/search/indexes/github-docs-ghae-es-records.json.br index cc2517f900..9625bc5e64 100644 --- a/lib/search/indexes/github-docs-ghae-es-records.json.br +++ b/lib/search/indexes/github-docs-ghae-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:81ea2dba5a9349ebfa438f0ef39b769a5a03a1834360cbb4b830a92bd79c9ce1 -size 487929 +oid sha256:f4c43a06b159c4f946592f2424b16a13b32e40c16e1918abfadd3c23c325770f +size 487901 diff --git a/lib/search/indexes/github-docs-ghae-es.json.br b/lib/search/indexes/github-docs-ghae-es.json.br index b3f9c2a25d..bf45e42b9e 100644 --- a/lib/search/indexes/github-docs-ghae-es.json.br +++ b/lib/search/indexes/github-docs-ghae-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ad392eeff32c4c39fa9dc37b51f34b1e80a54eb26865ee1c5f74f57421a69468 -size 2196113 +oid sha256:ef2e44666e77306dc20d1e8a921ee304959002d54abff4da29a88e82b8a9bec6 +size 2194954 diff --git a/lib/search/indexes/github-docs-ghae-ja-records.json.br b/lib/search/indexes/github-docs-ghae-ja-records.json.br index e4eee6522a..6c79bac75b 100644 --- a/lib/search/indexes/github-docs-ghae-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghae-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2da24e4730b6eecfd20aef7e757f897e3d9711b6bc43bee0dc84f0befd53e505 -size 515521 +oid sha256:174894b6448326477d3d74d7c7ed6a122a865d203935310dfad4ed29bbda29f2 +size 515509 diff --git a/lib/search/indexes/github-docs-ghae-ja.json.br b/lib/search/indexes/github-docs-ghae-ja.json.br index d36fa2c57a..eb0d8cc9aa 100644 --- a/lib/search/indexes/github-docs-ghae-ja.json.br +++ b/lib/search/indexes/github-docs-ghae-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9a42e755b42a05fa5abaac64f9c4864febfb62a6204bb3b8619f83b6ef77ff9d -size 2746039 +oid sha256:0af59e207df49a1c6221ad403f131de27aef2eb768123fc53a69b5a878c4f9de +size 2746351 diff --git a/lib/search/indexes/github-docs-ghae-pt-records.json.br b/lib/search/indexes/github-docs-ghae-pt-records.json.br index de10ee91c1..3af6516ae6 100644 --- a/lib/search/indexes/github-docs-ghae-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghae-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e7fedc7858d305e7a091dad9fb66c9be8adfba8a1c1ed0f75bbfc99e7a0bc150 -size 500218 +oid sha256:35d18144ef396d2c0032b46be5eb90c020088722422c924d656c85a0621dfb3e +size 500275 diff --git a/lib/search/indexes/github-docs-ghae-pt.json.br b/lib/search/indexes/github-docs-ghae-pt.json.br index dc2933f0dd..b1a57f4628 100644 --- a/lib/search/indexes/github-docs-ghae-pt.json.br +++ b/lib/search/indexes/github-docs-ghae-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:355368427f64fcd392c6241091d229e61c740284c11c1bb2c059daab22b6a0b2 -size 2277398 +oid sha256:7c0fa6bae59c4d0fe9beeda4e438f57e592d1d137ffe2ee48888e77c41fbdfd8 +size 2276409 diff --git a/lib/search/indexes/github-docs-ghec-cn-records.json.br b/lib/search/indexes/github-docs-ghec-cn-records.json.br index dbe6911df3..0535d4c229 100644 --- a/lib/search/indexes/github-docs-ghec-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghec-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:741c0f7d0de230bc3c422f4043805368dd0c1b5a2a1549e13289ce333350f4e2 -size 770648 +oid sha256:1cb45a624a1155e0d23faaab5bf4f8a05664a1b30e1d222402299731c5bc0253 +size 770555 diff --git a/lib/search/indexes/github-docs-ghec-cn.json.br b/lib/search/indexes/github-docs-ghec-cn.json.br index 1e5d8e8261..fbff7bc3ff 100644 --- a/lib/search/indexes/github-docs-ghec-cn.json.br +++ b/lib/search/indexes/github-docs-ghec-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d64c5fb18764e04c1e8f51a87d4d77269c4cf2bfb632fce7e6b6c4123a58e1b4 -size 1988547 +oid sha256:f9c1a21f0ba76b7541c95573813286a45a29abb880d9fa086facf73921ba2c23 +size 1988193 diff --git a/lib/search/indexes/github-docs-ghec-en-records.json.br b/lib/search/indexes/github-docs-ghec-en-records.json.br index f18b086952..cbaf2729f7 100644 --- a/lib/search/indexes/github-docs-ghec-en-records.json.br +++ b/lib/search/indexes/github-docs-ghec-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f639c6b3a5ce25ec4bdaba4e2c7ec329001991f5a3f961a7024368ef960bd42d -size 1186157 +oid sha256:d761e20d94679f26f47a73b7827e8bbe548fa618052890cd0ab624f0f526e198 +size 1186527 diff --git a/lib/search/indexes/github-docs-ghec-en.json.br b/lib/search/indexes/github-docs-ghec-en.json.br index 25889c2806..d8350d7b2d 100644 --- a/lib/search/indexes/github-docs-ghec-en.json.br +++ b/lib/search/indexes/github-docs-ghec-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:77ce50a4077a8d3d73f66fb9a2e25eb8304b5bdc486748f56c236ecab7895bf0 -size 4790370 +oid sha256:6e55b6874002c21a9428adab9685d2b2a82cc1adfb4d9c83c5055fa177fcbc0c +size 4791571 diff --git a/lib/search/indexes/github-docs-ghec-es-records.json.br b/lib/search/indexes/github-docs-ghec-es-records.json.br index 8eff7e7494..153f3d0683 100644 --- a/lib/search/indexes/github-docs-ghec-es-records.json.br +++ b/lib/search/indexes/github-docs-ghec-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f272dce0200833fcea3d1f8da0bfde6b3040a04b40b1ef18e3807e5ed49c2ed5 -size 740692 +oid sha256:42ba7457c895fb62434af9eaf0de4c73bea943667b8449de903c99b8c87ca85f +size 740566 diff --git a/lib/search/indexes/github-docs-ghec-es.json.br b/lib/search/indexes/github-docs-ghec-es.json.br index ca18fa132a..3db2340652 100644 --- a/lib/search/indexes/github-docs-ghec-es.json.br +++ b/lib/search/indexes/github-docs-ghec-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ef53e25967fa8e83712df72372a7e3edb60c30d868636e1010871b52d0ef8276 -size 3447782 +oid sha256:774a199c6192647d60a4076e18fc273740b264b1f439353b699704ba97520855 +size 3447924 diff --git a/lib/search/indexes/github-docs-ghec-ja-records.json.br b/lib/search/indexes/github-docs-ghec-ja-records.json.br index f64313393f..f0b6d7165d 100644 --- a/lib/search/indexes/github-docs-ghec-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghec-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:236ff7d5384695110a860973ff6e53bef7447f4bb854e8fbcecb523a1343e533 -size 785390 +oid sha256:7da3a8b7a68d2e100110fcef073863d273b9e52d5e4cfa1df48d03b1049b6772 +size 785207 diff --git a/lib/search/indexes/github-docs-ghec-ja.json.br b/lib/search/indexes/github-docs-ghec-ja.json.br index 484b590fb6..8056577764 100644 --- a/lib/search/indexes/github-docs-ghec-ja.json.br +++ b/lib/search/indexes/github-docs-ghec-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:92ec3b77488b5cd1f2dd9934b4de562609381474c08868e9e249c069ee7b682f -size 4340916 +oid sha256:48f9d6df0a3d38a95c249b1394fed5da3aaff9d8f1350f0324f7e14e0440fff1 +size 4340716 diff --git a/lib/search/indexes/github-docs-ghec-pt-records.json.br b/lib/search/indexes/github-docs-ghec-pt-records.json.br index 21b4e83fa3..5f7fedb171 100644 --- a/lib/search/indexes/github-docs-ghec-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghec-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:80a6b35e31d3657d6d0d43ffa7c26ce4639f4e868970575a2a6c6ab4c9902d55 -size 754701 +oid sha256:44854c698277c32aa45dc1ba634704e20ee83526cc32f90fa44370b14ac2605d +size 754632 diff --git a/lib/search/indexes/github-docs-ghec-pt.json.br b/lib/search/indexes/github-docs-ghec-pt.json.br index 3c4a8239fe..2f9a1a6e33 100644 --- a/lib/search/indexes/github-docs-ghec-pt.json.br +++ b/lib/search/indexes/github-docs-ghec-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:62a5f1fc498b61c46cf48211703a3b1f6151d0f85cdc2cfda6c6ce2fc91b969a -size 3529592 +oid sha256:d2bf21eb03a97eca3f4896507821a6e5de81022e988b0833b604281527ca70c2 +size 3529627 diff --git a/translations/log/cn-resets.csv b/translations/log/cn-resets.csv index d86301cbc4..6b8e2855b6 100644 --- a/translations/log/cn-resets.csv +++ b/translations/log/cn-resets.csv @@ -60,7 +60,15 @@ translations/zh-CN/content/actions/deployment/about-deployments/about-continuous translations/zh-CN/content/actions/deployment/about-deployments/deploying-with-github-actions.md,rendering error translations/zh-CN/content/actions/deployment/about-deployments/index.md,rendering error translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-amazon-elastic-container-service.md,rendering error -translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure-app-service.md,rendering error +translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service.md,rendering error +translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service.md,rendering error +translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md,rendering error +translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md,rendering error +translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md,rendering error +translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md,rendering error +translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-kubernetes-service.md,rendering error +translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md,rendering error +translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/index.md,rendering error translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-google-kubernetes-engine.md,rendering error translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/index.md,rendering error translations/zh-CN/content/actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development.md,rendering error @@ -262,6 +270,7 @@ translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-ser translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-xenserver.md,rendering error translations/zh-CN/content/admin/overview/about-enterprise-accounts.md,Listed in localization-support#489 translations/zh-CN/content/admin/overview/about-enterprise-accounts.md,rendering error +translations/zh-CN/content/admin/overview/about-github-ae.md,rendering error translations/zh-CN/content/admin/overview/about-the-github-enterprise-api.md,rendering error translations/zh-CN/content/admin/overview/about-upgrades-to-new-releases.md,rendering error translations/zh-CN/content/admin/packages/enabling-github-packages-with-aws.md,rendering error @@ -420,6 +429,7 @@ translations/zh-CN/content/code-security/supply-chain-security/keeping-your-depe translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md,rendering error translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,Listed in localization-support#489 translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,parsing error +translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,rendering error translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md,rendering error translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md,rendering error translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md,rendering error @@ -460,9 +470,19 @@ translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/set translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md,rendering error translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md,rendering error translations/zh-CN/content/communities/documenting-your-project-with-wikis/about-wikis.md,rendering error +translations/zh-CN/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md,rendering error +translations/zh-CN/content/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki.md,rendering error +translations/zh-CN/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md,rendering error +translations/zh-CN/content/communities/documenting-your-project-with-wikis/index.md,rendering error translations/zh-CN/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md,rendering error translations/zh-CN/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md,rendering error +translations/zh-CN/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md,rendering error translations/zh-CN/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md,rendering error +translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md,rendering error +translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/index.md,rendering error +translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md,rendering error +translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/index.md,rendering error +translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md,rendering error translations/zh-CN/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md,rendering error translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md,rendering error translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github.md,rendering error @@ -471,24 +491,64 @@ translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/ins translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md,rendering error translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md,rendering error translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/overview/keyboard-shortcuts.md,rendering error +translations/zh-CN/content/developers/apps/building-github-apps/authenticating-with-github-apps.md,rendering error translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app-from-a-manifest.md,rendering error translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md,rendering error +translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app.md,rendering error translations/zh-CN/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md,rendering error +translations/zh-CN/content/developers/apps/building-github-apps/index.md,rendering error +translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md,rendering error translations/zh-CN/content/developers/apps/building-github-apps/refreshing-user-to-server-access-tokens.md,rendering error +translations/zh-CN/content/developers/apps/building-github-apps/setting-permissions-for-github-apps.md,rendering error translations/zh-CN/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md,rendering error +translations/zh-CN/content/developers/apps/building-oauth-apps/creating-an-oauth-app.md,rendering error +translations/zh-CN/content/developers/apps/building-oauth-apps/index.md,rendering error translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md,rendering error translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md,rendering error translations/zh-CN/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md,rendering error translations/zh-CN/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md,rendering error translations/zh-CN/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md,rendering error translations/zh-CN/content/developers/apps/guides/using-content-attachments.md,rendering error +translations/zh-CN/content/developers/apps/guides/using-the-github-api-in-your-app.md,rendering error +translations/zh-CN/content/developers/apps/index.md,rendering error +translations/zh-CN/content/developers/apps/managing-github-apps/deleting-a-github-app.md,rendering error +translations/zh-CN/content/developers/apps/managing-github-apps/editing-a-github-apps-permissions.md,rendering error +translations/zh-CN/content/developers/apps/managing-github-apps/index.md,rendering error translations/zh-CN/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md,rendering error +translations/zh-CN/content/developers/apps/managing-github-apps/modifying-a-github-app.md,rendering error +translations/zh-CN/content/developers/apps/managing-github-apps/transferring-ownership-of-a-github-app.md,rendering error +translations/zh-CN/content/developers/apps/managing-oauth-apps/deleting-an-oauth-app.md,rendering error +translations/zh-CN/content/developers/apps/managing-oauth-apps/index.md,rendering error +translations/zh-CN/content/developers/apps/managing-oauth-apps/modifying-an-oauth-app.md,rendering error +translations/zh-CN/content/developers/apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app.md,rendering error +translations/zh-CN/content/developers/apps/managing-oauth-apps/troubleshooting-authorization-request-errors.md,rendering error +translations/zh-CN/content/developers/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors.md,rendering error +translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md,rendering error +translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/security-best-practices-for-apps.md,rendering error +translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/viewing-metrics-for-your-listing.md,rendering error translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md,rendering error translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/index.md,rendering error +translations/zh-CN/content/developers/github-marketplace/index.md,rendering error +translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md,rendering error +translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md,rendering error +translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/index.md,rendering error +translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing.md,rendering error +translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md,rendering error +translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/billing-customers.md,rendering error +translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/index.md,rendering error +translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md,rendering error translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/receiving-payment-for-app-purchases.md,rendering error translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md,rendering error +translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations.md,rendering error +translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-changes.md,rendering error +translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/index.md,rendering error +translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md,rendering error +translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app.md,rendering error +translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api.md,rendering error translations/zh-CN/content/developers/overview/managing-deploy-keys.md,rendering error +translations/zh-CN/content/developers/overview/replacing-github-services.md,rendering error translations/zh-CN/content/developers/overview/secret-scanning-partner-program.md,rendering error +translations/zh-CN/content/developers/overview/using-ssh-agent-forwarding.md,rendering error translations/zh-CN/content/developers/webhooks-and-events/webhooks/about-webhooks.md,rendering error translations/zh-CN/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md,rendering error translations/zh-CN/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md,rendering error @@ -522,11 +582,16 @@ translations/zh-CN/content/get-started/getting-started-with-git/managing-remote- translations/zh-CN/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md,rendering error translations/zh-CN/content/get-started/index.md,rendering error translations/zh-CN/content/get-started/learning-about-github/about-github-advanced-security.md,rendering error +translations/zh-CN/content/get-started/learning-about-github/about-versions-of-github-docs.md,rendering error translations/zh-CN/content/get-started/learning-about-github/access-permissions-on-github.md,rendering error translations/zh-CN/content/get-started/learning-about-github/githubs-products.md,rendering error translations/zh-CN/content/get-started/learning-about-github/index.md,rendering error translations/zh-CN/content/get-started/learning-about-github/types-of-github-accounts.md,rendering error +translations/zh-CN/content/get-started/onboarding/getting-started-with-github-ae.md,rendering error translations/zh-CN/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md,rendering error +translations/zh-CN/content/get-started/onboarding/getting-started-with-github-enterprise-server.md,rendering error +translations/zh-CN/content/get-started/onboarding/getting-started-with-github-team.md,rendering error +translations/zh-CN/content/get-started/onboarding/getting-started-with-your-github-account.md,rendering error translations/zh-CN/content/get-started/quickstart/be-social.md,rendering error translations/zh-CN/content/get-started/quickstart/communicating-on-github.md,rendering error translations/zh-CN/content/get-started/quickstart/create-a-repo.md,rendering error @@ -600,9 +665,20 @@ translations/zh-CN/content/graphql/guides/migrating-graphql-global-node-ids.md,r translations/zh-CN/content/graphql/index.md,rendering error translations/zh-CN/content/graphql/reference/mutations.md,rendering error translations/zh-CN/content/issues/guides.md,rendering error +translations/zh-CN/content/issues/index.md,rendering error +translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md,rendering error +translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md,rendering error +translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md,rendering error +translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md,rendering error +translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md,rendering error +translations/zh-CN/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md,rendering error +translations/zh-CN/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md,rendering error +translations/zh-CN/content/issues/tracking-your-work-with-issues/about-issues.md,rendering error translations/zh-CN/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md,rendering error +translations/zh-CN/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md,rendering error translations/zh-CN/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md,rendering error translations/zh-CN/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md,rendering error +translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md,rendering error translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md,rendering error translations/zh-CN/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md,rendering error translations/zh-CN/content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md,rendering error @@ -688,20 +764,41 @@ translations/zh-CN/content/pages/configuring-a-custom-domain-for-your-github-pag translations/zh-CN/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md,rendering error translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md,Listed in localization-support#489 translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md,rendering error +translations/zh-CN/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md,rendering error +translations/zh-CN/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md,rendering error +translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md,rendering error +translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md,rendering error +translations/zh-CN/content/pages/getting-started-with-github-pages/index.md,rendering error +translations/zh-CN/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md,rendering error +translations/zh-CN/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md,rendering error translations/zh-CN/content/pages/index.md,rendering error +translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md,rendering error translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md,rendering error translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md,rendering error +translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md,rendering error +translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/index.md,rendering error translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md,rendering error +translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md,rendering error translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md,rendering error +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/index.md,rendering error translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md,rendering error +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md,rendering error +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md,rendering error translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/index.md,rendering error translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models.md,rendering error translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/getting-started/index.md,rendering error +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md,rendering error translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md,rendering error +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/index.md,rendering error translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/index.md,rendering error translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md,rendering error translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md,rendering error translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md,rendering error +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md,rendering error +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/index.md,rendering error +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md,rendering error +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md,rendering error +translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/index.md,rendering error translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md,rendering error translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md,rendering error translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/index.md,rendering error @@ -760,14 +857,19 @@ translations/zh-CN/content/repositories/working-with-files/using-files/navigatin translations/zh-CN/content/repositories/working-with-files/using-files/tracking-changes-in-a-file.md,rendering error translations/zh-CN/content/rest/guides/basics-of-authentication.md,Listed in localization-support#489 translations/zh-CN/content/rest/guides/basics-of-authentication.md,rendering error +translations/zh-CN/content/rest/guides/best-practices-for-integrators.md,rendering error +translations/zh-CN/content/rest/guides/building-a-ci-server.md,rendering error +translations/zh-CN/content/rest/guides/delivering-deployments.md,rendering error translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md,rendering error translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md,rendering error translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md,rendering error translations/zh-CN/content/rest/guides/index.md,rendering error +translations/zh-CN/content/rest/guides/rendering-data-as-graphs.md,rendering error translations/zh-CN/content/rest/guides/traversing-with-pagination.md,rendering error translations/zh-CN/content/rest/guides/working-with-comments.md,rendering error translations/zh-CN/content/rest/index.md,rendering error translations/zh-CN/content/rest/overview/api-previews.md,rendering error +translations/zh-CN/content/rest/overview/libraries.md,rendering error translations/zh-CN/content/rest/overview/other-authentication-methods.md,Listed in localization-support#489 translations/zh-CN/content/rest/overview/other-authentication-methods.md,rendering error translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md,Listed in localization-support#489 @@ -794,6 +896,8 @@ translations/zh-CN/content/rest/reference/teams.md,rendering error translations/zh-CN/content/rest/reference/webhooks.md,rendering error translations/zh-CN/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md,rendering error translations/zh-CN/content/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment.md,rendering error +translations/zh-CN/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md,rendering error +translations/zh-CN/content/search-github/index.md,rendering error translations/zh-CN/content/search-github/searching-on-github/searching-commits.md,rendering error translations/zh-CN/content/search-github/searching-on-github/searching-discussions.md,rendering error translations/zh-CN/content/search-github/searching-on-github/searching-for-repositories.md,rendering error diff --git a/translations/zh-CN/content/actions/creating-actions/index.md b/translations/zh-CN/content/actions/creating-actions/index.md index 7ed06229d7..1d91ced73d 100644 --- a/translations/zh-CN/content/actions/creating-actions/index.md +++ b/translations/zh-CN/content/actions/creating-actions/index.md @@ -6,7 +6,7 @@ redirect_from: - /github/automating-your-workflow-with-github-actions/building-actions - /actions/automating-your-workflow-with-github-actions/building-actions - /actions/building-actions - - /articles/creating-a-github-action/ + - /articles/creating-a-github-action versions: fpt: '*' ghes: '*' diff --git a/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service.md b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service.md new file mode 100644 index 0000000000..8133adef88 --- /dev/null +++ b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service.md @@ -0,0 +1,153 @@ +--- +title: Deploying Docker to Azure App Service +intro: You can deploy a Docker container to Azure App Service as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Containers + - Docker + - Azure App Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a Docker container to [Azure App Service](https://azure.microsoft.com/services/app-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +{% data reusables.actions.create-azure-app-plan %} + +1. Create a web app. + + For example, you can use the Azure CLI to create an Azure App Service web app: + + ```bash{:copy} + az webapp create \ + --name MY_WEBAPP_NAME \ + --plan MY_APP_SERVICE_PLAN \ + --resource-group MY_RESOURCE_GROUP \ + --deployment-container-image-name nginx:latest + ``` + + In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app. + +{% data reusables.actions.create-azure-publish-profile %} + +1. Set registry credentials for your web app. + + Create a personal access token with the `repo` and `read:packages` scopes. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + + Set `DOCKER_REGISTRY_SERVER_URL` to `https://ghcr.io`, `DOCKER_REGISTRY_SERVER_USERNAME` to the GitHub username or organization that owns the repository, and `DOCKER_REGISTRY_SERVER_PASSWORD` to your personal access token from above. This will give your web app credentials so it can pull the container image after your workflow pushes a newly built image to the registry. You can do this with the following Azure CLI command: + + ```shell + az webapp config appsettings set \ + --name MY_WEBAPP_NAME \ + --resource-group MY_RESOURCE_GROUP \ + --settings DOCKER_REGISTRY_SERVER_URL=https://ghcr.io DOCKER_REGISTRY_SERVER_USERNAME=MY_REPOSITORY_OWNER DOCKER_REGISTRY_SERVER_PASSWORD=MY_PERSONAL_ACCESS_TOKEN +``` + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +{% endif %} + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy a Docker container to Azure App Service when there is a push to the `main` branch. + +Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. + +{% data reusables.actions.delete-env-key %} + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Build and deploy a container to an Azure Web App + +env: + AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name + +on: + push: + branches: + - main + +permissions: + contents: 'read' + packages: 'write' + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v1 + + - name: Log in to GitHub container registry + uses: docker/login-action@v1.10.0 + with: + registry: ghcr.io + username: {% raw %}${{ github.actor }}{% endraw %} + password: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + + - name: Lowercase the repo name + run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV} + + - name: Build and push container image to registry + uses: docker/build-push-action@v2 + with: + push: true + tags: ghcr.io/{% raw %}${{ env.REPO }}{% endraw %}:{% raw %}${{ github.sha }}{% endraw %} + file: ./Dockerfile + + deploy: + runs-on: ubuntu-latest + needs: build + environment: + name: 'production' + url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %} + + steps: + - name: Lowercase the repo name + run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV} + + - name: Deploy to Azure Web App + id: deploy-to-webapp + uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e + with: + app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %} + publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %} + images: 'ghcr.io/{% raw %}${{ env.REPO }}{% endraw %}:{% raw %}${{ github.sha }}{% endraw %}' +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-container-webapp.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-container-webapp.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service.md b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service.md new file mode 100644 index 0000000000..7959f41764 --- /dev/null +++ b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service.md @@ -0,0 +1,134 @@ +--- +title: Deploying Java to Azure App Service +intro: You can deploy your Java project to Azure App Service as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Java + - Azure App Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a Java project to [Azure App Service](https://azure.microsoft.com/services/app-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +{% data reusables.actions.create-azure-app-plan %} + +1. Create a web app. + + For example, you can use the Azure CLI to create an Azure App Service web app with a Java runtime: + + ```bash{:copy} + az webapp create \ + --name MY_WEBAPP_NAME \ + --plan MY_APP_SERVICE_PLAN \ + --resource-group MY_RESOURCE_GROUP \ + --runtime "JAVA|11-java11" + ``` + + In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app. + +{% data reusables.actions.create-azure-publish-profile %} + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +1. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +{% endif %} + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy a Java project to Azure App Service when there is a push to the `main` branch. + +Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If you want to use a Java version other than `11`, change `JAVA_VERSION`. + +{% data reusables.actions.delete-env-key %} + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Build and deploy JAR app to Azure Web App + +env: + AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name + JAVA_VERSION: '11' # set this to the Java version to use + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Set up Java version + uses: actions/setup-java@v2.3.1 + with: + java-version: {% raw %}${{ env.JAVA_VERSION }}{% endraw %} + cache: 'maven' + + - name: Build with Maven + run: mvn clean install + + - name: Upload artifact for deployment job + uses: actions/upload-artifact@v2 + with: + name: java-app + path: '{% raw %}${{ github.workspace }}{% endraw %}/target/*.jar' + + deploy: + runs-on: ubuntu-latest + needs: build + environment: + name: 'production' + url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %} + + steps: + - name: Download artifact from build job + uses: actions/download-artifact@v2 + with: + name: java-app + + - name: Deploy to Azure Web App + id: deploy-to-webapp + uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e + with: + app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %} + publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %} + package: '*.jar' +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-webapps-java-jar.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-java-jar.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md new file mode 100644 index 0000000000..2da7e39ce0 --- /dev/null +++ b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md @@ -0,0 +1,144 @@ +--- +title: Deploying .NET to Azure App Service +intro: You can deploy your .NET project to Azure App Service as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Azure App Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a .NET project to [Azure App Service](https://azure.microsoft.com/services/app-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +{% data reusables.actions.create-azure-app-plan %} + +2. Create a web app. + + For example, you can use the Azure CLI to create an Azure App Service web app with a .NET runtime: + + ```bash{:copy} + az webapp create \ + --name MY_WEBAPP_NAME \ + --plan MY_APP_SERVICE_PLAN \ + --resource-group MY_RESOURCE_GROUP \ + --runtime "DOTNET|5.0" + ``` + + In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app. + +{% data reusables.actions.create-azure-publish-profile %} + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +{% endif %} + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy a .NET project to Azure App Service when there is a push to the `main` branch. + +Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If the path to your project is not the repository root, change `AZURE_WEBAPP_PACKAGE_PATH`. If you use a version of .NET other than `5`, change `DOTNET_VERSION`. + +{% data reusables.actions.delete-env-key %} + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Build and deploy ASP.Net Core app to an Azure Web App + +env: + AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name + AZURE_WEBAPP_PACKAGE_PATH: '.' # set this to the path to your web app project, defaults to the repository root + DOTNET_VERSION: '5' # set this to the .NET Core version to use + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Set up .NET Core + uses: actions/setup-dotnet@v1 + with: + dotnet-version: {% raw %}${{ env.DOTNET_VERSION }}{% endraw %} + + - name: Set up dependency caching for faster builds + uses: actions/cache@v2 + with: + path: ~/.nuget/packages + key: {% raw %}${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}{% endraw %} + restore-keys: | + {% raw %}${{ runner.os }}-nuget-{% endraw %} + + - name: Build with dotnet + run: dotnet build --configuration Release + + - name: dotnet publish + run: dotnet publish -c Release -o {% raw %}${{env.DOTNET_ROOT}}{% endraw %}/myapp + + - name: Upload artifact for deployment job + uses: actions/upload-artifact@v2 + with: + name: .net-app + path: {% raw %}${{env.DOTNET_ROOT}}{% endraw %}/myapp + + deploy: + runs-on: ubuntu-latest + needs: build + environment: + name: 'production' + url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %} + + steps: + - name: Download artifact from build job + uses: actions/download-artifact@v2 + with: + name: .net-app + + - name: Deploy to Azure Web App + id: deploy-to-webapp + uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e + with: + app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %} + publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %} + package: {% raw %}${{ env.AZURE_WEBAPP_PACKAGE_PATH }}{% endraw %} +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-webapps-dotnet-core.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-dotnet-core.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md new file mode 100644 index 0000000000..e6f8f08b7c --- /dev/null +++ b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md @@ -0,0 +1,141 @@ +--- +title: Deploying Node.js to Azure App Service +intro: You can deploy your Node.js project to Azure App Service as part of your continuous deployment (CD) workflows. +redirect_from: + - /actions/guides/deploying-to-azure-app-service + - /actions/deployment/deploying-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure-app-service +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Node + - JavaScript + - Azure App Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build, test, and deploy a Node.js project to [Azure App Service](https://azure.microsoft.com/services/app-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +{% data reusables.actions.create-azure-app-plan %} + +2. Create a web app. + + For example, you can use the Azure CLI to create an Azure App Service web app with a Node.js runtime: + + ```bash{:copy} + az webapp create \ + --name MY_WEBAPP_NAME \ + --plan MY_APP_SERVICE_PLAN \ + --resource-group MY_RESOURCE_GROUP \ + --runtime "NODE|14-lts" + ``` + + In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app. + +{% data reusables.actions.create-azure-publish-profile %} + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +{% endif %} + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build, test, and deploy the Node.js project to Azure App Service when there is a push to the `main` branch. + +Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If the path to your project is not the repository root, change `AZURE_WEBAPP_PACKAGE_PATH` to your project path. If you use a version of Node.js other than `10.x`, change `NODE_VERSION` to the version that you use. + +{% data reusables.actions.delete-env-key %} + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + push: + branches: + - main + +env: + AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name + AZURE_WEBAPP_PACKAGE_PATH: '.' # set this to the path to your web app project, defaults to the repository root + NODE_VERSION: '14.x' # set this to the node version to use + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: Set up Node.js + uses: actions/setup-node@v2 + with: + node-version: {% raw %}${{ env.NODE_VERSION }}{% endraw %} + cache: 'npm' + + - name: npm install, build, and test + run: | + npm install + npm run build --if-present + npm run test --if-present + - name: Upload artifact for deployment job + uses: actions/upload-artifact@v2 + with: + name: node-app + path: . + + deploy: + runs-on: ubuntu-latest + needs: build + environment: + name: 'production' + url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %} + + steps: + - name: Download artifact from build job + uses: actions/download-artifact@v2 + with: + name: node-app + + - name: 'Deploy to Azure WebApp' + id: deploy-to-webapp + uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e + with: + app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %} + publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %} + package: {% raw %}${{ env.AZURE_WEBAPP_PACKAGE_PATH }}{% endraw %} +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-webapps-node.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-node.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the +[actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. +* The "[Create a Node.js web app in Azure](https://docs.microsoft.com/azure/app-service/quickstart-nodejs)" quickstart in the Azure web app documentation demonstrates using VS Code with the [Azure App Service extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureappservice). diff --git a/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md new file mode 100644 index 0000000000..3931a1c6eb --- /dev/null +++ b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md @@ -0,0 +1,155 @@ +--- +title: Deploying PHP to Azure App Service +intro: You can deploy your PHP project to Azure App Service as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Azure App Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a PHP project to [Azure App Service](https://azure.microsoft.com/services/app-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +{% data reusables.actions.create-azure-app-plan %} + +2. Create a web app. + + For example, you can use the Azure CLI to create an Azure App Service web app with a PHP runtime: + + ```bash{:copy} + az webapp create \ + --name MY_WEBAPP_NAME \ + --plan MY_APP_SERVICE_PLAN \ + --resource-group MY_RESOURCE_GROUP \ + --runtime "php|7.4" + ``` + + In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app. + +{% data reusables.actions.create-azure-publish-profile %} + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +{% endif %} + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy a PHP project to Azure App Service when there is a push to the `main` branch. + +Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If the path to your project is not the repository root, change `AZURE_WEBAPP_PACKAGE_PATH` to the path to your project. If you use a version of PHP other than `8.x`, change`PHP_VERSION` to the version that you use. + +{% data reusables.actions.delete-env-key %} + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Build and deploy PHP app to Azure Web App + +env: + AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name + AZURE_WEBAPP_PACKAGE_PATH: '.' # set this to the path to your web app project, defaults to the repository root + PHP_VERSION: '8.x' # set this to the PHP version to use + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: {% raw %}${{ env.PHP_VERSION }}{% endraw %} + + - name: Check if composer.json exists + id: check_files + uses: andstor/file-existence-action@v1 + with: + files: 'composer.json' + + - name: Get Composer Cache Directory + id: composer-cache + if: steps.check_files.outputs.files_exists == 'true' + run: | + echo "::set-output name=dir::$(composer config cache-files-dir)" + + - name: Set up dependency caching for faster installs + uses: actions/cache@v2 + if: steps.check_files.outputs.files_exists == 'true' + with: + path: {% raw %}${{ steps.composer-cache.outputs.dir }}{% endraw %} + key: {% raw %}${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}{% endraw %} + restore-keys: | + {% raw %}${{ runner.os }}-composer-{% endraw %} + + - name: Run composer install if composer.json exists + if: steps.check_files.outputs.files_exists == 'true' + run: composer validate --no-check-publish && composer install --prefer-dist --no-progress + + - name: Upload artifact for deployment job + uses: actions/upload-artifact@v2 + with: + name: php-app + path: . + + deploy: + runs-on: ubuntu-latest + needs: build + environment: + name: 'production' + url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %} + + steps: + - name: Download artifact from build job + uses: actions/download-artifact@v2 + with: + name: php-app + + - name: 'Deploy to Azure Web App' + id: deploy-to-webapp + uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e + with: + app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %} + publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %} + package: . +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-webapps-php.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-php.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md new file mode 100644 index 0000000000..f7001b459c --- /dev/null +++ b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md @@ -0,0 +1,151 @@ +--- +title: Deploying Python to Azure App Service +intro: You can deploy your Python project to Azure App Service as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Python + - Azure App Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a Python project to [Azure App Service](https://azure.microsoft.com/services/app-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +{% data reusables.actions.create-azure-app-plan %} + +1. Create a web app. + + For example, you can use the Azure CLI to create an Azure App Service web app with a Python runtime: + + ```bash{:copy} + az webapp create \ + --name MY_WEBAPP_NAME \ + --plan MY_APP_SERVICE_PLAN \ + --resource-group MY_RESOURCE_GROUP \ + --runtime "python|3.8" + ``` + + In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app. + +{% data reusables.actions.create-azure-publish-profile %} + +1. Add an app setting called `SCM_DO_BUILD_DURING_DEPLOYMENT` and set the value to `1`. + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +{% endif %} + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy a Python project to Azure App Service when there is a push to the `main` branch. + +Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If you use a version of Python other than `3.8`, change `PYTHON_VERSION` to the version that you use. + +{% data reusables.actions.delete-env-key %} + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Build and deploy Python app to Azure Web App + +env: + AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name + PYTHON_VERSION: '3.8' # set this to the Python version to use + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Set up Python version + uses: actions/setup-python@v2.2.2 + with: + python-version: {% raw %}${{ env.PYTHON_VERSION }}{% endraw %} + + - name: Create and start virtual environment + run: | + python -m venv venv + source venv/bin/activate + + - name: Set up dependency caching for faster installs + uses: actions/cache@v2 + with: + path: ~/.cache/pip + key: {% raw %}${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}{% endraw %} + restore-keys: | + {% raw %}${{ runner.os }}-pip-{% endraw %} + + - name: Install dependencies + run: pip install -r requirements.txt + + # Optional: Add a step to run tests here (PyTest, Django test suites, etc.) + + - name: Upload artifact for deployment jobs + uses: actions/upload-artifact@v2 + with: + name: python-app + path: | + . + !venv/ + deploy: + runs-on: ubuntu-latest + needs: build + environment: + name: 'production' + url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %} + + steps: + - name: Download artifact from build job + uses: actions/download-artifact@v2 + with: + name: python-app + path: . + + - name: 'Deploy to Azure Web App' + id: deploy-to-webapp + uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e + with: + app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %} + publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %} +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-webapps-python.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-python.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-kubernetes-service.md b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-kubernetes-service.md new file mode 100644 index 0000000000..f6ab7573d2 --- /dev/null +++ b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-kubernetes-service.md @@ -0,0 +1,126 @@ +--- +title: Deploying to Azure Kubernetes Service +intro: You can deploy your project to Azure Kubernetes Service (AKS) as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Azure Kubernetes Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a project to [Azure Kubernetes Service](https://azure.microsoft.com/services/kubernetes-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +1. Create a target AKS cluster and an Azure Container Registry (ACR). For more information, see "[Quickstart: Deploy an AKS cluster by using the Azure portal - Azure Kubernetes Service](https://docs.microsoft.com/azure/aks/kubernetes-walkthrough-portal)" and "[Quickstart - Create registry in portal - Azure Container Registry](https://docs.microsoft.com/azure/container-registry/container-registry-get-started-portal)" in the Azure documentation. + +1. Create a secret called `AZURE_CREDENTIALS` to store your Azure credentials. For more information about how to find this information and structure the secret, see [the `Azure/login` action documentation](https://github.com/Azure/login#configure-a-service-principal-with-a-secret). + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy a project to Azure Kubernetes Service when code is pushed to your repository. + +Under the workflow `env` key, change the the following values: +- `AZURE_CONTAINER_REGISTRY` to the name of your container registry +- `PROJECT_NAME` to the name of your project +- `RESOURCE_GROUP` to the resource group containing your AKS cluster +- `CLUSTER_NAME` to the name of your AKS cluster + +This workflow uses the `helm` render engine for the [`azure/k8s-bake` action](https://github.com/Azure/k8s-bake). If you will use the `helm` render engine, change the value of `CHART_PATH` to the path to your helm file. Change `CHART_OVERRIDE_PATH` to an array of override file paths. If you use a different render engine, update the input parameters sent to the `azure/k8s-bake` action. + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Build and deploy to Azure Kubernetes Service + +env: + AZURE_CONTAINER_REGISTRY: MY_REGISTRY_NAME # set this to the name of your container registry + PROJECT_NAME: MY_PROJECT_NAME # set this to your project's name + RESOURCE_GROUP: MY_RESOURCE_GROUP # set this to the resource group containing your AKS cluster + CLUSTER_NAME: MY_CLUSTER_NAME # set this to the name of your AKS cluster + REGISTRY_URL: MY_REGISTRY_URL # set this to the URL of your registry + # If you bake using helm: + CHART_PATH: MY_HELM_FILE # set this to the path to your helm file + CHART_OVERRIDE_PATH: MY_OVERRIDE_FILES # set this to an array of override file paths + +on: [push] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + + - name: Azure Login + uses: azure/login@89d153571fe9a34ed70fcf9f1d95ab8debea7a73 + with: + creds: {% raw %}${{ secrets.AZURE_CREDENTIALS }}{% endraw %} + + - name: Build image on ACR + uses: azure/CLI@7378ce2ca3c38b4b063feb7a4cbe384fef978055 + with: + azcliversion: 2.29.1 + inlineScript: | + az configure --defaults acr={% raw %}${{ env.AZURE_CONTAINER_REGISTRY }}{% endraw %} + az acr build -t -t {% raw %}${{ env.REGISTRY_URL }}{% endraw %}/{% raw %}${{ env.PROJECT_NAME }}{% endraw %}:{% raw %}${{ github.sha }}{% endraw %} + + - name: Gets K8s context + uses: azure/aks-set-context@4e5aec273183a197b181314721843e047123d9fa + with: + creds: {% raw %}${{ secrets.AZURE_CREDENTIALS }}{% endraw %} + resource-group: {% raw %}${{ env.RESOURCE_GROUP }}{% endraw %} + cluster-name: {% raw %}${{ env.CLUSTER_NAME }}{% endraw %} + id: login + + - name: Configure deployment + uses: azure/k8s-bake@773b6144a3732e3bf4c78b146a0bb9617b2e016b + with: + renderEngine: 'helm' + helmChart: {% raw %}${{ env.CHART_PATH }}{% endraw %} + overrideFiles: {% raw %}${{ env.CHART_OVERRIDE_PATH }}{% endraw %} + overrides: | + replicas:2 + helm-version: 'latest' + id: bake + + - name: Deploys application + - uses: Azure/k8s-deploy@c8fbd76ededaad2799c054a9fd5d0fa5d4e9aee4 + with: + manifests: {% raw %}${{ steps.bake.outputs.manifestsBundle }}{% endraw %} + images: | + {% raw %}${{ env.AZURE_CONTAINER_REGISTRY }}{% endraw %}.azurecr.io/{% raw %}${{ env.PROJECT_NAME }}{% endraw %}:{% raw %}${{ github.sha }}{% endraw %} + imagepullsecrets: | + {% raw %}${{ env.PROJECT_NAME }}{% endraw %} +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-kubernetes-service.yml `](https://github.com/actions/starter-workflows/blob/main/deployments/azure-kubernetes-service.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The actions used to in this workflow are the official Azure [`Azure/login`](https://github.com/Azure/login),[`Azure/aks-set-context`](https://github.com/Azure/aks-set-context), [`Azure/CLI`](https://github.com/Azure/CLI), [`Azure/k8s-bake`](https://github.com/Azure/k8s-bake), and [`Azure/k8s-deploy`](https://github.com/Azure/k8s-deploy)actions. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md new file mode 100644 index 0000000000..cc6a363133 --- /dev/null +++ b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md @@ -0,0 +1,113 @@ +--- +title: Deploying to Azure Static Web App +intro: You can deploy your web app to Azure Static Web App as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Azure Static Web Apps +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a web app to [Azure Static Web Apps](https://azure.microsoft.com/services/app-service/static/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +1. Create an Azure Static Web App using the 'Other' option for deployment source. For more information, see "[Quickstart: Building your first static site in the Azure portal](https://docs.microsoft.com/azure/static-web-apps/get-started-portal)" in the Azure documentation. + +2. Create a secret called `AZURE_STATIC_WEB_APPS_API_TOKEN` with the value of your static web app deployment token. For more information about how to find your deployment token, see "[Reset deployment tokens in Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/deployment-token-management)" in the Azure documentation. + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy an Azure static web app when there is a push to the `main` branch or when a pull request targeting `main` is opened, synchronized, or reopened. The workflow also tears down the corresponding pre-production deployment when a pull request targeting `main` is closed. + +Under the workflow `env` key, change the following values: +- `APP_LOCATION` to the location of your client code +- `API_LOCATION` to the location of your API source code. If `API_LOCATION` is not relevant, you can delete the variable and the lines where it is used. +- `APP_ARTIFACT_LOCATION` to the location of your client code build output + +For more information about these values, see "[Build configuration for Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/build-configuration?tabs=github-actions)" in the Azure documentation. + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Deploy web app to Azure Static Web Apps + +env: + APP_LOCATION: "/" # location of your client code + API_LOCATION: "api" # location of your api source code - optional + APP_ARTIFACT_LOCATION: "build" # location of client code build output + + on: + push: + branches: + - main + pull_request: + types: [opened, synchronize, reopened, closed] + branches: + - main + +permissions: + issues: write + +jobs: + build_and_deploy: + if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action != 'closed') + runs-on: ubuntu-latest + name: Build and Deploy + steps: + - uses: actions/checkout@v2 + with: + submodules: true + - name: Build And Deploy + uses: Azure/static-web-apps-deploy@1a947af9992250f3bc2e68ad0754c0b0c11566c9 + with: + azure_static_web_apps_api_token: {% raw %}${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN }}{% endraw %} + repo_token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + action: "upload" + app_location: {% raw %}${{ env.APP_LOCATION }}{% endraw %} + api_location: {% raw %}${{ env.API_LOCATION }}{% endraw %} + app_artifact_location: {% raw %}${{ env.APP_ARTIFACT_LOCATION }}{% endraw %} + + close: + if: github.event_name == 'pull_request' && github.event.action == 'closed' + runs-on: ubuntu-latest + name: Close + steps: + - name: Close + uses: Azure/static-web-apps-deploy@1a947af9992250f3bc2e68ad0754c0b0c11566c9 + with: + azure_static_web_apps_api_token: {% raw %}${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN }}{% endraw %} + action: "close" +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-staticwebapp.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-staticwebapp.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/static-web-apps-deploy`](https://github.com/Azure/static-web-apps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/index.md b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/index.md new file mode 100644 index 0000000000..293638875e --- /dev/null +++ b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/index.md @@ -0,0 +1,19 @@ +--- +title: Deploying to Azure +shortTitle: Deploy to Azure +intro: Learn how to deploy to Azure App Service, Azure Kubernetes, and Azure Static Web App as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +children: + - /deploying-nodejs-to-azure-app-service + - /deploying-python-to-azure-app-service + - /deploying-java-to-azure-app-service + - /deploying-net-to-azure-app-service + - /deploying-php-to-azure-app-service + - /deploying-docker-to-azure-app-service + - /deploying-to-azure-static-web-app + - /deploying-to-azure-kubernetes-service +--- diff --git a/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/index.md b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/index.md index 463324f7b7..56c61d9b6d 100644 --- a/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/index.md +++ b/translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/index.md @@ -4,10 +4,11 @@ shortTitle: Deploying to your cloud provider intro: 'You can deploy to various cloud providers, such as AWS, Azure, and GKE.' versions: fpt: '*' - ghae: 'issue-4856' + ghae: '*' ghec: '*' + ghes: '*' children: - /deploying-to-amazon-elastic-container-service - - /deploying-to-azure-app-service + - /deploying-to-azure - /deploying-to-google-kubernetes-engine --- diff --git a/translations/zh-CN/content/actions/guides.md b/translations/zh-CN/content/actions/guides.md index 2c15577f19..3a445c387b 100644 --- a/translations/zh-CN/content/actions/guides.md +++ b/translations/zh-CN/content/actions/guides.md @@ -43,7 +43,6 @@ includeGuides: - /actions/using-containerized-services/creating-redis-service-containers - /actions/using-containerized-services/creating-postgresql-service-containers - /actions/deployment/deploying-to-amazon-elastic-container-service - - /actions/deployment/deploying-to-azure-app-service - /actions/deployment/deploying-to-google-kubernetes-engine - /actions/learn-github-actions/essential-features-of-github-actions - /actions/security-guides/security-hardening-for-github-actions @@ -64,5 +63,13 @@ includeGuides: - /actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-kubernetes-service --- diff --git a/translations/zh-CN/content/actions/index.md b/translations/zh-CN/content/actions/index.md index 5eff35a61d..874053eb2b 100644 --- a/translations/zh-CN/content/actions/index.md +++ b/translations/zh-CN/content/actions/index.md @@ -30,10 +30,10 @@ changelog: examples_source: data/product-examples/actions/code-examples.yml product_video: 'https://www.youtube-nocookie.com/embed/cP0I9w2coGU' redirect_from: - - /articles/automating-your-workflow-with-github-actions/ - - /articles/customizing-your-project-with-github-actions/ + - /articles/automating-your-workflow-with-github-actions + - /articles/customizing-your-project-with-github-actions - /github/automating-your-workflow-with-github-actions - - /actions/automating-your-workflow-with-github-actions/ + - /actions/automating-your-workflow-with-github-actions - /categories/automating-your-workflow-with-github-actions - /marketplace/actions - /actions/reference diff --git a/translations/zh-CN/content/actions/learn-github-actions/contexts.md b/translations/zh-CN/content/actions/learn-github-actions/contexts.md index 88c17692f1..6fd4f39039 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/contexts.md +++ b/translations/zh-CN/content/actions/learn-github-actions/contexts.md @@ -221,7 +221,7 @@ The following table indicates where each context and special function can be use | Path | Context | Special functions | | ---- | ------- | ----------------- | -| concurrency | github | | +| concurrency | github, inputs | | | env | github, secrets, inputs | | | jobs.<job_id>.concurrency | github, needs, strategy, matrix, inputs | | | jobs.<job_id>.container | github, needs, strategy, matrix, inputs | | diff --git a/translations/zh-CN/content/actions/learn-github-actions/index.md b/translations/zh-CN/content/actions/learn-github-actions/index.md index f69e68338e..e45322bcff 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/index.md +++ b/translations/zh-CN/content/actions/learn-github-actions/index.md @@ -11,7 +11,7 @@ redirect_from: - /actions/getting-started-with-github-actions/overview - /actions/getting-started-with-github-actions/getting-started-with-github-actions - /actions/configuring-and-managing-workflows/configuring-a-workflow - - /articles/creating-a-workflow-with-github-actions/ + - /articles/creating-a-workflow-with-github-actions - /articles/configuring-a-workflow - /github/automating-your-workflow-with-github-actions/configuring-a-workflow - /actions/automating-your-workflow-with-github-actions/configuring-a-workflow diff --git a/translations/zh-CN/content/actions/learn-github-actions/reusing-workflows.md b/translations/zh-CN/content/actions/learn-github-actions/reusing-workflows.md index 02d81d360f..9bf5bb7bdf 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/reusing-workflows.md +++ b/translations/zh-CN/content/actions/learn-github-actions/reusing-workflows.md @@ -18,9 +18,9 @@ topics: ## Overview -Rather than copying and pasting from one workflow to another, you can make workflows reusable. You and anyone with access to the reusable workflow can then call the reusable workflow from another workflow. +Rather than copying and pasting from one workflow to another, you can make workflows reusable. You and anyone with access to the reusable workflow can then call the reusable workflow from another workflow. -Reusing workflows avoids duplication. This makes workflows easier to maintain and allows you to create new workflows more quickly by building on the work of others, just as you do with actions. Workflow reuse also promotes best practice by helping you to use workflows that are well designed, have already been tested, and have been proved to be effective. Your organization can build up a library of reusable workflows that can be centrally maintained. +Reusing workflows avoids duplication. This makes workflows easier to maintain and allows you to create new workflows more quickly by building on the work of others, just as you do with actions. Workflow reuse also promotes best practice by helping you to use workflows that are well designed, have already been tested, and have been proved to be effective. Your organization can build up a library of reusable workflows that can be centrally maintained. The diagram below shows three build jobs on the left of the diagram. After each of these jobs completes successfully a dependent job called "Deploy" runs. This job calls a reusable workflow that contains three jobs: "Staging", "Review", and "Production." The "Production" deployment job only runs after the "Staging" job has completed successfully. Using a reusable workflow to run deployment jobs allows you to run those jobs for each build without duplicating code in workflows. @@ -67,7 +67,6 @@ Called workflows can access self-hosted runners from caller's context. This mean * Reusable workflows can't call other reusable workflows. * Reusable workflows stored within a private repository can only be used by workflows within the same repository. * Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)." -* You can't set the concurrency of a called workflow from the caller workflow. For more information about `jobs..concurrency`, see "[Workflow syntax for GitHub Actions](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency)." * The `strategy` property is not supported in any job that calls a reusable workflow. ## Creating a reusable workflow @@ -77,13 +76,13 @@ Reusable workflows are YAML-formatted files, very similar to any other workflow For a workflow to be reusable, the values for `on` must include `workflow_call`: ```yaml -on: +on: workflow_call: ``` ### Using inputs and secrets in a reusable workflow -You can define inputs and secrets, which can be passed from the caller workflow and then used within the called workflow. There are three stages to using an input or a secret in a reusable workflow. +You can define inputs and secrets, which can be passed from the caller workflow and then used within the called workflow. There are three stages to using an input or a secret in a reusable workflow. 1. In the reusable workflow, use the `inputs` and `secrets` keywords to define inputs or secrets that will be passed from a caller workflow. {% raw %} @@ -112,10 +111,10 @@ You can define inputs and secrets, which can be passed from the caller workflow - uses: ./.github/actions/my-action@v1 with: username: ${{ inputs.username }} - token: ${{ secrets.envPAT }} + token: ${{ secrets.envPAT }} ``` {% endraw %} - In the example above, `envPAT` is an environment secret that's been added to the `production` environment. This environment is therefore referenced within the job. + In the example above, `envPAT` is an environment secret that's been added to the `production` environment. This environment is therefore referenced within the job. {% note %} @@ -153,7 +152,7 @@ jobs: - uses: ./.github/actions/my-action@v1 with: username: ${{ inputs.username }} - token: ${{ secrets.token }} + token: ${{ secrets.token }} ``` {% endraw %} @@ -163,7 +162,7 @@ You call a reusable workflow by using the `uses` keyword. Unlike when you are us [`jobs..uses`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_iduses) -You reference reusable workflow files using the syntax: +You reference reusable workflow files using the syntax: `{owner}/{repo}/{path}/{filename}@{ref}` @@ -191,7 +190,7 @@ When you call a reusable workflow, you can only use the following keywords in th {% note %} - **Note:** + **Note:** * If `jobs..permissions` is not specified in the calling job, the called workflow will have the default permissions for the `GITHUB_TOKEN`. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." * The `GITHUB_TOKEN` permissions passed from the caller workflow can be only downgraded (not elevated) by the called workflow. @@ -226,7 +225,7 @@ jobs: ## Using outputs from a reusable workflow -A reusable workflow may generate data that you want to use in the caller workflow. To use these outputs, you must specify them as the outputs of the reusable workflow. +A reusable workflow may generate data that you want to use in the caller workflow. To use these outputs, you must specify them as the outputs of the reusable workflow. The following reusable workflow has a single job containing two steps. In each of these steps we set a single word as the output: "hello" and "world." In the `outputs` section of the job, we map these step outputs to job outputs called: `output1` and `output2`. In the `on.workflow_call.outputs` section we then define two outputs for the workflow itself, one called `firstword` which we map to `output1`, and one called `secondword` which we map to `output2`. @@ -243,12 +242,12 @@ on: value: ${{ jobs.example_job.outputs.output1 }} secondword: description: "The second output string" - value: ${{ jobs.example_job.outputs.output2 }} - + value: ${{ jobs.example_job.outputs.output2 }} + jobs: example_job: name: Generate output - runs-on: ubuntu-latest + runs-on: ubuntu-latest # Map the job outputs to step outputs outputs: output1: ${{ steps.step1.outputs.firstword }} diff --git a/translations/zh-CN/content/actions/learn-github-actions/using-workflow-templates.md b/translations/zh-CN/content/actions/learn-github-actions/using-workflow-templates.md index 8bdb52e763..f7685fa3f0 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/using-workflow-templates.md +++ b/translations/zh-CN/content/actions/learn-github-actions/using-workflow-templates.md @@ -25,9 +25,9 @@ topics: ## About workflow templates -{% data variables.product.product_name %} offers workflow templates for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests. +{% data variables.product.product_name %} offers workflow templates for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests.{% if actions-starter-template-ui %} You can search and filter to find relevant workflow templates.{% endif %} -You can also create your own workflow templates to share with your organization. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." +You can also create your own workflow templates to share with your organization. These templates will appear alongside the {% data variables.product.product_name %} workflow templates. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." ## Using workflow templates @@ -36,8 +36,8 @@ Anyone with write permission to a repository can set up {% data variables.produc {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} 1. If you already have a workflow in your repository, click **New workflow**. -1. Find the template that you want to use, then click **Set up this workflow**. -1. If the workflow template contains comments detailing additional setup steps, follow these steps. +1. Find the template that you want to use, then click **Set up this workflow**.{% if actions-starter-template-ui %} To help you find the template that you want, you can search for keywords or filter by category.{% endif %} +1. If the workflow template contains comments detailing additional setup steps, follow these steps. Many of the templates have corresponding guides. For more information, see [the {% data variables.product.prodname_actions %} guides](/actions/guides)." 1. Some workflow templates use secrets. For example, {% raw %}`${{ secrets.npm_token }}`{% endraw %}. If the workflow template uses a secret, store the value described in the secret name as a secret in your repository. For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." 1. Optionally, make additional changes. For example, you might want to change the value of `on` to change when the workflow runs. 1. Click **Start commit**. diff --git a/translations/zh-CN/content/actions/migrating-to-github-actions/index.md b/translations/zh-CN/content/actions/migrating-to-github-actions/index.md index b4dbec7116..54a6cff1d2 100644 --- a/translations/zh-CN/content/actions/migrating-to-github-actions/index.md +++ b/translations/zh-CN/content/actions/migrating-to-github-actions/index.md @@ -9,7 +9,7 @@ versions: ghec: '*' redirect_from: - /actions/migrating-to-github-actions - - /articles/migrating-github-actions-from-hcl-syntax-to-yaml-syntax/ + - /articles/migrating-github-actions-from-hcl-syntax-to-yaml-syntax children: - /migrating-from-azure-pipelines-to-github-actions - /migrating-from-circleci-to-github-actions diff --git a/translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md b/translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md index 33cd83f62b..e3c6192362 100644 --- a/translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md +++ b/translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md @@ -71,6 +71,15 @@ These attributes are available. You can change the attribute names in the [manag | `public_keys` | Optional | The public SSH keys for the user. More than one can be specified. | | `gpg_keys` | Optional | The GPG keys for the user. More than one can be specified. | +To specify more than one value for an attribute, use multiple `` elements. + +``` + + ssh-rsa LONG KEY + ssh-rsa LONG KEY 2 + +``` + ## Configuring SAML settings {% data reusables.enterprise_site_admin_settings.access-settings %} diff --git a/translations/zh-CN/content/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer.md b/translations/zh-CN/content/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer.md index b720b6c9a0..35573b2ad4 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer.md +++ b/translations/zh-CN/content/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer.md @@ -31,6 +31,8 @@ Because client connections to {% data variables.product.prodname_ghe_server %} c {% data reusables.enterprise_clustering.proxy_xff_firewall_warning %} +{% data reusables.enterprise_installation.terminating-tls %} + ### Enabling PROXY protocol support on {% data variables.product.product_location %} We strongly recommend enabling PROXY protocol support for both your appliance and the load balancer. Use the instructions provided by your vendor to enable the PROXY protocol on your load balancer. For more information, see [the PROXY protocol documentation](http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt). @@ -50,8 +52,6 @@ We strongly recommend enabling PROXY protocol support for both your appliance an {% data reusables.enterprise_clustering.x-forwarded-for %} -{% data reusables.enterprise_installation.terminating-tls %} - {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.privacy %} diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md index 36e474e3e2..9cb3ba1b65 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md @@ -56,8 +56,8 @@ If you need to get information on the users, organizations, and repositories in Specifically, you can download CSV reports that list - all users -- all users who have been active within the last month -- all users who have been inactive for one month or more +- all active users +- all [dormant users](/admin/user-management/managing-dormant-users) - all users who have been suspended - all organizations - all repositories diff --git a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md index ac01707283..19a5c2f5bb 100644 --- a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md +++ b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md @@ -10,7 +10,6 @@ redirect_from: - /enterprise/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud - /admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud - /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud -permissions: 'Enterprise owners who are also owners of a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% data variables.product.prodname_github_connect %}.' versions: ghes: '*' ghae: '*' @@ -60,6 +59,12 @@ Enabling {% data variables.product.prodname_github_connect %} will not allow {% For more information about managing enterprise accounts using the GraphQL API, see "[Enterprise accounts](/graphql/guides/managing-enterprise-accounts)." ## Enabling {% data variables.product.prodname_github_connect %} +Enterprise owners who are also owners of an organization or enterprise account that uses {% data variables.product.prodname_ghe_cloud %} can enable {% data variables.product.prodname_github_connect %}. + +If you're connecting {% data variables.product.product_location %} to an organization on {% data variables.product.prodname_dotcom_the_website %} that is not owned by an enterprise account, you must enable {% data variables.product.prodname_github_connect %} with a personal account on {% data variables.product.prodname_dotcom_the_website %} that is an owner of the organization. + +If you're connecting {% data variables.product.product_location %} to an organization on {% data variables.product.prodname_dotcom_the_website %} that is owned by an enterprise account or to an enterprise account itself, you must enable {% data variables.product.prodname_github_connect %} with a personal account on {% data variables.product.prodname_dotcom_the_website %} that is an owner of the enterprise account. + {% ifversion ghes %} 1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} @@ -73,7 +78,9 @@ For more information about managing enterprise accounts using the GraphQL API, s 1. Next to the enterprise account or organization you'd like to connect, click **Connect**. ![Connect button next to an enterprise account or business](/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png) -## Disconnecting a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account from your enterprise account +## Disabling {% data variables.product.prodname_github_connect %} + +Enterprise owners can disable {% data variables.product.prodname_github_connect %}. When you disconnect from {% data variables.product.prodname_ghe_cloud %}, the {% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} is deleted from your enterprise account or organization and credentials stored on {% data variables.product.product_location %} are deleted. diff --git a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md index cc41266506..27ad1a6dcc 100644 --- a/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md +++ b/translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md @@ -37,6 +37,8 @@ For more information about these features, see "[About the dependency graph](/gi You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %} with {% data variables.product.prodname_github_connect %}. Once connected, vulnerability data is synced from the {% data variables.product.prodname_advisory_database %} to your instance once every hour. You can also choose to manually sync vulnerability data at any time. No code or information about code from {% data variables.product.product_location %} is uploaded to {% data variables.product.prodname_dotcom_the_website %}. +Only {% data variables.product.company_short %}-reviewed advisories are synchronized. {% data reusables.security-advisory.link-browsing-advisory-db %} + ### About generation of {% data variables.product.prodname_dependabot_alerts %} If you enable vulnerability detection, when {% data variables.product.product_location %} receives information about a vulnerability, it identifies repositories in your instance that use the affected version of the dependency and generates {% data variables.product.prodname_dependabot_alerts %}. You can choose whether or not to notify users automatically about new {% data variables.product.prodname_dependabot_alerts %}. diff --git a/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md b/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md index 63727ee9d8..203f3fa1fb 100644 --- a/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md +++ b/translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md @@ -21,9 +21,35 @@ This is an overview of the steps required to restore {% data variables.product.p 1. Confirm that the original appliance is offline. 1. Manually configure network settings on the replacement {% data variables.product.prodname_ghe_server %} appliance. Network settings are excluded from the backup snapshot, and are not overwritten by `ghe-restore`. -1. Configure the replacement appliance to use the same {% data variables.product.prodname_actions %} external storage configuration as the original appliance. +1. To configure the replacement appliance to use the same {% data variables.product.prodname_actions %} external storage configuration as the original appliance, from the new appliance, set the required parameters with `ghe-config` command. + + - Azure Blob Storage + ```shell + ghe-config secrets.actions.storage.blob-provider "azure" + ghe-config secrets.actions.storage.azure.connection-string "_Connection_String_" + ``` + - Amazon S3 + ```shell + ghe-config secrets.actions.storage.blob-provider "s3" + ghe-config secrets.actions.storage.s3.bucket-name "_S3_Bucket_Name" + ghe-config secrets.actions.storage.s3.service-url "_S3_Service_URL_" + ghe-config secrets.actions.storage.s3.access-key-id "_S3_Access_Key_ID_" + ghe-config secrets.actions.storage.s3.access-secret "_S3_Access_Secret_" + ``` + - Optionally, to enable S3 force path style, enter the following command: + ```shell + ghe-config secrets.actions.storage.s3.force-path-style true + ``` + + 1. Enable {% data variables.product.prodname_actions %} on the replacement appliance. This will connect the replacement appliance to the same external storage for {% data variables.product.prodname_actions %}. -1. After {% data variables.product.prodname_actions %} is configured with the external storage provider, use the `ghe-restore` command to restore the rest of the data from the backup. For more information, see "[Restoring a backup](/admin/configuration/configuring-backups-on-your-appliance#restoring-a-backup)." + + ```shell + ghe-config app.actions.enabled true + ghe-config-apply + ``` + +1. After {% data variables.product.prodname_actions %} is configured and enabled, use the `ghe-restore` command to restore the rest of the data from the backup. For more information, see "[Restoring a backup](/admin/configuration/configuring-backups-on-your-appliance#restoring-a-backup)." 1. Re-register your self-hosted runners on the replacement appliance. For more information, see [Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners). For more information on backing up and restoring {% data variables.product.prodname_ghe_server %}, see "[Configuring backups on your appliance](/admin/configuration/configuring-backups-on-your-appliance)." diff --git a/translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md b/translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md index 514b440f73..748685a4e0 100644 --- a/translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md +++ b/translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md @@ -62,7 +62,7 @@ Before launching {% data variables.product.product_location %} on Azure, you'll {% data reusables.enterprise_installation.necessary_ports %} -4. Create and attach a new unencrypted data disk to the VM, and configure the size based on your user license count. For more information, see "[az vm disk attach](https://docs.microsoft.com/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)" in the Microsoft documentation. +4. Create and attach a new managed data disk to the VM, and configure the size based on your license count. All Azure managed disks created since June 10, 2017 are encrypted at rest by default with Storage Service Encryption (SSE). For more information about the `az vm disk attach` command, see "[az vm disk attach](https://docs.microsoft.com/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)" in the Microsoft documentation. Pass in options for the name of your VM (for example, `ghe-acme-corp`), the resource group, the premium storage SKU, the size of the disk (for example, `100`), and a name for the resulting VHD. diff --git a/translations/zh-CN/content/admin/overview/about-github-ae.md b/translations/zh-CN/content/admin/overview/about-github-ae.md index 6a252563e4..62d5fcf17b 100644 --- a/translations/zh-CN/content/admin/overview/about-github-ae.md +++ b/translations/zh-CN/content/admin/overview/about-github-ae.md @@ -1,6 +1,6 @@ --- -title: 关于 GitHub AE -intro: '{% data variables.product.prodname_ghe_managed %} 是一种在云端使用 {% data variables.product.prodname_dotcom %} 的安全性更强的标准方法。' +title: About GitHub AE +intro: '{% data variables.product.prodname_ghe_managed %} is a security-enhanced and compliant way to use {% data variables.product.prodname_dotcom %} in the cloud.' versions: ghae: '*' type: overview @@ -9,32 +9,33 @@ topics: - Fundamentals --- -## 关于 {% data variables.product.prodname_ghe_managed %} +## About {% data variables.product.prodname_ghe_managed %} -{% data reusables.github-ae.github-ae-enables-you %} {% data variables.product.prodname_ghe_managed %} 受到完全管理、可靠和且可扩展的，允许您在不牺牲风险管理的情况下加速交付。 +{% data reusables.github-ae.github-ae-enables-you %} {% data variables.product.prodname_ghe_managed %} is fully managed, reliable, and scalable, allowing you to accelerate delivery without sacrificing risk management. -{% data variables.product.prodname_ghe_managed %} 提供一个从想法到生产的开发者平台。 您可以使用团队了解和喜爱的工具提高开发速度，同时通过独特的安全和访问控制、工作流自动化及政策执行来维护行业和监管合规性。 +{% data variables.product.prodname_ghe_managed %} offers one developer platform from idea to production. You can increase development velocity with the tools that teams know and love, while you maintain industry and regulatory compliance with unique security and access controls, workflow automation, and policy enforcement. -## 高度可用的行星级云 +## A highly available and planet-scale cloud -{% data variables.product.prodname_ghe_managed %} 是一项完全管理的服务，托管在高可用性架构中。 {% data variables.product.prodname_ghe_managed %} 全球托管于云中，可以不受限制地扩展以支持您的完整开发生命周期。 {% data variables.product.prodname_dotcom %} 完全管理备份、故障转移和灾难恢复，因此您无需担心您的服务或数据。 +{% data variables.product.prodname_ghe_managed %} is a fully managed service, hosted in a high availability architecture. {% data variables.product.prodname_ghe_managed %} is hosted globally in a cloud that can scale to support your full development lifecycle without limits. {% data variables.product.prodname_dotcom %} fully manages backups, failover, and disaster recovery, so you never need to worry about your service or data. -## 数据存储 +## Data residency -您的所有数据都存储在您选择的地理区域内。 您可以遵守 GDRPR 和全球数据保护标准，将您的所有数据保存在您选定的区域。 +All of your data is stored within the geographic region of your choosing. You can comply with GDPR and global data protection standards by keeping all of your data within your chosen region. -## 隔离的帐户 +## Isolated accounts -所有开发者帐户在 {% data variables.product.prodname_ghe_managed %} 中完全隔离。 您可以通过身份提供商完全控制帐户，以 SAML 单点登录作为强制性要求。 SCIM 可让您确保员工只能访问他们应该访问的资源，如您的中央身份管理系统中所定义。 更多信息请参阅“[管理企业的身份和访问](/admin/authentication/managing-identity-and-access-for-your-enterprise)”。 +All developer accounts are fully isolated in {% data variables.product.prodname_ghe_managed %}. You can fully control the accounts through your identity provider, with SAML single sign on as mandatory. SCIM enables you to ensure that employees only have access to the resources they should, as defined in your central identity management system. For more information, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)." -## 受限制的网络访问 +## Restricted network access -以受限的网络访问权限保护对您在 {% data variables.product.prodname_ghe_managed %} 上的企业的访问，以便只能从您的网络内访问您的数据。 更多信息请参阅“[限制到企业的网络流量](/admin/configuration/restricting-network-traffic-to-your-enterprise)”。 +Secure access to your enterprise on {% data variables.product.prodname_ghe_managed %} with restricted network access, so that your data can only be accessed from within your network. For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/restricting-network-traffic-to-your-enterprise)." -## 商业和政府环境 +## Commercial and government environments -{% data variables.product.prodname_ghe_managed %} 可用于 Azure Government 云（是美国政府机构及其伙伴信任的云）。 {% data variables.product.prodname_ghe_managed %} 也可在商业云中使用，因此您可以选择适合您组织的托管环境。 +{% data variables.product.prodname_ghe_managed %} is available in the Azure Government cloud, the trusted cloud for US government agencies and their partners. {% data variables.product.prodname_ghe_managed %} is also available in the commercial cloud, so you can choose the hosting environment that is right for your organization. -## 延伸阅读 +## Further reading -- "[从 {% data variables.product.company_short %} 支持获得帮助](/admin/enterprise-support/receiving-help-from-github-support)" +- "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)" +- "[Receiving help from {% data variables.product.company_short %} Support](/admin/enterprise-support/receiving-help-from-github-support)" diff --git a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md index 4a20954bbf..1312ef64f1 100644 --- a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md +++ b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md @@ -35,8 +35,13 @@ When your code depends on a package that has a security vulnerability, this vuln {% data variables.product.prodname_dependabot %} detects vulnerable dependencies and sends {% data variables.product.prodname_dependabot_alerts %} when: {% ifversion fpt or ghec %} -- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)" and "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)."{% else %} +- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database)" and "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)."{% else %} - New advisory data is synchronized to {% data variables.product.product_location %} each hour from {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.security-advisory.link-browsing-advisory-db %}{% endif %} + {% note %} + + **Note:** Only advisories that have been reviewed by {% data variables.product.company_short %} will trigger {% data variables.product.prodname_dependabot_alerts %}. + + {% endnote %} - The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on{% ifversion fpt or ghec %}, or when the code of one of the dependencies changes{% endif %}. For more information, see "[About the dependency graph](/code-security/supply-chain-security/about-the-dependency-graph)." {% data reusables.repositories.dependency-review %} diff --git a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md index 7fd77729d1..34a478356c 100644 --- a/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md +++ b/translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md @@ -2,6 +2,7 @@ title: Browsing security vulnerabilities in the GitHub Advisory Database intro: 'The {% data variables.product.prodname_advisory_database %} allows you to browse or search for vulnerabilities that affect open source projects on {% data variables.product.company_short %}.' shortTitle: Browse Advisory Database +miniTocMaxHeadingLevel: 3 redirect_from: - /github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database - /code-security/supply-chain-security/browsing-security-vulnerabilities-in-the-github-advisory-database @@ -22,13 +23,29 @@ topics: {% data reusables.repositories.a-vulnerability-is %} -{% data variables.product.product_name %} will send you {% data variables.product.prodname_dependabot_alerts %} if we detect that any of the vulnerabilities from the {% data variables.product.prodname_advisory_database %} affect the packages that your repository depends on. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." - ## About the {% data variables.product.prodname_advisory_database %} -The {% data variables.product.prodname_advisory_database %} contains a curated list of security vulnerabilities that have been mapped to packages tracked by the {% data variables.product.company_short %} dependency graph. {% data reusables.repositories.tracks-vulnerabilities %} +The {% data variables.product.prodname_advisory_database %} contains a list of known security vulnerabilities, grouped in two categories: {% data variables.product.company_short %}-reviewed advisories and unreviewed advisories. -Each security advisory contains information about the vulnerability, including the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. In addition, advisories from the National Vulnerability Database list contain a link to the CVE record, where you can read more details about the vulnerability, its CVSS scores, and its qualitative severity level. For more information, see the "[National Vulnerability Database](https://nvd.nist.gov/)" from the National Institute of Standards and Technology. +{% data reusables.repositories.tracks-vulnerabilities %} + +### About {% data variables.product.company_short %}-reviewed advisories + +{% data variables.product.company_short %}-reviewed advisories are security vulnerabilities that have been mapped to packages tracked by the {% data variables.product.company_short %} dependency graph. + +We carefully review each advisory for validity. Each {% data variables.product.company_short %}-reviewed advisory has a full description, and contains both ecosystem and package information. + +If you enable {% data variables.product.prodname_dependabot_alerts %} for your repositories, you are automatically notified when a new {% data variables.product.company_short %}-reviewed advisory affects packages you depend on. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." + +### About unreviewed advisories + +Unreviewed advisories are security vulnerabilites that we publish automatically into the {% data variables.product.prodname_advisory_database %}, directly from the National Vulnerability Database feed. + +{% data variables.product.prodname_dependabot %} doesn't create {% data variables.product.prodname_dependabot_alerts %} for unreviewed advisories as this type of advisory isn't checked for validity or completion. + +## About security advisories + +Each security advisory contains information about the vulnerability, which may include the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. In addition, advisories from the National Vulnerability Database list contain a link to the CVE record, where you can read more details about the vulnerability, its CVSS scores, and its qualitative severity level. For more information, see the "[National Vulnerability Database](https://nvd.nist.gov/)" from the National Institute of Standards and Technology. The severity level is one of four possible levels defined in the "[Common Vulnerability Scoring System (CVSS), Section 5](https://www.first.org/cvss/specification-document)." - Low @@ -45,6 +62,11 @@ The {% data variables.product.prodname_advisory_database %} uses the CVSS levels 1. Navigate to https://github.com/advisories. 2. Optionally, to filter the list, use any of the drop-down menus. ![Dropdown filters](/assets/images/help/security/advisory-database-dropdown-filters.png) + {% tip %} + + **Tip:** You can use the sidebar on the left to explore {% data variables.product.company_short %}-reviewed and unreviewed advisories separately. + + {% endtip %} 3. Click on any advisory to view details. {% note %} @@ -63,6 +85,8 @@ You can search the database, and use qualifiers to narrow your search. For examp | Qualifier | Example | | ------------- | ------------- | +| `type:reviewed`| [**type:reviewed**](https://github.com/advisories?query=type%3Areviewed) will show {% data variables.product.company_short %}-reviewed advisories. | +| `type:unreviewed`| [**type:unreviewed**](https://github.com/advisories?query=type%3Aunreviewed) will show unreviewed advisories. | | `GHSA-ID`| [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) will show the advisory with this {% data variables.product.prodname_advisory_database %} ID. | | `CVE-ID`| [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) will show the advisory with this CVE ID number. | | `ecosystem:ECOSYSTEM`| [**ecosystem:npm**](https://github.com/advisories?utf8=%E2%9C%93&query=ecosystem%3Anpm) will show only advisories affecting NPM packages. | @@ -80,7 +104,7 @@ You can search the database, and use qualifiers to narrow your search. For examp ## Viewing your vulnerable repositories -For any vulnerability in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories have a {% data variables.product.prodname_dependabot %} alert for that vulnerability. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)." +For any {% data variables.product.company_short %}-reviewed advisory in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories are affected by that security vulnerability. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)." 1. Navigate to https://github.com/advisories. 2. Click an advisory. diff --git a/translations/zh-CN/content/communities/documenting-your-project-with-wikis/about-wikis.md b/translations/zh-CN/content/communities/documenting-your-project-with-wikis/about-wikis.md index 9d6ac99ff3..a92278ed72 100644 --- a/translations/zh-CN/content/communities/documenting-your-project-with-wikis/about-wikis.md +++ b/translations/zh-CN/content/communities/documenting-your-project-with-wikis/about-wikis.md @@ -2,7 +2,7 @@ title: About wikis intro: 'You can host documentation for your repository in a wiki, so that others can use and contribute to your project.' redirect_from: - - /articles/about-github-wikis/ + - /articles/about-github-wikis - /articles/about-wikis - /github/building-a-strong-community/about-wikis product: '{% data reusables.gated-features.wikis %}' diff --git a/translations/zh-CN/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md b/translations/zh-CN/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md index 89fcb4be60..9051feb405 100644 --- a/translations/zh-CN/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md +++ b/translations/zh-CN/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md @@ -1,11 +1,11 @@ --- -title: 添加或编辑 wiki 页面 -intro: '您可以直接在 {% data variables.product.product_name %} 或者本地使用命令行添加和编辑 wiki 页面。' +title: Adding or editing wiki pages +intro: 'You can add and edit wiki pages directly on {% data variables.product.product_name %} or locally using the command line.' redirect_from: - - /articles/adding-wiki-pages-via-the-online-interface/ - - /articles/editing-wiki-pages-via-the-online-interface/ - - /articles/adding-and-editing-wik-pages-locally/ - - /articles/adding-and-editing-wiki-pages-locally/ + - /articles/adding-wiki-pages-via-the-online-interface + - /articles/editing-wiki-pages-via-the-online-interface + - /articles/adding-and-editing-wik-pages-locally + - /articles/adding-and-editing-wiki-pages-locally - /articles/adding-or-editing-wiki-pages - /github/building-a-strong-community/adding-or-editing-wiki-pages product: '{% data reusables.gated-features.wikis %}' @@ -16,47 +16,55 @@ versions: ghec: '*' topics: - Community -shortTitle: 管理 wiki 网页 +shortTitle: Manage wiki pages --- -## 添加 wiki 页面 +## Adding wiki pages {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-wiki %} -3. 在页面的右上角，单击 **New Page（新页面）**。 ![Wiki 新页面按钮](/assets/images/help/wiki/wiki_new_page_button.png) -4. 或者，要以 Markdown 以外的格式，请使用 Edit（编辑）模式下拉菜单，并单击不同的格式。 ![Wiki 标记选择](/assets/images/help/wiki/wiki_dropdown_markup.gif) -5. 使用文本编辑器添加页面内容。 ![Wiki WYSIWYG](/assets/images/help/wiki/wiki_wysiwyg.png) -6. 输入提交消息，描述所添加的新文件。 ![Wiki 提交消息](/assets/images/help/wiki/wiki_commit_message.png) -7. 要提交更改到 wiki，请单击 **Save Page（保存页面）**。 +3. In the upper-right corner of the page, click **New Page**. + ![Wiki new page button](/assets/images/help/wiki/wiki_new_page_button.png) +4. Optionally, to write in a format other than Markdown, use the Edit mode drop-down menu, and click a different format. + ![Wiki markup selection](/assets/images/help/wiki/wiki_dropdown_markup.gif) +5. Use the text editor to add your page's content. + ![Wiki WYSIWYG](/assets/images/help/wiki/wiki_wysiwyg.png) +6. Type a commit message describing the new file you’re adding. + ![Wiki commit message](/assets/images/help/wiki/wiki_commit_message.png) +7. To commit your changes to the wiki, click **Save Page**. -## 编辑 wiki 页面 +## Editing wiki pages {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-wiki %} -4. 使用 wiki 侧栏，导航到您要更改的页面。 在页面的右上角，单击 **Edit（编辑）**。 ![Wiki 编辑页面按钮](/assets/images/help/wiki/wiki_edit_page_button.png) -5. 使用文本编辑器添加页面内容。 ![Wiki WYSIWYG](/assets/images/help/wiki/wiki_wysiwyg.png) -6. 输入提交消息，描述您的更改。 ![Wiki 提交消息](/assets/images/help/wiki/wiki_commit_message.png) -7. 要提交更改到 wiki，请单击 **Save Page（保存页面）**。 +4. Using the wiki sidebar, navigate to the page you want to change. In the upper-right corner of the page, click **Edit**. + ![Wiki edit page button](/assets/images/help/wiki/wiki_edit_page_button.png) +5. Use the text editor edit the page's content. + ![Wiki WYSIWYG](/assets/images/help/wiki/wiki_wysiwyg.png) +6. Type a commit message describing your changes. + ![Wiki commit message](/assets/images/help/wiki/wiki_commit_message.png) +7. To commit your changes to the wiki, click **Save Page**. -## 本地添加或编辑 wiki 页面 +## Adding or editing wiki pages locally -Wiki 是 Git 仓库的一部分，因此您可以在本地进行更改，然后使用 Git 工作流程将它们推送到仓库。 +Wikis are part of Git repositories, so you can make changes locally and push them to your repository using a Git workflow. -### 克隆 wiki 到计算机 +### Cloning wikis to your computer -每个 wiki 都提供一种将其内容克隆到计算机的简易方式。 您可以选择使用提供的 URL 将仓库克隆到计算机： +Every wiki provides an easy way to clone its contents down to your computer. +You can clone the repository to your computer with the provided URL: ```shell $ git clone https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git # Clones the wiki locally ``` -在克隆 wiki 后，可以添加新文件、编辑现有文件以及提交更改。 您与协作者在操作 wiki 时可以创建分支，但只有推送到默认分支的更改才会生效并供读者使用。 +Once you have cloned the wiki, you can add new files, edit existing ones, and commit your changes. You and your collaborators can create branches when working on wikis, but only changes pushed to the default branch will be made live and available to your readers. -## 关于 wiki 文件名 +## About wiki filenames -文件名确定 wiki 页面的标题，文件扩展名确定 wiki 内容如何呈现。 +The filename determines the title of your wiki page, and the file extension determines how your wiki content is rendered. -Wiki 使用[我们的开源 Markup 库](https://github.com/github/markup)转换标记，它根据文件扩展名确定要使用的转换器。 例如，如果您将文件命名为 *foo.md* 或 *foo.markdown*，wiki 将会使用 Markdown 转换器，而名为 *foo.textile* 的文件将使用 Textile 转换器。 +Wikis use [our open-source Markup library](https://github.com/github/markup) to convert the markup, and it determines which converter to use by a file's extension. For example, if you name a file *foo.md* or *foo.markdown*, wiki will use the Markdown converter, while a file named *foo.textile* will use the Textile converter. -不要在 wiki 页面标题中使用以下字符：`\ / : * ? " < > |`。 有些操作系统的用户不能使用包含这些字符的文件名。 请确保使用符合扩展名的标记语言编写内容，否则您的内容无法正确呈现。 +Don't use the following characters in your wiki page's titles: `\ / : * ? " < > |`. Users on certain operating systems won't be able to work with filenames containing these characters. Be sure to write your content using a markup language that matches the extension, or your content won't render properly. diff --git a/translations/zh-CN/content/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki.md b/translations/zh-CN/content/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki.md index 4eb241c2f2..06192a9266 100644 --- a/translations/zh-CN/content/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki.md +++ b/translations/zh-CN/content/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki.md @@ -1,9 +1,9 @@ --- -title: 为 wiki 创建页脚或边栏 -intro: 您可以为 wiki 添加自定义边栏或页脚，以便为读者提供更多上下文信息。 +title: Creating a footer or sidebar for your wiki +intro: You can add a custom sidebar or footer to your wiki to provide readers with more contextual information. redirect_from: - - /articles/creating-a-footer/ - - /articles/creating-a-sidebar/ + - /articles/creating-a-footer + - /articles/creating-a-sidebar - /articles/creating-a-footer-or-sidebar-for-your-wiki - /github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki product: '{% data reusables.gated-features.wikis %}' @@ -14,27 +14,33 @@ versions: ghec: '*' topics: - Community -shortTitle: 创建页脚或侧边栏 +shortTitle: Create footer or sidebar --- -## 创建页脚 +## Creating a footer {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-wiki %} -3. 在页面底部，单击 **Add a custom footer（添加自定义页脚）**。 ![Wiki 添加页脚部分](/assets/images/help/wiki/wiki_add_footer.png) -4. 使用文本编辑器键入您希望页脚包含的内容。 ![Wiki WYSIWYG](/assets/images/help/wiki/wiki-footer.png) -5. 输入提交消息描述所添加的页脚。 ![Wiki 提交消息](/assets/images/help/wiki/wiki_commit_message.png) -6. 要提交更改到 wiki，请单击 **Save Page（保存页面）**。 +3. At the bottom of the page, click **Add a custom footer**. + ![Wiki add footer section](/assets/images/help/wiki/wiki_add_footer.png) +4. Use the text editor to type the content you want your footer to have. + ![Wiki WYSIWYG](/assets/images/help/wiki/wiki-footer.png) +5. Enter a commit message describing the footer you’re adding. + ![Wiki commit message](/assets/images/help/wiki/wiki_commit_message.png) +6. To commit your changes to the wiki, click **Save Page**. -## 创建边栏 +## Creating a sidebar {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-wiki %} -3. 单击 **Add a custom sidebar（添加自定义边栏）**。 ![Wiki 添加边栏部分](/assets/images/help/wiki/wiki_add_sidebar.png) -4. 使用文本编辑器添加页面内容。 ![Wiki WYSIWYG](/assets/images/help/wiki/wiki-sidebar.png) -5. 输入提交消息描述所添加的边栏。 ![Wiki 提交消息](/assets/images/help/wiki/wiki_commit_message.png) -6. 要提交更改到 wiki，请单击 **Save Page（保存页面）**。 +3. Click **Add a custom sidebar**. + ![Wiki add sidebar section](/assets/images/help/wiki/wiki_add_sidebar.png) +4. Use the text editor to add your page's content. + ![Wiki WYSIWYG](/assets/images/help/wiki/wiki-sidebar.png) +5. Enter a commit message describing the sidebar you’re adding. + ![Wiki commit message](/assets/images/help/wiki/wiki_commit_message.png) +6. To commit your changes to the wiki, click **Save Page**. -## 在本地创建页脚或边栏 +## Creating a footer or sidebar locally -如果您创建了名为 `_Footer.` 或 `_Sidebar.` 的文件，我们将使用它们分别填充 wiki 的页脚和边栏。 与所有其他 wiki 页面一样，您为这些文件选择的扩展名将决定我们如何渲染它们。 +If you create a file named `_Footer.` or `_Sidebar.`, we'll use them to populate the footer and sidebar of your wiki, respectively. Like every other wiki page, the extension you choose for these files determines how we render them. diff --git a/translations/zh-CN/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md b/translations/zh-CN/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md index c3dad56f74..c132ba8340 100644 --- a/translations/zh-CN/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md +++ b/translations/zh-CN/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md @@ -1,14 +1,14 @@ --- -title: 编辑 wiki 内容 -intro: 您可以将图片和内容链接添加到您的 wiki，并使用某些受支持的 MediaWiki 格式。 +title: Editing wiki content +intro: 'You can add images and links to content in your wiki, and use some supported MediaWiki formats.' redirect_from: - - /articles/adding-links-to-wikis/ - - /articles/how-do-i-add-links-to-my-wiki/ - - /articles/how-do-i-add-or-upload-images-to-the-wiki/ - - /articles/needs-writing-review-how-do-i-add-or-upload-images-to-the-wiki/ - - /articles/how-do-i-add-images-to-my-wiki/ - - /articles/adding-images-to-wikis/ - - /articles/supported-mediawiki-formats/ + - /articles/adding-links-to-wikis + - /articles/how-do-i-add-links-to-my-wiki + - /articles/how-do-i-add-or-upload-images-to-the-wiki + - /articles/needs-writing-review-how-do-i-add-or-upload-images-to-the-wiki + - /articles/how-do-i-add-images-to-my-wiki + - /articles/adding-images-to-wikis + - /articles/supported-mediawiki-formats - /articles/editing-wiki-content - /github/building-a-strong-community/editing-wiki-content product: '{% data reusables.gated-features.wikis %}' @@ -21,39 +21,40 @@ topics: - Community --- -## 添加链接 +## Adding links -您可以使用页面支持的标准标记或使用 MediaWiki 语法在 wiki 中创建链接。 例如： +You can create links in wikis using the standard markup supported by your page, or using MediaWiki syntax. For example: -- 如果您的页面使用 Markdown 渲染，则链接语法为 `[链接文本](wiki 页面的完整 URL)`。 -- 使用 MediaWiki 语法，链接语法为 `[[链接文本|wiki 页面的名称]]`。 +- If your pages are rendered with Markdown, the link syntax is `[Link Text](full-URL-of-wiki-page)`. +- With MediaWiki syntax, the link syntax is `[[Link Text|nameofwikipage]]`. -## 添加图像 +## Adding images -Wikis 可显示 PNG、JPEG 和 GIF 图片。 +Wikis can display PNG, JPEG, and GIF images. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-wiki %} -3. 使用 wiki 边栏，导航至要更改的页面，然后单击 **Edit（编辑）**。 -4. 在 wiki 工具栏上，单击 **Image（图像）**。 ![Wiki 添加图像按钮](/assets/images/help/wiki/wiki_add_image.png) -5. 在“Insert Image”（插入图像）对话框，输入 URL 和 alt 文本（由搜索引擎和屏幕阅读器使用）。 -6. 单击 **OK（确定）**。 +3. Using the wiki sidebar, navigate to the page you want to change, and then click **Edit**. +4. On the wiki toolbar, click **Image**. + ![Wiki Add image button](/assets/images/help/wiki/wiki_add_image.png) +5. In the "Insert Image" dialog box, type the image URL and the alt text (which is used by search engines and screen readers). +6. Click **OK**. -### 链接到仓库中的图片 +### Linking to images in a repository -您可以通过在浏览器中复制链接并将其用作图像路径，链接到 {% data variables.product.product_name %} 上仓库中的图像。 例如，使用 Markdown 在 wiki 中嵌入图像可能如下所示： +You can link to an image in a repository on {% data variables.product.product_name %} by copying the URL in your browser and using that as the path to the image. For example, embedding an image in your wiki using Markdown might look like this: [[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]] -## 受支持的 MediaWiki 格式 +## Supported MediaWiki formats -无论您的 wiki 页面以哪种标记语言编写，始终可使用某些 MediaWiki 语法。 -- 链接 ([Asciidoc 除外](https://github.com/gollum/gollum/commit/d1cf698b456cd6a35a54c6a8e7b41d3068acec3b)) -- 水平规则通过 `---` -- 简明符号实体（例如 `δ` 或 `€`） +No matter which markup language your wiki page is written in, certain MediaWiki syntax will always be available to you. +- Links ([except Asciidoc](https://github.com/gollum/gollum/commit/d1cf698b456cd6a35a54c6a8e7b41d3068acec3b)) +- Horizontal rules via `---` +- Shorthand symbol entities (such as `δ` or `€`) -出于安全和性能原因，某些语法不受支持。 -- [嵌入包含](https://www.mediawiki.org/wiki/Transclusion) -- 定义列表 -- 首行缩进 -- 目录 +For security and performance reasons, some syntaxes are unsupported. +- [Transclusion](https://www.mediawiki.org/wiki/Transclusion) +- Definition lists +- Indentation +- Table of contents diff --git a/translations/zh-CN/content/communities/documenting-your-project-with-wikis/index.md b/translations/zh-CN/content/communities/documenting-your-project-with-wikis/index.md index e7371a8bcc..fbec09d8fc 100644 --- a/translations/zh-CN/content/communities/documenting-your-project-with-wikis/index.md +++ b/translations/zh-CN/content/communities/documenting-your-project-with-wikis/index.md @@ -1,10 +1,10 @@ --- -title: 使用 wiki 为项目写文档 -shortTitle: 使用 wiki -intro: 可使用 wiki 分享有关项目的详细、长式信息。 +title: Documenting your project with wikis +shortTitle: Using wikis +intro: 'You can use a wiki to share detailed, long-form information about your project.' redirect_from: - - /categories/49/articles/ - - /categories/wiki/ + - /categories/49/articles + - /categories/wiki - /articles/documenting-your-project-with-wikis - /github/building-a-strong-community/documenting-your-project-with-wikis product: '{% data reusables.gated-features.wikis %}' diff --git a/translations/zh-CN/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md b/translations/zh-CN/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md index 84d1d105c3..d2c37ba9c1 100644 --- a/translations/zh-CN/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md +++ b/translations/zh-CN/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md @@ -1,8 +1,8 @@ --- -title: 限制仓库中的交互 -intro: 您可以临时对公共仓库中的某些用户限制活动一段时间。 +title: Limiting interactions in your repository +intro: You can temporarily enforce a period of limited activity for certain users on a public repository. redirect_from: - - /articles/limiting-interactions-with-your-repository/ + - /articles/limiting-interactions-with-your-repository - /articles/limiting-interactions-in-your-repository - /github/building-a-strong-community/limiting-interactions-in-your-repository versions: @@ -11,30 +11,32 @@ versions: permissions: People with admin permissions to a repository can temporarily limit interactions in that repository. topics: - Community -shortTitle: 限制仓库中的交互 +shortTitle: Limit interactions in repo --- -## 关于临时交互限制 +## About temporary interaction limits {% data reusables.community.interaction-limits-restrictions %} -{% data reusables.community.interaction-limits-duration %} 在限制期过后，用户可以在您的仓库中恢复正常活动。 +{% data reusables.community.interaction-limits-duration %} After the duration of your limit passes, users can resume normal activity in your repository. {% data reusables.community.types-of-interaction-limits %} -您也可以为用户帐户或组织拥有的所有仓库启用或活动限制。 如果启用了用户范围或组织范围的限制，则不能限制帐户拥有的单个仓库的活动。 更多信息请参阅“[限制用户帐户的交互](/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account)”和“[限制组织中的交互](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization)”。 +You can also enable activity limitations on all repositories owned by your user account or an organization. If a user-wide or organization-wide limit is enabled, you can't limit activity for individual repositories owned by the account. For more information, see "[Limiting interactions for your user account](/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account)" and "[Limiting interactions in your organization](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization)." -## 限制仓库中的交互 +## Limiting interactions in your repository {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. 在左侧边栏中，单击 **Moderation settings（仲裁设置）**。 ![仓库设置侧边栏中的"Moderation settings（仲裁设置）"](/assets/images/help/repository/repo-settings-moderation-settings.png) -1. 在“Moderation settings（仲裁设置）”下，单击 **Interaction limits（交互限制）**。 ![仓库设置中的交互限制 ](/assets/images/help/repository/repo-settings-interaction-limits.png) +1. In the left sidebar, click **Moderation settings**. + !["Moderation settings" in repository settings sidebar](/assets/images/help/repository/repo-settings-moderation-settings.png) +1. Under "Moderation settings", click **Interaction limits**. + ![Interaction limits in repository settings ](/assets/images/help/repository/repo-settings-interaction-limits.png) {% data reusables.community.set-interaction-limit %} - ![临时交互限制选项](/assets/images/help/repository/temporary-interaction-limits-options.png) + ![Temporary interaction limit options](/assets/images/help/repository/temporary-interaction-limits-options.png) -## 延伸阅读 -- “[举报滥用或垃圾邮件](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)” -- "[管理个人对组织仓库的访问](/articles/managing-an-individual-s-access-to-an-organization-repository)" -- "[用户帐户仓库的权限级别](/articles/permission-levels-for-a-user-account-repository)" +## Further reading +- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" +- "[Managing an individual's access to an organization repository](/articles/managing-an-individual-s-access-to-an-organization-repository)" +- "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository)" - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md b/translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md index 412003b11e..e0cecf6b62 100644 --- a/translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md +++ b/translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md @@ -1,8 +1,8 @@ --- -title: 关于公共仓库的社区资料 -intro: 仓库维护员可以审查其公共仓库的社区资料，以了解如何帮助发展其社区和支持贡献者。 贡献者可以查看公共仓库的社区资料，确定他们是否要参与该项目。 +title: About community profiles for public repositories +intro: Repository maintainers can review their public repository's community profile to learn how they can help grow their community and support contributors. Contributors can view a public repository's community profile to see if they want to contribute to the project. redirect_from: - - /articles/viewing-your-community-profile/ + - /articles/viewing-your-community-profile - /articles/about-community-profiles-for-public-repositories - /github/building-a-strong-community/about-community-profiles-for-public-repositories versions: @@ -10,36 +10,36 @@ versions: ghec: '*' topics: - Community -shortTitle: 社区简介 +shortTitle: Community profiles --- -社区资料检查列表用于检查项目是否在支持的位置包含建议的社区健康文件，如 README、CODE_OF_CONDUCT、LICENS 或 CONTRIBUTING。 更多信息请参阅"[访问项目的社区资料](/articles/accessing-a-project-s-community-profile)"。 +The community profile checklist checks to see if a project includes recommended community health files, such as README, CODE_OF_CONDUCT, LICENSE, or CONTRIBUTING, in a supported location. For more information, see "[Accessing a project's community profile](/articles/accessing-a-project-s-community-profile)." -## 使用社区资料检查列表作为仓库维护工具 +## Using the community profile checklist as a repository maintainer -作为仓库维护员，可使用社区资料检查列表来检查项目是否符合建议的社区标准，以帮助人们使用和参与您的项目。 更多信息请参阅《开源指南》中的“[构建社区](https://opensource.guide/building-community/)”。 +As a repository maintainer, use the community profile checklist to see if your project meets the recommended community standards to help people use and contribute to your project. For more information, see "[Building community](https://opensource.guide/building-community/)" in the Open Source Guides. -如果项目没有建议的文件，可以单击 **Add（添加）**草拟并提交文件。 +If a project doesn't have a recommended file, you can click **Add** to draft and submit a file. -{% data reusables.repositories.valid-community-issues %} 更多信息请参阅“[关于议题和拉取请求模板](/articles/about-issue-and-pull-request-templates)”。 +{% data reusables.repositories.valid-community-issues %} For more information, see "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)." -![包含建议的社区标准的社区资料检查列表（适用于维护员）](/assets/images/help/repository/add-button-community-profile.png) +![Community profile checklist with recommended community standards for maintainers](/assets/images/help/repository/add-button-community-profile.png) {% data reusables.repositories.security-guidelines %} -## 社区成员或协作者使用社区资料检查列表 +## Using the community profile checklist as a community member or collaborator -作为潜在贡献者，可使用社区资料检查列表检查项目是否符合建议的社区标准，决定您是否要参与。 更多信息请参阅《开源指南》中的“[如何参与](https://opensource.guide/how-to-contribute/#anatomy-of-an-open-source-project)”。 +As a potential contributor, use the community profile checklist to see if a project meets the recommended community standards and decide if you'd like to contribute. For more information, see "[How to contribute](https://opensource.guide/how-to-contribute/#anatomy-of-an-open-source-project)" in the Open Source Guides. -如果项目没有建议的文件，可以单击 **Propose（提议）**草拟文件并提交给仓库维护员审批。 +If a project doesn't have a recommended file, you can click **Propose** to draft and submit a file to the repository maintainer for approval. -![包含建议的社区标准的社区资料检查列表（适用于贡献者）](/assets/images/help/repository/propose-button-community-profile.png) +![Community profile checklist with recommended community standards for contributors](/assets/images/help/repository/propose-button-community-profile.png) -## 延伸阅读 +## Further reading -- "[为项目添加行为准则](/articles/adding-a-code-of-conduct-to-your-project)" -- "[设置仓库贡献者的指导方针](/articles/setting-guidelines-for-repository-contributors)" -- "[添加许可到仓库](/articles/adding-a-license-to-a-repository)" -- "[关于议题和拉取请求模板](/articles/about-issue-and-pull-request-templates)" -- "[开源指南](https://opensource.guide/)" +- "[Adding a code of conduct to your project](/articles/adding-a-code-of-conduct-to-your-project)" +- "[Setting guidelines for repository contributors](/articles/setting-guidelines-for-repository-contributors)" +- "[Adding a license to a repository](/articles/adding-a-license-to-a-repository)" +- "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)" +- "[Open Source Guides](https://opensource.guide/)" - [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}) diff --git a/translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/index.md b/translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/index.md index fa9a368b77..f732f0c105 100644 --- a/translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/index.md +++ b/translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/index.md @@ -1,9 +1,9 @@ --- -title: 设置项目的健康贡献 -shortTitle: 健康贡献 -intro: 仓库维护员可以设置参与指南，帮助协作者对项目做出有意义、有用的贡献。 +title: Setting up your project for healthy contributions +shortTitle: Healthy contributions +intro: 'Repository maintainers can set contributing guidelines to help collaborators make meaningful, useful contributions to a project.' redirect_from: - - /articles/helping-people-contribute-to-your-project/ + - /articles/helping-people-contribute-to-your-project - /articles/setting-up-your-project-for-healthy-contributions - /github/building-a-strong-community/setting-up-your-project-for-healthy-contributions versions: diff --git a/translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md b/translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md index 64b0f76dfd..c5bb1df6a6 100644 --- a/translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md +++ b/translations/zh-CN/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md @@ -1,68 +1,68 @@ --- -title: 设置仓库参与者指南 -intro: 您可以创建告知人们应如何参与您的项目的指南。 +title: Setting guidelines for repository contributors +intro: You can create guidelines to communicate how people should contribute to your project. versions: fpt: '*' ghes: '*' ghae: '*' ghec: '*' redirect_from: - - /articles/how-do-i-set-up-guidelines-for-contributors/ + - /articles/how-do-i-set-up-guidelines-for-contributors - /articles/setting-guidelines-for-repository-contributors - /github/building-a-strong-community/setting-guidelines-for-repository-contributors topics: - Community -shortTitle: 参与指南 +shortTitle: Contributor guidelines --- +## About contributing guidelines +To help your project contributors do good work, you can add a file with contribution guidelines to your project repository's root, `docs`, or `.github` folder. When someone opens a pull request or creates an issue, they will see a link to that file. The link to the contributing guidelines also appears on your repository's `contribute` page. For an example of a `contribute` page, see [github/docs/contribute](https://github.com/github/docs/contribute). -## 关于参与指南 -为帮助项目参与者做好工作，您可以将含有参与指南的文件添加到项目仓库的根目录 `docs` 或 `.github` 文件夹。 有人打开拉取请求或创建议题时，他们将看到指向该文件的链接。 参与指南的链接也会出现在仓库的`贡献`页。 有关`贡献`页面的示例，请参阅 [github/docs/contribute](https://github.com/github/docs/contribute)。 +![contributing-guidelines](/assets/images/help/pull_requests/contributing-guidelines.png) -![参与指南](/assets/images/help/pull_requests/contributing-guidelines.png) +For the repository owner, contribution guidelines are a way to communicate how people should contribute. -对于仓库所有者，参与指南是告知人们应如何参与的一种途径。 +For contributors, the guidelines help them verify that they're submitting well-formed pull requests and opening useful issues. -对于参与者，该指南帮助他们确认其提交格式规范的拉取请求和打开有用的议题。 - -对于所有者和参与者来说，参与指南节省了由于不正确创建必须拒绝和重新提交的拉取请求或议题而导致的时间和麻烦。 +For both owners and contributors, contribution guidelines save time and hassle caused by improperly created pull requests or issues that have to be rejected and re-submitted. {% ifversion fpt or ghes or ghec %} -您可以为组织{% ifversion fpt or ghes or ghec %}或用户帐户{% endif %}创建默认的参与指南。 更多信息请参阅“[创建默认社区健康文件](//communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)”。 +You can create default contribution guidelines for your organization{% ifversion fpt or ghes or ghec %} or user account{% endif %}. For more information, see "[Creating a default community health file](//communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% endif %} {% tip %} -**提示：**仓库维护员可以通过为仓库创建议题或拉取请求模板来设置议题的特定指南。 更多信息请参阅“[关于议题和拉取请求模板](/articles/about-issue-and-pull-request-templates)”。 +**Tip:** Repository maintainers can set specific guidelines for issues by creating an issue or pull request template for the repository. For more information, see "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)." {% endtip %} -## 添加 *CONTRIBUTING* 文件 +## Adding a *CONTRIBUTING* file {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. 决定是在仓库的根目录 `docs` 还是 `.github` 目录中存储您的参与指南。 然后，在文件名字段中，输入文件的名称和扩展名。 参与指南文件名不区分大小写。 如果文件扩展名为支持的格式，文件会以富文本格式呈现。 更多信息请参阅“[使用非代码文件](/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)”。 ![新文件名](/assets/images/help/repository/new-file-name.png) - - 要使您的参与指南在仓库的根目录中显示，请输入 *CONTRIBUTING*。 - - 要使您的参与指南在仓库的 `docs` 目录中显示，请输入 *docs/* 以创建新目录，然后再输入 *CONTRIBUTING*。 - - 如果仓库包含多个 *CONTRIBUTING* 文件，则按以下顺序从位置中选择链接中显示的文件：`.github` 目录，然后是仓库的根目录，最后是 `docs` 目录。 -4. 在新文件中，添加参与指南。 这些可能包括： - - 创建良好议题或拉取请求的步骤。 - - 指向外部文档、邮件列表或行为准则的链接。 - - 社区和行为预期。 +3. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive. Files are rendered in rich text format if the file extension is in a supported format. For more information, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)." + ![New file name](/assets/images/help/repository/new-file-name.png) + - To make your contributing guidelines visible in the repository's root directory, type *CONTRIBUTING*. + - To make your contributing guidelines visible in the repository's `docs` directory, type *docs/* to create the new directory, then *CONTRIBUTING*. + - If a repository contains more than one *CONTRIBUTING* file, then the file shown in links is chosen from locations in the following order: the `.github` directory, then the repository's root directory, and finally the `docs` directory. +4. In the new file, add contribution guidelines. These could include: + - Steps for creating good issues or pull requests. + - Links to external documentation, mailing lists, or a code of conduct. + - Community and behavioral expectations. {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %} -## 参与指南示例 +## Examples of contribution guidelines -如果您觉得难以着手，以下是参与指南的一些良好示例： +If you're stumped, here are some good examples of contribution guidelines: -- Atom 编辑器[参与指南](https://github.com/atom/atom/blob/master/CONTRIBUTING.md)。 -- Ruby on Rails [参与指南](https://github.com/rails/rails/blob/master/CONTRIBUTING.md)。 -- Open Government [参与指南](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md)。 +- The Atom editor [contribution guidelines](https://github.com/atom/atom/blob/master/CONTRIBUTING.md). +- The Ruby on Rails [contribution guidelines](https://github.com/rails/rails/blob/master/CONTRIBUTING.md). +- The Open Government [contribution guidelines](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md). -## 延伸阅读 -- 开源指南的“[启动开源项目](https://opensource.guide/starting-a-project/)”部分{% ifversion fpt or ghec %} +## Further reading +- The Open Source Guides' section "[Starting an Open Source Project](https://opensource.guide/starting-a-project/)"{% ifversion fpt or ghec %} - [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %}{% ifversion fpt or ghes or ghec %} -- "[添加许可到仓库](/articles/adding-a-license-to-a-repository)"{% endif %} +- "[Adding a license to a repository](/articles/adding-a-license-to-a-repository)"{% endif %} diff --git a/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/index.md b/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/index.md index fc21ebf23b..9974eff8e8 100644 --- a/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/index.md +++ b/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/index.md @@ -1,10 +1,10 @@ --- -title: 使用模板鼓励有用的议题和拉取请求 -shortTitle: 议题和 PR 模板 -intro: 仓库维护员可在仓库中添加模板，以帮助贡献者创建高质量的议题和拉取请求。 +title: Using templates to encourage useful issues and pull requests +shortTitle: Issue & PR templates +intro: Repository maintainers can add templates in a repository to help contributors create high-quality issues and pull requests. redirect_from: - /github/building-a-strong-community/using-issue-and-pull-request-templates - - /articles/using-templates-to-encourage-high-quality-issues-and-pull-requests-in-your-repository/ + - /articles/using-templates-to-encourage-high-quality-issues-and-pull-requests-in-your-repository - /articles/using-issue-and-pull-request-templates - /github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests versions: diff --git a/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md b/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md index 7b85d139dd..cbf6716233 100644 --- a/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md +++ b/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md @@ -1,8 +1,8 @@ --- -title: 手动为仓库创建单一议题模板 -intro: 将手动创建的议题模板添加到仓库后，项目贡献者会自动在议题正文中看到模板的内容。 +title: Manually creating a single issue template for your repository +intro: 'When you add a manually-created issue template to your repository, project contributors will automatically see the template''s contents in the issue body.' redirect_from: - - /articles/creating-an-issue-template-for-your-repository/ + - /articles/creating-an-issue-template-for-your-repository - /articles/manually-creating-a-single-issue-template-for-your-repository - /github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository versions: @@ -12,16 +12,16 @@ versions: ghec: '*' topics: - Community -shortTitle: 创建议题模板 +shortTitle: Create an issue template --- {% data reusables.repositories.legacy-issue-template-tip %} -您可以在任何支持的文件夹中创建 *ISSUE_TEMPLATE/* 子目录，以包含多个议题模板，并且使用 `template` 查询参数指定填充议题正文的模板。 更多信息请参阅“[关于使用查询参数自动化议题和拉取请求](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)”。 +You can create an *ISSUE_TEMPLATE/* subdirectory in any of the supported folders to contain multiple issue templates, and use the `template` query parameter to specify the template that will fill the issue body. For more information, see "[About automation for issues and pull requests with query parameters](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)." -您可以将 YAML 前页添加到每个议题模板以预填议题标题、自动添加标签和受理人，并且为模板提供名称和说明，人们在您的仓库中新建议题时就会从模板选择器中看到该名称和说明。 +You can add YAML frontmatter to each issue template to pre-fill the issue title, automatically add labels and assignees, and give the template a name and description that will be shown in the template chooser that people see when creating a new issue in your repository. -下面是 YAML 前页的示例。 +Here is example YAML front matter. ```yaml --- @@ -34,7 +34,7 @@ assignees: octocat ``` {% note %} -**注：** 如果扉页值包含 YAML 保留字符，如 `:`，则您必须将整个值放入引号中。 例如，`":bug: Bug"` 或 `":new: triage needed, :bug: bug"`。 +**Note:** If a front matter value includes a YAML-reserved character such as `:` , you must put the whole value in quotes. For example, `":bug: Bug"` or `":new: triage needed, :bug: bug"`. {% endnote %} @@ -50,27 +50,31 @@ assignees: octocat {% endif %} -## 添加议题模板 +## Adding an issue template {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. 在文件名字段中： - - 要使议题模板显示在仓库的根目录中，请输入 *issue_template* 的名称。 例如 `issue_template.md`。 ![根目录中的新议题模板名称](/assets/images/help/repository/issue-template-file-name.png) - - 要使议题模板显示在仓库的 `docs` 目录中，请输入 *docs/*，后接 *issue_template* 的名称。 例如 `docs/issue_template.md`。 ![Docs 目录中的新议题模板](/assets/images/help/repository/issue-template-file-name-docs.png) - - 要将文件存储在隐藏的目录中，请输入 *.github/*，后接 *issue_template* 的名称。 例如 `.github/issue_template.md`。 ![隐藏目录中的新议题模板](/assets/images/help/repository/issue-template-hidden-directory.png) - - 要创建多个议题模板，并使用 `template` 查询参数指定填充议题正文的模板，请输入 *.github/ISSUE_TEMPLATE/*，后接议题模板的名称。 例如 `.github/ISSUE_TEMPLATE/issue_template.md`。 您也可以在根目录或 `docs/` 目录的 `ISSUE_TEMPLATE` 子目录中存储多个议题模板。 更多信息请参阅“[关于使用查询参数自动化议题和拉取请求](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)”。 ![隐藏目录中新的多议题模板](/assets/images/help/repository/issue-template-multiple-hidden-directory.png) -4. 在新文件的正文中，添加您的议题模板。 这可能包括： - - YAML 前页 - - 预期行为和实际行为 - - 重现问题的步骤 - - 项目版本、操作系统或硬件等规范 +3. In the file name field: + - To make your issue template visible in the repository's root directory, type the name of your *issue_template*. For example, `issue_template.md`. + ![New issue template name in root directory](/assets/images/help/repository/issue-template-file-name.png) + - To make your issue template visible in the repository's `docs` directory, type *docs/* followed by the name of your *issue_template*. For example, `docs/issue_template.md`, + ![New issue template in docs directory](/assets/images/help/repository/issue-template-file-name-docs.png) + - To store your file in a hidden directory, type *.github/* followed by the name of your *issue_template*. For example, `.github/issue_template.md`. + ![New issue template in hidden directory](/assets/images/help/repository/issue-template-hidden-directory.png) + - To create multiple issue templates and use the `template` query parameter to specify a template to fill the issue body, type *.github/ISSUE_TEMPLATE/*, then the name of your issue template. For example, `.github/ISSUE_TEMPLATE/issue_template.md`. You can also store multiple issue templates in an `ISSUE_TEMPLATE` subdirectory within the root or `docs/` directories. For more information, see "[About automation for issues and pull requests with query parameters](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)." + ![New multiple issue template in hidden directory](/assets/images/help/repository/issue-template-multiple-hidden-directory.png) +4. In the body of the new file, add your issue template. This could include: + - YAML frontmatter + - Expected behavior and actual behavior + - Steps to reproduce the problem + - Specifications like the version of the project, operating system, or hardware {% data reusables.files.write_commit_message %} -{% data reusables.files.choose_commit_branch %} 模板可供协作者用来合并到仓库的默认分支。 +{% data reusables.files.choose_commit_branch %} Templates are available to collaborators when they are merged into the repository's default branch. {% data reusables.files.propose_new_file %} -## 延伸阅读 +## Further reading -- "[关于议题和拉取请求模板](/articles/about-issue-and-pull-request-templates)" -- "[为仓库配置议题模板](/articles/configuring-issue-templates-for-your-repository)" -- "[关于使用查询参数自动化议题和拉取请求](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)" -- "[创建议题](/articles/creating-an-issue)" +- "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)" +- "[Configuring issue templates for your repository](/articles/configuring-issue-templates-for-your-repository)" +- "[About automation for issues and pull requests with query parameters](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)" +- "[Creating an issue](/articles/creating-an-issue)" diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/authenticating-with-github-apps.md b/translations/zh-CN/content/developers/apps/building-github-apps/authenticating-with-github-apps.md index c5751e2310..c876fc183c 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/authenticating-with-github-apps.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/authenticating-with-github-apps.md @@ -1,9 +1,9 @@ --- -title: 使用 GitHub 应用程序进行身份验证 +title: Authenticating with GitHub Apps intro: '{% data reusables.shortdesc.authenticating_with_github_apps %}' redirect_from: - - /apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps/ - - /apps/building-github-apps/authentication-options-for-github-apps/ + - /apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps + - /apps/building-github-apps/authentication-options-for-github-apps - /apps/building-github-apps/authenticating-with-github-apps - /developers/apps/authenticating-with-github-apps versions: @@ -13,59 +13,61 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 身份验证 +shortTitle: Authentication --- -## 生成私钥 +## Generating a private key -创建 GitHub 应用程序 后，您需要生成一个或多个私钥。 私钥可用于签署访问令牌请求。 +After you create a GitHub App, you'll need to generate one or more private keys. You'll use the private key to sign access token requests. -您可以创建多个私钥，然后轮流使用，以防某个私钥被盗或丢失造成停工。 要验证私钥是否与公钥匹配，请参阅[验证私钥](#verifying-private-keys)。 +You can create multiple private keys and rotate them to prevent downtime if a key is compromised or lost. To verify that a private key matches a public key, see [Verifying private keys](#verifying-private-keys). -要生成私钥： +To generate a private key: {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} {% data reusables.user-settings.modify_github_app %} -5. 在“Private keys（私钥）”中，单击 **Generate a private key（生成私钥）**。 ![生成私钥](/assets/images/github-apps/github_apps_generate_private_keys.png) -6. 您将看到一个以 PEM 格式下载至您的计算机的私钥。 确保将此文件存储下来，因为 GitHub 仅存储密钥的公共部分。 +5. In "Private keys", click **Generate a private key**. +![Generate private key](/assets/images/github-apps/github_apps_generate_private_keys.png) +6. You will see a private key in PEM format downloaded to your computer. Make sure to store this file because GitHub only stores the public portion of the key. {% note %} -**注：**如果您使用的库需要特定文件格式，您下载的 PEM 文件将呈现为 `PKCS#1 RSAPrivateKey` 格式。 +**Note:** If you're using a library that requires a specific file format, the PEM file you download will be in `PKCS#1 RSAPrivateKey` format. {% endnote %} -## 验证私钥 -{% data variables.product.product_name %} generates a fingerprint for each private and public key pair using the SHA-256 hash function. 您可以生成私钥指纹，然后与 {% data variables.product.product_name %} 显示的指纹相比较，以验证私钥是否与 {% data variables.product.product_name %} 上存储的公钥匹配。 +## Verifying private keys +{% data variables.product.product_name %} generates a fingerprint for each private and public key pair using the SHA-256 hash function. You can verify that your private key matches the public key stored on {% data variables.product.product_name %} by generating the fingerprint of your private key and comparing it to the fingerprint shown on {% data variables.product.product_name %}. -要验证私钥： +To verify a private key: -1. 在 {% data variables.product.prodname_github_app %} 开发者设置页面的“私钥”部分，查找要验证的私钥和公钥对的指纹。 更多信息请参阅[生成私钥](#generating-a-private-key)。 ![私钥指纹](/assets/images/github-apps/github_apps_private_key_fingerprint.png) -2. 使用以下命令在本地生成私钥指纹 (PEM)： +1. Find the fingerprint for the private and public key pair you want to verify in the "Private keys" section of your {% data variables.product.prodname_github_app %}'s developer settings page. For more information, see [Generating a private key](#generating-a-private-key). +![Private key fingerprint](/assets/images/github-apps/github_apps_private_key_fingerprint.png) +2. Generate the fingerprint of your private key (PEM) locally by using the following command: ```shell $ openssl rsa -in PATH_TO_PEM_FILE -pubout -outform DER | openssl sha256 -binary | openssl base64 ``` -3. 比较本地生成的指纹结果与 {% data variables.product.product_name %} 中显示的指纹。 +3. Compare the results of the locally generated fingerprint to the fingerprint you see in {% data variables.product.product_name %}. -## 删除私钥 -您可以通过删除功能删除丢失或被盗的私钥，但至少必须有一个私钥。 如果只有一个密钥，需要生成一个新钥，然后才能删除旧钥。 ![删除最后一个私钥](/assets/images/github-apps/github_apps_delete_key.png) +## Deleting private keys +You can remove a lost or compromised private key by deleting it, but you must have at least one private key. When you only have one key, you will need to generate a new one before deleting the old one. +![Deleting last private key](/assets/images/github-apps/github_apps_delete_key.png) -## 验证为 {% data variables.product.prodname_github_app %} +## Authenticating as a {% data variables.product.prodname_github_app %} -通过验证为 {% data variables.product.prodname_github_app %}，您可以执行以下操作： +Authenticating as a {% data variables.product.prodname_github_app %} lets you do a couple of things: -* 检索关于您的 {% data variables.product.prodname_github_app %} 的高级管理信息。 -* 为应用程序安装申请访问令牌。 +* You can retrieve high-level management information about your {% data variables.product.prodname_github_app %}. +* You can request access tokens for an installation of the app. -要验证为 {% data variables.product.prodname_github_app %}，请以 PEM 格式[生成私钥](#generating-a-private-key)，并将其下载到本地机器上。 您可以使用此密钥签署 [JSON Web 令牌 (JWT)](https://jwt.io/introduction)，然后用 `RS256` 算法为它编码。 {% data variables.product.product_name %} 将使用应用程序存储的公钥验证令牌，以检查请求是否已通过身份验证。 +To authenticate as a {% data variables.product.prodname_github_app %}, [generate a private key](#generating-a-private-key) in PEM format and download it to your local machine. You'll use this key to sign a [JSON Web Token (JWT)](https://jwt.io/introduction) and encode it using the `RS256` algorithm. {% data variables.product.product_name %} checks that the request is authenticated by verifying the token with the app's stored public key. -下面是一段快速 Ruby 脚本，可用于生成 JWT。 请注意，您必须先运行 `gem install jwt`，然后才能使用。 +Here's a quick Ruby script you can use to generate a JWT. Note you'll have to run `gem install jwt` before using it. - ```ruby require 'openssl' require 'jwt' # https://rubygems.org/gems/jwt @@ -88,19 +90,19 @@ jwt = JWT.encode(payload, private_key, "RS256") puts jwt ``` -`YOUR_PATH_TO_PEM` 和 `YOUR_APP_ID` 是必须替换的值。 请确保以双引号括住值。 +`YOUR_PATH_TO_PEM` and `YOUR_APP_ID` are the values you must replace. Make sure to enclose the values in double quotes. -使用 {% data variables.product.prodname_github_app %} 的标识符 (`YOUR_APP_ID`) 作为 JWT [iss](https://tools.ietf.org/html/rfc7519#section-4.1.1)（签发者）申请的值。 您可以在[创建应用程序](/apps/building-github-apps/creating-a-github-app/)后通过初始 web 挂钩，或随时从 GitHub.com UI 的应用程序设置页面获取 {% data variables.product.prodname_github_app %} 标识符。 +Use your {% data variables.product.prodname_github_app %}'s identifier (`YOUR_APP_ID`) as the value for the JWT [iss](https://tools.ietf.org/html/rfc7519#section-4.1.1) (issuer) claim. You can obtain the {% data variables.product.prodname_github_app %} identifier via the initial webhook ping after [creating the app](/apps/building-github-apps/creating-a-github-app/), or at any time from the app settings page in the GitHub.com UI. -创建 JWT 后，在 API 请求的 `Header` 中对它进行设置。 +After creating the JWT, set it in the `Header` of the API request: ```shell $ curl -i -H "Authorization: Bearer YOUR_JWT" -H "Accept: application/vnd.github.v3+json" {% data variables.product.api_url_pre %}/app ``` -`YOUR_JWT` 是必须替换的值。 +`YOUR_JWT` is the value you must replace. -上述示例所用的最大到期时间为 10 分钟，到期后，API 将开始返回 `401` 错误。 +The example above uses the maximum expiration time of 10 minutes, after which the API will start returning a `401` error: ```json { @@ -109,19 +111,19 @@ $ curl -i -H "Authorization: Bearer YOUR_JWT" -H "Accept: application/vnd.github } ``` -到期后，您需要创建新 JWT。 +You'll need to create a new JWT after the time expires. -## 作为 {% data variables.product.prodname_github_app %} 访问 API 端点 +## Accessing API endpoints as a {% data variables.product.prodname_github_app %} -有关获取关于 {% data variables.product.prodname_github_app %} 的高级信息所用的 REST API 端点列表，请参阅“[GitHub 应用程序](/rest/reference/apps)。” +For a list of REST API endpoints you can use to get high-level information about a {% data variables.product.prodname_github_app %}, see "[GitHub Apps](/rest/reference/apps)." -## 验证为安装 +## Authenticating as an installation -通过验证为安装，您可以在 API 中为此安装执行操作。 验证为安装之前，必须创建安装访问令牌。 确保您已将 GitHub 应用安装到至少一个仓库；如果没有单个安装，就无法创建安装令牌。 这些安装访问令牌由 {% data variables.product.prodname_github_apps %} 用于进行身份验证。 更多信息请参阅“[安装 GitHub 应用程序](/developers/apps/managing-github-apps/installing-github-apps)”。 +Authenticating as an installation lets you perform actions in the API for that installation. Before authenticating as an installation, you must create an installation access token. Ensure that you have already installed your GitHub App to at least one repository; it is impossible to create an installation token without a single installation. These installation access tokens are used by {% data variables.product.prodname_github_apps %} to authenticate. For more information, see "[Installing GitHub Apps](/developers/apps/managing-github-apps/installing-github-apps)." -默认情况下，安装访问令牌的作用域为安装可访问的所有仓库。 您可以使用 `repository_ids` 参数将安装访问令牌的作用域限定于特定仓库。 请参阅[创建应用程序的安装访问令牌](/rest/reference/apps#create-an-installation-access-token-for-an-app)端点了解更多详细信息。 安装访问令牌具有由 {% data variables.product.prodname_github_app %} 配置的权限，一个小时后到期。 +By default, installation access tokens are scoped to all the repositories that an installation can access. You can limit the scope of the installation access token to specific repositories by using the `repository_ids` parameter. See the [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app) endpoint for more details. Installation access tokens have the permissions configured by the {% data variables.product.prodname_github_app %} and expire after one hour. -要列出已验证应用的安装，请在 API 请求中的授权头中包括[上述生成](#jwt-payload)的 JWT： +To list the installations for an authenticated app, include the JWT [generated above](#jwt-payload) in the Authorization header in the API request: ```shell $ curl -i -X GET \ @@ -130,9 +132,9 @@ $ curl -i -X GET \ {% data variables.product.api_url_pre %}/app/installations ``` -响应将包括一个安装列表，其中每个安装的 `id` 可用来创建一个安装访问令牌。 有关响应格式的更多信息，请参阅“[列出已验证应用的安装](/rest/reference/apps#list-installations-for-the-authenticated-app)”。 +The response will include a list of installations where each installation's `id` can be used for creating an installation access token. For more information about the response format, see "[List installations for the authenticated app](/rest/reference/apps#list-installations-for-the-authenticated-app)." -要创建安装访问令牌，请在 API 请求的授权头中包括[上述生成](#jwt-payload)的 JWT，并将 `:installation_id` 替换为安装的 `id`： +To create an installation access token, include the JWT [generated above](#jwt-payload) in the Authorization header in the API request and replace `:installation_id` with the installation's `id`: ```shell $ curl -i -X POST \ @@ -141,9 +143,9 @@ $ curl -i -X POST \ {% data variables.product.api_url_pre %}/app/installations/:installation_id/access_tokens ``` -响应将包括您的安装访问令牌、到期日期、令牌权限及令牌可访问的仓库。 有关响应格式的更多信息，请参阅[创建应用程序的安装访问令牌](/rest/reference/apps#create-an-installation-access-token-for-an-app)端点。 +The response will include your installation access token, the expiration date, the token's permissions, and the repositories that the token can access. For more information about the response format, see the [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app) endpoint. -要使用安装访问令牌进行身份验证，请将其加入 API 请求的“授权”标头中。 +To authenticate with an installation access token, include it in the Authorization header in the API request: ```shell $ curl -i \ @@ -152,17 +154,17 @@ $ curl -i \ {% data variables.product.api_url_pre %}/installation/repositories ``` -`YOUR_INSTALLATION_ACCESS_TOKEN` 是必须替换的值。 +`YOUR_INSTALLATION_ACCESS_TOKEN` is the value you must replace. -## 作为安装访问 API 端点 +## Accessing API endpoints as an installation -有关适用于使用安装访问令牌的 {% data variables.product.prodname_github_apps %} 的 REST API 端点列表，请参阅“[可用端点](/rest/overview/endpoints-available-for-github-apps)。” +For a list of REST API endpoints that are available for use by {% data variables.product.prodname_github_apps %} using an installation access token, see "[Available Endpoints](/rest/overview/endpoints-available-for-github-apps)." -有关与安装相关的端点的列表，请参阅“[安装](/rest/reference/apps#installations)。” +For a list of endpoints related to installations, see "[Installations](/rest/reference/apps#installations)." -## 由安装验证基于 HTTP 的 Git 访问权限 +## HTTP-based Git access by an installation -在仓库的 `contents` 上拥有[权限](/apps/building-github-apps/setting-permissions-for-github-apps/)的安装可以使用其安装访问令牌对 Git 访问权限进行身份验证。 使用安装访问令牌作为 HTTP 密码： +Installations with [permissions](/apps/building-github-apps/setting-permissions-for-github-apps/) on `contents` of a repository, can use their installation access tokens to authenticate for Git access. Use the installation access token as the HTTP password: ```shell git clone https://x-access-token:<token>@github.com/owner/repo.git diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app.md b/translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app.md index 6f5dcbddb1..93f56c8090 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app.md @@ -1,9 +1,9 @@ --- -title: 创建 GitHub 应用程序 +title: Creating a GitHub App intro: '{% data reusables.shortdesc.creating_github_apps %}' redirect_from: - - /early-access/integrations/creating-an-integration/ - - /apps/building-integrations/setting-up-and-registering-github-apps/registering-github-apps/ + - /early-access/integrations/creating-an-integration + - /apps/building-integrations/setting-up-and-registering-github-apps/registering-github-apps - /apps/building-github-apps/creating-a-github-app - /developers/apps/creating-a-github-app versions: @@ -14,13 +14,12 @@ versions: topics: - GitHub Apps --- - -{% ifversion fpt or ghec %} 要了解如何使用 GitHub 应用程序清单允许用户创建预配置 GitHub 应用程序，请参阅“[从清单创建 GitHub 应用程序](/apps/building-github-apps/creating-github-apps-from-a-manifest/)。”{% endif %} +{% ifversion fpt or ghec %}To learn how to use GitHub App Manifests, which allow people to create preconfigured GitHub Apps, see "[Creating GitHub Apps from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/)."{% endif %} {% ifversion fpt or ghec %} {% note %} - **注意：** {% data reusables.apps.maximum-github-apps-allowed %} + **Note:** {% data reusables.apps.maximum-github-apps-allowed %} {% endnote %} {% endif %} @@ -28,44 +27,57 @@ topics: {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} -1. 单击 **New GitHub App（新建 GitHub 应用程序）**。 ![用于创建新 GitHub 应用程序的按钮](/assets/images/github-apps/github_apps_new.png) -1. 在“GitHub App name（GitHub 应用程序名称）”中，输入应用程序的名称。 ![GitHub 应用程序名称字段](/assets/images/github-apps/github_apps_app_name.png) +1. Click **New GitHub App**. +![Button to create a new GitHub App](/assets/images/github-apps/github_apps_new.png) +1. In "GitHub App name", type the name of your app. +![Field for the name of your GitHub App](/assets/images/github-apps/github_apps_app_name.png) - 给应用程序一个清晰简洁的名称。 应用程序不能与现有 GitHub 帐户同名，除非它是您自己的用户或组织的名称。 当您的集成执行操作时，应用程序名称的缓存版本将显示在用户界面上。 + Give your app a clear and succinct name. Your app cannot have the same name as an existing GitHub account, unless it is your own user or organization name. A slugged version of your app's name will be shown in the user interface when your integration takes an action. -1. （可选）在“Description（说明）”中，输入用户将看到的应用程序说明。 ![GitHub 应用程序说明字段](/assets/images/github-apps/github_apps_description.png) -1. 在“Homepage URL（主页 URL）”中，输入应用程序网站的完整 URL。 ![GitHub 应用程序主页 URL 字段](/assets/images/github-apps/github_apps_homepage_url.png) +1. Optionally, in "Description", type a description of your app that users will see. +![Field for a description of your GitHub App](/assets/images/github-apps/github_apps_description.png) +1. In "Homepage URL", type the full URL to your app's website. +![Field for the homepage URL of your GitHub App](/assets/images/github-apps/github_apps_homepage_url.png) {% ifversion fpt or ghes > 3.0 or ghec %} -1. 在“Callback URL（回调 URL）”中，键入用户授权安装后要重定向到的完整 URL。 如果应用程序需要识别和授权用户到服务器的请求，则使用此 URL。 +1. In "Callback URL", type the full URL to redirect to after a user authorizes the installation. This URL is used if your app needs to identify and authorize user-to-server requests. - 您可以使用 **Add callback URL（添加回调 URL）**来提供额外的回调 URL，最多不超过 10 个。 + You can use **Add callback URL** to provide additional callback URLs, up to a maximum of 10. - ![用于“添加回调 URL”的按钮和回调 URL 的字段](/assets/images/github-apps/github_apps_callback_url_multiple.png) + ![Button for 'Add callback URL' and field for callback URL](/assets/images/github-apps/github_apps_callback_url_multiple.png) {% else %} -1. 在“User authorization callback URL（用户授权回调 URL）”中，键入用户授权安装后要重定向到的完整 URL。 如果应用程序需要识别和授权用户到服务器的请求，则使用此 URL。 ![GitHub 应用程序的用户授权回调 URL 字段](/assets/images/github-apps/github_apps_user_authorization.png) +1. In "User authorization callback URL", type the full URL to redirect to after a user authorizes an installation. This URL is used if your app needs to identify and authorize user-to-server requests. +![Field for the user authorization callback URL of your GitHub App](/assets/images/github-apps/github_apps_user_authorization.png) {% endif %} -1. 默认情况下，为了提高应用程序的安全性，应用程序将使用过期用户授权令牌。 要选择不使用过期用户令牌，您必须取消选中“Expire user authorization tokens（过期用户授权令牌）”。 要了解有关设置刷新令牌流程和过期用户令牌的好处，请参阅“[刷新用户到服务器的访问令牌](/apps/building-github-apps/refreshing-user-to-server-access-tokens/)”。 ![在 GitHub 应用程序设置过程中选择加入过期用户令牌的选项](/assets/images/github-apps/expire-user-tokens-selection.png) -1. 如果应用程序授权用户使用 OAuth 流程，您可以选择**在安装过程中请求用户授权 (OAuth)**，以允许用户在安装应用程序时授权它，从而省去一个步骤。 如果您选择此选项，则“设置 URL”将不可用，用户在安装应用程序后将被重定向到您的“用户授权回调 URL”。 更多信息请参阅“[在安装过程中授权用户](/apps/installing-github-apps/#authorizing-users-during-installation)”。 ![安装过程中请求用户授权](/assets/images/github-apps/github_apps_request_auth_upon_install.png) -1. 如果安装后需要附加设置，请添加一个“设置 URL”以便在用户安装应用程序后重定向他们。 ![GitHub 应用程序的设置 URL 字段 ](/assets/images/github-apps/github_apps_setup_url.png) +1. By default, to improve your app's security, your app will use expiring user authorization tokens. To opt-out of using expiring user tokens, you must deselect "Expire user authorization tokens". To learn more about setting up a refresh token flow and the benefits of expiring user tokens, see "[Refreshing user-to-server access tokens](/apps/building-github-apps/refreshing-user-to-server-access-tokens/)." + ![Option to opt-in to expiring user tokens during GitHub Apps setup](/assets/images/github-apps/expire-user-tokens-selection.png) +1. If your app authorizes users using the OAuth flow, you can select **Request user authorization (OAuth) during installation** to allow people to authorize the app when they install it, saving a step. If you select this option, the "Setup URL" becomes unavailable and users will be redirected to your "User authorization callback URL" after installing the app. See "[Authorizing users during installation](/apps/installing-github-apps/#authorizing-users-during-installation)" for more information. +![Request user authorization during installation](/assets/images/github-apps/github_apps_request_auth_upon_install.png) +1. If additional setup is required after installation, add a "Setup URL" to redirect users to after they install your app. +![Field for the setup URL of your GitHub App ](/assets/images/github-apps/github_apps_setup_url.png) {% note %} - **注：**如果您在上一步选择了**在安装过程中请求用户授权 (OAuth)**，此字段将不可用，用户在安装应用程序后将被重定向到“用户授权回调 URL”。 + **Note:** When you select **Request user authorization (OAuth) during installation** in the previous step, this field becomes unavailable and people will be redirected to the "User authorization callback URL" after installing the app. {% endnote %} -1. 在“Webhook URL（Web 挂钩 URL）”中，输入事件将 POST 到的 URL。 每个应用程序都会收到自己的 web 挂钩（每当应用程序被安装或修改时都会通知您）以及应用程序订阅的任何其他事件。 ![GitHub 应用程序的 web 挂钩 URL 字段](/assets/images/github-apps/github_apps_webhook_url.png) +1. In "Webhook URL", type the URL that events will POST to. Each app receives its own webhook which will notify you every time the app is installed or modified, as well as any other events the app subscribes to. +![Field for the webhook URL of your GitHub App](/assets/images/github-apps/github_apps_webhook_url.png) -1. （可选）在“Webhook Secret（Web 挂钩密钥）”中，输入用于保护 web 挂钩的可选密钥令牌。 ![添加 web 挂钩密钥令牌的字段](/assets/images/github-apps/github_apps_webhook_secret.png) +1. Optionally, in "Webhook Secret", type an optional secret token used to secure your webhooks. +![Field to add a secret token for your webhook](/assets/images/github-apps/github_apps_webhook_secret.png) {% note %} - **注：**我们强烈建议您设置密钥令牌。 更多信息请参阅“[保护 web 挂钩](/webhooks/securing/)”。 + **Note:** We highly recommend that you set a secret token. For more information, see "[Securing your webhooks](/webhooks/securing/)." {% endnote %} -1. 在“Permissions（权限）”中，选择应用程序将请求的权限。 对于每种类型的权限，请使用下拉菜单并单击 **Read-only（只读）**、**Read & write（读取和写入）** 或 **No access（无访问权限）**。 ![GitHub 应用程序的各种权限](/assets/images/github-apps/github_apps_new_permissions_post2dot13.png) -1. 在“Subscribe to events（订阅事件）”中，选择您想要应用程序接收的事件。 -1. 要选择可安装应用程序的位置，请选择 **Only on this account（仅在此帐户上）**或 **Any account（任何帐户）**。 有关安装选项的更多信息，请参阅“[将 GitHub 应用程序设为公开或私有](/apps/managing-github-apps/making-a-github-app-public-or-private/)”。 ![GitHub 应用程序的安装选项](/assets/images/github-apps/github_apps_installation_options.png) -1. 单击 **Create GitHub App（创建 GitHub 应用程序）**。 ![创建 GitHub 应用程序的按钮](/assets/images/github-apps/github_apps_create_github_app.png) +1. In "Permissions", choose the permissions your app will request. For each type of permission, use the drop-down menu and click **Read-only**, **Read & write**, or **No access**. +![Various permissions for your GitHub App](/assets/images/github-apps/github_apps_new_permissions_post2dot13.png) +1. In "Subscribe to events", choose the events you want your app to receive. +1. To choose where the app can be installed, select either **Only on this account** or **Any account**. For more information on installation options, see "[Making a GitHub App public or private](/apps/managing-github-apps/making-a-github-app-public-or-private/)." +![Installation options for your GitHub App](/assets/images/github-apps/github_apps_installation_options.png) +1. Click **Create GitHub App**. +![Button to create your GitHub App](/assets/images/github-apps/github_apps_create_github_app.png) diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md b/translations/zh-CN/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md index 1ea8edbf72..f3dc98fd52 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md @@ -2,8 +2,8 @@ title: Identifying and authorizing users for GitHub Apps intro: '{% data reusables.shortdesc.identifying_and_authorizing_github_apps %}' redirect_from: - - /early-access/integrations/user-identification-authorization/ - - /apps/building-integrations/setting-up-and-registering-github-apps/identifying-users-for-github-apps/ + - /early-access/integrations/user-identification-authorization + - /apps/building-integrations/setting-up-and-registering-github-apps/identifying-users-for-github-apps - /apps/building-github-apps/identifying-and-authorizing-users-for-github-apps - /developers/apps/identifying-and-authorizing-users-for-github-apps versions: diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/index.md b/translations/zh-CN/content/developers/apps/building-github-apps/index.md index 8cef812925..20e2cd4b16 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/index.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/index.md @@ -1,8 +1,8 @@ --- -title: 构建 GitHub 应用程序 -intro: 您可以构建您自己或其他人使用的 GitHub 应用程序。 了解如何注册和设置 GitHub 应用程序的权限及身份验证选项。 +title: Building GitHub Apps +intro: You can build GitHub Apps for yourself or others to use. Learn how to register and set up permissions and authentication options for GitHub Apps. redirect_from: - - /apps/building-integrations/setting-up-and-registering-github-apps/ + - /apps/building-integrations/setting-up-and-registering-github-apps - /apps/building-github-apps versions: fpt: '*' diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md b/translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md index ce73470709..6027f1bb2b 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md @@ -1,10 +1,10 @@ --- -title: GitHub 应用程序的速率限制 +title: Rate limits for GitHub Apps intro: '{% data reusables.shortdesc.rate_limits_github_apps %}' redirect_from: - - /early-access/integrations/rate-limits/ - - /apps/building-integrations/setting-up-and-registering-github-apps/about-rate-limits-for-github-apps/ - - /apps/building-github-apps/rate-limits-for-github-apps/ + - /early-access/integrations/rate-limits + - /apps/building-integrations/setting-up-and-registering-github-apps/about-rate-limits-for-github-apps + - /apps/building-github-apps/rate-limits-for-github-apps - /apps/building-github-apps/understanding-rate-limits-for-github-apps - /developers/apps/rate-limits-for-github-apps versions: @@ -14,16 +14,15 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 速率限制 +shortTitle: Rate limits --- - -## 服务器到服务器请求 +## Server-to-server requests {% ifversion ghec %} The rate limits for server-to-server requests made by {% data variables.product.prodname_github_apps %} depend on where the app is installed. If the app is installed on organizations or repositories owned by an enterprise on {% data variables.product.product_location %}, then the rate is higher than for installations outside an enterprise. -### 标准的服务器到服务器速率限制 +### Normal server-to-server rate limits {% endif %} @@ -31,32 +30,32 @@ The rate limits for server-to-server requests made by {% data variables.product. {% ifversion ghec %} -### {% data variables.product.prodname_ghe_cloud %} 服务器到服务器速率限制 +### {% data variables.product.prodname_ghe_cloud %} server-to-server rate limits {% data variables.product.prodname_github_apps %} that are installed on an organization or repository owned by an enterprise on {% data variables.product.product_location %} have a rate limit of 15,000 requests per hour for server-to-server requests. {% endif %} -## 用户到服务器请求 +## User-to-server requests -{% data variables.product.prodname_github_apps %} 还可以[代表用户](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-and-authorizing-users-for-github-apps)发送用户到服务器的请求。 +{% data variables.product.prodname_github_apps %} can also act [on behalf of a user](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-and-authorizing-users-for-github-apps), making user-to-server requests. {% ifversion ghec %} The rate limits for user-to-server requests made by {% data variables.product.prodname_github_apps %} depend on where the app is installed. If the app is installed on organizations or repositories owned by an enterprise on {% data variables.product.product_location %}, then the rate is higher than for installations outside an enterprise. -### 标准的用户到服务器速率限制 +### Normal user-to-server rate limits {% endif %} -User-to-server requests are rate limited at {% ifversion ghae %}15,000{% else %}5,000{% endif %} requests per hour and per authenticated user. 该用户授权的所有 OAuth 应用程序、该用户拥有的个人访问令牌以及使用该用户的{% ifversion ghae %} 令牌{% else %} 用户名和密码{% endif %} 验证的请求，将共享该用户每小时 5,000 个请求的配额。 +User-to-server requests are rate limited at {% ifversion ghae %}15,000{% else %}5,000{% endif %} requests per hour and per authenticated user. All OAuth applications authorized by that user, personal access tokens owned by that user, and requests authenticated with that user's{% ifversion ghae %} token{% else %} username and password{% endif %} share the same quota of 5,000 requests per hour for that user. {% ifversion ghec %} -### {% data variables.product.prodname_ghe_cloud %} 用户到服务器速率限制 +### {% data variables.product.prodname_ghe_cloud %} user-to-server rate limits When a user belongs to an enterprise on {% data variables.product.product_location %}, user-to-server requests to resources owned by the same enterprise are rate limited at 15,000 requests per hour and per authenticated user. All OAuth applications authorized by that user, personal access tokens owned by that user, and requests authenticated with that user's username and password share the same quota of 5,000 requests per hour for that user. {% endif %} -有关速率限制的更多信息，请参阅 REST API 的“[速率限制](/rest/overview/resources-in-the-rest-api#rate-limiting)”和 GraphQL API 的“[资源限制]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/overview/resource-limitations)”。 +For more detailed information about rate limits, see "[Rate limiting](/rest/overview/resources-in-the-rest-api#rate-limiting)" for REST API and "[Resource limitations]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/overview/resource-limitations)" for GraphQL API. diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/setting-permissions-for-github-apps.md b/translations/zh-CN/content/developers/apps/building-github-apps/setting-permissions-for-github-apps.md index 7cba8dd004..df3ebbe72d 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/setting-permissions-for-github-apps.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/setting-permissions-for-github-apps.md @@ -1,9 +1,9 @@ --- -title: 设置 GitHub 应用程序的权限 +title: Setting permissions for GitHub Apps intro: '{% data reusables.shortdesc.permissions_github_apps %}' redirect_from: - - /apps/building-integrations/setting-up-and-registering-github-apps/about-permissions-for-github-apps/ - - /apps/building-github-apps/permissions-for-github-apps/ + - /apps/building-integrations/setting-up-and-registering-github-apps/about-permissions-for-github-apps + - /apps/building-github-apps/permissions-for-github-apps - /apps/building-github-apps/setting-permissions-for-github-apps - /developers/apps/setting-permissions-for-github-apps versions: @@ -13,7 +13,6 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 设置权限 +shortTitle: Set permissions --- - -GitHub 应用程序默认没有任何权限。 创建 GitHub 应用程序时，您可以选择访问最终用户数据所需的权限。 还可以添加和删除权限。 更多信息请参阅“[编辑 GitHub 应用程序的权限](/apps/managing-github-apps/editing-a-github-app-s-permissions/)”。 +GitHub Apps don't have any permissions by default. When you create a GitHub App, you can select the permissions it needs to access end user data. Permissions can also be added and removed. For more information, see "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)." diff --git a/translations/zh-CN/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md b/translations/zh-CN/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md index fc5641bce7..d390f9c8e5 100644 --- a/translations/zh-CN/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md +++ b/translations/zh-CN/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md @@ -2,11 +2,11 @@ title: Authorizing OAuth Apps intro: '{% data reusables.shortdesc.authorizing_oauth_apps %}' redirect_from: - - /apps/building-integrations/setting-up-and-registering-oauth-apps/about-authorization-options-for-oauth-apps/ - - /apps/building-integrations/setting-up-and-registering-oauth-apps/directing-users-to-review-their-access/ - - /apps/building-integrations/setting-up-and-registering-oauth-apps/creating-multiple-tokens-for-oauth-apps/ - - /v3/oauth/ - - /apps/building-oauth-apps/authorization-options-for-oauth-apps/ + - /apps/building-integrations/setting-up-and-registering-oauth-apps/about-authorization-options-for-oauth-apps + - /apps/building-integrations/setting-up-and-registering-oauth-apps/directing-users-to-review-their-access + - /apps/building-integrations/setting-up-and-registering-oauth-apps/creating-multiple-tokens-for-oauth-apps + - /v3/oauth + - /apps/building-oauth-apps/authorization-options-for-oauth-apps - /apps/building-oauth-apps/authorizing-oauth-apps - /developers/apps/authorizing-oauth-apps versions: diff --git a/translations/zh-CN/content/developers/apps/building-oauth-apps/creating-an-oauth-app.md b/translations/zh-CN/content/developers/apps/building-oauth-apps/creating-an-oauth-app.md index 191419365d..a080cbc4da 100644 --- a/translations/zh-CN/content/developers/apps/building-oauth-apps/creating-an-oauth-app.md +++ b/translations/zh-CN/content/developers/apps/building-oauth-apps/creating-an-oauth-app.md @@ -1,8 +1,8 @@ --- -title: 创建 OAuth 应用程序 +title: Creating an OAuth App intro: '{% data reusables.shortdesc.creating_oauth_apps %}' redirect_from: - - /apps/building-integrations/setting-up-and-registering-oauth-apps/registering-oauth-apps/ + - /apps/building-integrations/setting-up-and-registering-oauth-apps/registering-oauth-apps - /apps/building-oauth-apps/creating-an-oauth-app - /developers/apps/creating-an-oauth-app versions: @@ -13,11 +13,10 @@ versions: topics: - OAuth Apps --- - {% ifversion fpt or ghec %} {% note %} - **注意：** {% data reusables.apps.maximum-oauth-apps-allowed %} + **Note:** {% data reusables.apps.maximum-oauth-apps-allowed %} {% endnote %} {% endif %} @@ -25,29 +24,35 @@ topics: {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %} -4. 单击 **New OAuth App（新建 OAuth 应用程序）**。 ![创建新 OAuth 应用程序的按钮](/assets/images/oauth-apps/oauth_apps_new_app.png) +4. Click **New OAuth App**. +![Button to create a new OAuth app](/assets/images/oauth-apps/oauth_apps_new_app.png) {% note %} - **注：**如果您以前没有创建过应用程序，该按钮将显示 **Register a new application（注册新应用程序）**。 + **Note:** If you haven't created an app before, this button will say, **Register a new application**. {% endnote %} -6. 在“Application name（应用程序名称）”中，输入应用程序的名称。 ![应用程序名称字段](/assets/images/oauth-apps/oauth_apps_application_name.png) +6. In "Application name", type the name of your app. +![Field for the name of your app](/assets/images/oauth-apps/oauth_apps_application_name.png) {% warning %} - **警告：**仅在 OAuth 应用程序中使用您认为公开的信息。 创建 OAuth 应用程序时，应避免使用敏感数据（如内部 URL）。 + **Warning:** Only use information in your OAuth app that you consider public. Avoid using sensitive data, such as internal URLs, when creating an OAuth App. {% endwarning %} -7. 在“Homepage URL（主页 URL）”中，输入应用程序网站的完整 URL。 ![应用程序主页 URL 字段](/assets/images/oauth-apps/oauth_apps_homepage_url.png) -8. （可选）在“Application description（应用程序说明）”中，输入用户将看到的应用程序说明。 ![应用程序说明字段](/assets/images/oauth-apps/oauth_apps_application_description.png) -9. 在“Authorization callback URL（授权回调 URL）”中，输入应用程序的回调 URL。 ![应用程序的授权回调 URL 字段](/assets/images/oauth-apps/oauth_apps_authorization_callback_url.png) +7. In "Homepage URL", type the full URL to your app's website. +![Field for the homepage URL of your app](/assets/images/oauth-apps/oauth_apps_homepage_url.png) +8. Optionally, in "Application description", type a description of your app that users will see. +![Field for a description of your app](/assets/images/oauth-apps/oauth_apps_application_description.png) +9. In "Authorization callback URL", type the callback URL of your app. +![Field for the authorization callback URL of your app](/assets/images/oauth-apps/oauth_apps_authorization_callback_url.png) {% ifversion fpt or ghes > 3.0 or ghec %} {% note %} - **注：**与 {% data variables.product.prodname_github_apps %} 不同，OAuth 应用程序不能有多个回调 URL。 + **Note:** OAuth Apps cannot have multiple callback URLs, unlike {% data variables.product.prodname_github_apps %}. {% endnote %} {% endif %} -10. 单击 **Register application（注册应用程序）**。 ![注册应用程序的按钮](/assets/images/oauth-apps/oauth_apps_register_application.png) +10. Click **Register application**. +![Button to register an application](/assets/images/oauth-apps/oauth_apps_register_application.png) diff --git a/translations/zh-CN/content/developers/apps/building-oauth-apps/index.md b/translations/zh-CN/content/developers/apps/building-oauth-apps/index.md index 75dadea680..69a5c827a2 100644 --- a/translations/zh-CN/content/developers/apps/building-oauth-apps/index.md +++ b/translations/zh-CN/content/developers/apps/building-oauth-apps/index.md @@ -1,8 +1,8 @@ --- -title: 构建 OAuth 应用程序 -intro: 您可以构建您自己或其他人使用的 OAuth 应用程序。 了解如何注册和设置 OAuth 应用程序的权限及身份验证选项。 +title: Building OAuth Apps +intro: You can build OAuth Apps for yourself or others to use. Learn how to register and set up permissions and authorization options for OAuth Apps. redirect_from: - - /apps/building-integrations/setting-up-and-registering-oauth-apps/ + - /apps/building-integrations/setting-up-and-registering-oauth-apps - /apps/building-oauth-apps versions: fpt: '*' diff --git a/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index 3dc9de0fb9..bdf4b1997d 100644 --- a/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -2,8 +2,8 @@ title: Scopes for OAuth Apps intro: '{% data reusables.shortdesc.understanding_scopes_for_oauth_apps %}' redirect_from: - - /apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/ - - /apps/building-oauth-apps/scopes-for-oauth-apps/ + - /apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps + - /apps/building-oauth-apps/scopes-for-oauth-apps - /apps/building-oauth-apps/understanding-scopes-for-oauth-apps - /developers/apps/scopes-for-oauth-apps versions: diff --git a/translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md b/translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md index bcb5178dfb..d60e0d8400 100644 --- a/translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md +++ b/translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md @@ -2,9 +2,9 @@ title: About apps intro: 'You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs to add flexibility and reduce friction in your own workflow.{% ifversion fpt or ghec %} You can also share integrations with others on [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace).{% endif %}' redirect_from: - - /apps/building-integrations/setting-up-a-new-integration/ - - /apps/building-integrations/ - - /apps/getting-started-with-building-apps/ + - /apps/building-integrationssetting-up-a-new-integration + - /apps/building-integrations + - /apps/getting-started-with-building-apps - /apps/about-apps - /developers/apps/about-apps versions: diff --git a/translations/zh-CN/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md b/translations/zh-CN/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md index 3b4da45422..6e2ffa00ba 100644 --- a/translations/zh-CN/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md +++ b/translations/zh-CN/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md @@ -2,8 +2,8 @@ title: Differences between GitHub Apps and OAuth Apps intro: 'Understanding the differences between {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} will help you decide which app you want to create. An {% data variables.product.prodname_oauth_app %} acts as a GitHub user, whereas a {% data variables.product.prodname_github_app %} uses its own identity when installed on an organization or on repositories within an organization.' redirect_from: - - /early-access/integrations/integrations-vs-oauth-applications/ - - /apps/building-integrations/setting-up-a-new-integration/about-choosing-an-integration-type/ + - /early-access/integrations/integrations-vs-oauth-applications + - /apps/building-integrations/setting-up-a-new-integration/about-choosing-an-integration-type - /apps/differences-between-apps - /developers/apps/differences-between-github-apps-and-oauth-apps versions: diff --git a/translations/zh-CN/content/developers/apps/guides/using-the-github-api-in-your-app.md b/translations/zh-CN/content/developers/apps/guides/using-the-github-api-in-your-app.md index 3ffb6b0660..fa26be18c7 100644 --- a/translations/zh-CN/content/developers/apps/guides/using-the-github-api-in-your-app.md +++ b/translations/zh-CN/content/developers/apps/guides/using-the-github-api-in-your-app.md @@ -1,8 +1,8 @@ --- -title: 在应用程序中使用 GitHub API -intro: 了解如何设置应用程序以侦听事件，并使用 Octokit 库执行 REST API 操作。 +title: Using the GitHub API in your app +intro: Learn how to set up your app to listen for events and use the Octokit library to perform REST API operations. redirect_from: - - /apps/building-your-first-github-app/ + - /apps/building-your-first-github-app - /apps/quickstart-guides/using-the-github-api-in-your-app - /developers/apps/using-the-github-api-in-your-app versions: @@ -12,90 +12,89 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 使用 REST API 构建应用程序 +shortTitle: Build an app with the REST API --- +## Introduction -## 简介 +This guide will help you build a GitHub App and run it on a server. The app you build will add a label to all new issues opened in the repository where the app is installed. -本指南将帮助您构建 GitHub 应用程序并在服务器上运行它。 您构建的应用程序将为在安装该应用程序的仓库中所有打开的新议题添加标签。 +This project will walk you through the following: -此项目将引导您完成以下工作： - -* 编程应用程序以侦听事件 -* 使用 Octokit. rb 库执行 REST API 操作 +* Programming your app to listen for events +* Using the Octokit.rb library to do REST API operations {% data reusables.apps.app-ruby-guides %} -一旦完成了这些步骤，您就可以使用整套 GitHub API 开发其他类型的集成。 {% ifversion fpt or ghec %}您可以在 [GitHub Marketplace](https://github.com/marketplace) 和[使用 GitHub](https://github.com/works-with) 中查看成功的应用程序示例。{% endif %} +Once you've worked through the steps, you'll be ready to develop other kinds of integrations using the full suite of GitHub APIs. {% ifversion fpt or ghec %}You can check out successful examples of apps on [GitHub Marketplace](https://github.com/marketplace) and [Works with GitHub](https://github.com/works-with).{% endif %} -## 基本要求 +## Prerequisites -您可能会发现对以下内容有基本的了解很有帮助： +You may find it helpful to have a basic understanding of the following: -* [GitHub 应用程序](/apps/about-apps) -* [Web 挂钩](/webhooks) -* [Ruby 编程语言](https://www.ruby-lang.org/en/) -* [REST API](/rest) +* [GitHub Apps](/apps/about-apps) +* [Webhooks](/webhooks) +* [The Ruby programming language](https://www.ruby-lang.org/en/) +* [REST APIs](/rest) * [Sinatra](http://sinatrarb.com/) -但是，任何经验水平都能跟上步伐。 我们会一路提供所需信息的链接。 +But you can follow along at any experience level. We'll link out to information you need along the way! -在开始之前，您需要执行以下操作： +Before you begin, you'll need to do the following: -1. 克隆[在应用程序中使用 GitHub API](https://github.com/github-developer/using-the-github-api-in-your-app) 仓库。 +1. Clone the [Using the GitHub API in your app](https://github.com/github-developer/using-the-github-api-in-your-app) repository. ```shell $ git clone https://github.com/github-developer/using-the-github-api-in-your-app.git ``` - 在目录中，您将找到包含本快速入门将要使用的模板代码的 `template_server.rb` 文件以及包含已完成项目代码的 `server.rb` 文件。 + Inside the directory, you'll find a `template_server.rb` file with the template code you'll use in this quickstart and a `server.rb` file with the completed project code. -1. 按照“[设置开发环境](/apps/quickstart-guides/setting-up-your-development-environment/)”快速入门中的步骤来配置和运行 `template_server.rb` 应用程序服务器。 如果您以前完成了[设置开发环境](/apps/quickstart-guides/setting-up-your-development-environment/)以外的其他 GitHub 应用程序快速入门，您应该注册一个_新_ GitHub 应用程序并启动一个新 Smee 通道以用于本快速入门。 +1. Follow the steps in the [Setting up your development environment](/apps/quickstart-guides/setting-up-your-development-environment/) quickstart to configure and run the `template_server.rb` app server. If you've previously completed a GitHub App quickstart other than [Setting up your development environment](/apps/quickstart-guides/setting-up-your-development-environment/), you should register a _new_ GitHub App and start a new Smee channel to use with this quickstart. - 本快速入门包含与[设置开发环境](/apps/quickstart-guides/setting-up-your-development-environment/)快速入门相同的 `template_server.rb` 代码。 **注：**遵循[设置开发环境](/apps/quickstart-guides/setting-up-your-development-environment/)快速入门的同时，请确保使用[在应用程序中使用 GitHub API](https://github.com/github-developer/using-the-github-api-in-your-app) 仓库中包含的项目文件。 + This quickstart includes the same `template_server.rb` code as the [Setting up your development environment](/apps/quickstart-guides/setting-up-your-development-environment/) quickstart. **Note:** As you follow along with the [Setting up your development environment](/apps/quickstart-guides/setting-up-your-development-environment/) quickstart, make sure to use the project files included in the [Using the GitHub API in your app](https://github.com/github-developer/using-the-github-api-in-your-app) repository. - 如果在设置模板 GitHub 应用程序时遇到问题，请参阅[疑难解答](/apps/quickstart-guides/setting-up-your-development-environment/#troubleshooting)部分。 + See the [Troubleshooting](/apps/quickstart-guides/setting-up-your-development-environment/#troubleshooting) section if you are running into problems setting up your template GitHub App. -## 构建应用程序 +## Building the app -现在您已经熟悉了 `template_server.rb` 代码，您将创建可将 `needs-response` 标签自动添加到安装该应用程序的仓库中所有已打开议题的代码。 +Now that you're familiar with the `template_server.rb` code, you're going to create code that automatically adds the `needs-response` label to all issues opened in the repository where the app is installed. -`template_server.rb` 文件包含尚未自定义的应用程序模板代码。 在本文件中，您将看到一些用于处理 web 挂钩事件的占位符代码，以及用于初始化 Octokit.rb 客户端的一些其他代码。 +The `template_server.rb` file contains app template code that has not yet been customized. In this file, you'll see some placeholder code for handling webhook events and some other code for initializing an Octokit.rb client. {% note %} -**注：**`template_server.rb` 包含许多代码注释，可补充本指南并解释其他技术细节。 您可能会发现，在继续本节之前通读该文件中的注释以概要了解代码的工作方式，将对您大有帮助。 +**Note:** `template_server.rb` contains many code comments that complement this guide and explain additional technical details. You may find it helpful to read through the comments in that file now, before continuing with this section, to get an overview of how the code works. -您在本指南末尾创建的最终自定义代码存在于 [`server.rb`](https://github.com/github-developer/using-the-github-api-in-your-app/blob/master/server.rb) 中。 不过，尽可能等到最后再查看它吧！ +The final customized code that you'll create by the end of this guide is provided in [`server.rb`](https://github.com/github-developer/using-the-github-api-in-your-app/blob/master/server.rb). Try waiting until the end to look at it, though! {% endnote %} -以下是创建第一个 GitHub 应用程序要完成的步骤： +These are the steps you'll complete to create your first GitHub App: -1. [更新应用程序权限](#step-1-update-app-permissions) -2. [添加事件处理](#step-2-add-event-handling) -3. [创建新标签](#step-3-create-a-new-label) -4. [添加标签处理](#step-4-add-label-handling) +1. [Update app permissions](#step-1-update-app-permissions) +2. [Add event handling](#step-2-add-event-handling) +3. [Create a new label](#step-3-create-a-new-label) +4. [Add label handling](#step-4-add-label-handling) -## 步骤 1. 更新应用程序权限 +## Step 1. Update app permissions -如果您在[首次注册应用程序](/apps/quickstart-guides/setting-up-your-development-environment/#step-2-register-a-new-github-app)时接受了默认权限，则意味着您的应用程序无法访问大多数资源。 对于此示例，您的应用程序将需要读取议题和写入标签的权限。 +When you [first registered your app](/apps/quickstart-guides/setting-up-your-development-environment/#step-2-register-a-new-github-app), you accepted the default permissions, which means your app doesn't have access to most resources. For this example, your app will need permission to read issues and write labels. -要更新应用程序的权限： +To update your app's permissions: -1. 从[应用程序设置页面](https://github.com/settings/apps)选择应用程序，然后单击边栏中的 **Permissions & Webhooks（权限和 web 挂钩）**。 -1. 在“Permissions（权限）”部分，找到“Issues（议题）”，然后在其旁边的“Access（访问权限）”下拉列表中选择 **Read & write（读取和写入）**。 说明中表示，此选项将授予对议题和标签的访问权限，而这正是您所需要的。 -1. 在“Subscribe to events（订阅事件）”部分，选择 **Issues（议题）**以订阅事件。 +1. Select your app from the [app settings page](https://github.com/settings/apps) and click **Permissions & Webhooks** in the sidebar. +1. In the "Permissions" section, find "Issues," and select **Read & Write** in the "Access" dropdown next to it. The description says this option grants access to both issues and labels, which is just what you need. +1. In the "Subscribe to events" section, select **Issues** to subscribe to the event. {% data reusables.apps.accept_new_permissions_steps %} -太好了！ 您的应用程序现在有权限执行所需的任务。 现在，您可以添加代码使其正常工作。 +Great! Your app has permission to do the tasks you want it to do. Now you can add the code to make it work. -## 步骤 2. 添加事件处理 +## Step 2. Add event handling -应用程序需要做的第一件事是侦听打开的新议题。 现在您已订阅 **Issues（议题）**事件，您将开始接收 [`issues`](/webhooks/event-payloads/#issues) web 挂钩，它在某些与议题相关的操作发生时触发。 您可以根据要在代码中执行的特定操作来过滤此事件类型。 +The first thing your app needs to do is listen for new issues that are opened. Now that you've subscribed to the **Issues** event, you'll start receiving the [`issues`](/webhooks/event-payloads/#issues) webhook, which is triggered when certain issue-related actions occur. You can filter this event type for the specific action you want in your code. -GitHub 将 web 挂钩有效负载作为 `POST` 请求发送。 因为您已将 Smee web 挂钩有效负载转发到 `http://localhost/event_handler:3000`，因此您的服务器将在 `post '/event_handler'` 路由中接收 `POST` 请求有效负载。 +GitHub sends webhook payloads as `POST` requests. Because you forwarded your Smee webhook payloads to `http://localhost/event_handler:3000`, your server will receive the `POST` request payloads in the `post '/event_handler'` route. -您在[前提条件](#prerequisites)部分中下载的 `template_server.rb` 文件中已包括空 `post '/event_handler'` 路由。 空路由如下所示： +An empty `post '/event_handler'` route is already included in the `template_server.rb` file, which you downloaded in the [prerequisites](#prerequisites) section. The empty route looks like this: ``` ruby post '/event_handler' do @@ -108,7 +107,7 @@ GitHub 将 web 挂钩有效负载作为 `POST` 请求发送。 因为您已将 S end ``` -通过添加以下代码，使用此路由来处理 `issues` 事件： +Use this route to handle the `issues` event by adding the following code: ``` ruby case request.env['HTTP_X_GITHUB_EVENT'] @@ -119,9 +118,9 @@ when 'issues' end ``` -GitHub 发送的每个事件都包含一个名为 `HTTP_X_GITHUB_EVENT` 的请求标头，它指示 `POST` 请求中的事件类型。 现在，您只关注 `issues` 事件类型。 每个事件都有一个附加的 `action` 字段，它指示触发事件的操作类型。 对于 `issues`，`action` 字段可以是 `assigned`、`unassigned`、`labeled`、`unlabeled`、`opened`、`edited`、`milestoned`、`demilestoned`、`closed` 或 `reopened`。 +Every event that GitHub sends includes a request header called `HTTP_X_GITHUB_EVENT`, which indicates the type of event in the `POST` request. Right now, you're only interested in `issues` event types. Each event has an additional `action` field that indicates the type of action that triggered the events. For `issues`, the `action` field can be `assigned`, `unassigned`, `labeled`, `unlabeled`, `opened`, `edited`, `milestoned`, `demilestoned`, `closed`, or `reopened`. -要测试事件处理程序，请尝试添加临时辅助方法。 稍后将在[添加标签处理](#step-4-add-label-handling)时进行更新。 现在，在代码的 `helpers do` 部分添加以下代码。 您可以将新方法放在其他任何辅助方法的上方或下方。 顺序无关紧要。 +To test your event handler, try adding a temporary helper method. You'll update later when you [Add label handling](#step-4-add-label-handling). For now, add the following code inside the `helpers do` section of the code. You can put the new method above or below any of the other helper methods. Order doesn't matter. ``` ruby def handle_issue_opened_event(payload) @@ -129,37 +128,37 @@ def handle_issue_opened_event(payload) end ``` -此方法接收 JSON 格式的事件有效负载作为参数。 这意味着您可以解析方法中的有效负载并深入挖掘所需的任何特定数据。 您可能会发现在某个时候检查整个有效负载很有帮助：尝试将 `logger.debug 'An issue was opened!` 更改为 `logger.debug payload`。 您看到的有效负载结构应该与 [`issues` web 挂钩事件文档中显示的](/webhooks/event-payloads/#issues)结构相匹配。 +This method receives a JSON-formatted event payload as an argument. This means you can parse the payload in the method and drill down to any specific data you need. You may find it helpful to inspect the full payload at some point: try changing `logger.debug 'An issue was opened!` to `logger.debug payload`. The payload structure you see should match what's [shown in the `issues` webhook event docs](/webhooks/event-payloads/#issues). -太好了！ 是时候测试更改了。 +Great! It's time to test the changes. {% data reusables.apps.sinatra_restart_instructions %} -在浏览器中，访问安装应用程序的仓库。 在此仓库中打开一个新议题。 此议题可以谈论您喜欢的任何事情。 它仅用于测试。 +In your browser, visit the repository where you installed your app. Open a new issue in this repository. The issue can say anything you like. It's just for testing. -回头查看终端时，您应该会在输出中看到一条消息：`An issue was opened!` 恭喜！ 您已将事件处理程序添加到应用程序中。 💪 +When you look back at your Terminal, you should see a message in the output that says, `An issue was opened!` Congrats! You've added an event handler to your app. 💪 -## 步骤 3. 创建新标签 +## Step 3. Create a new label -好，您的应用程序在有议题被打开时会告诉您。 现在，您希望它将标签 `needs-response` 添加到安装该应用程序的仓库中任何新打开的议题。 +Okay, your app can tell when issues are opened. Now you want it to add the label `needs-response` to any newly opened issue in a repository the app is installed in. -将标签_添加_到任何位置之前，您需要在仓库中_创建_自定义标签。 只需要这样做一次。 就本指南而言，请在 GitHub 上手动创建标签。 在仓库中，依次单击 **Issues（议题）**、**Labels（标签）**，然后单击 **New label（新建标签）**。 将新标签命名为 `needs-response`。 +Before the label can be _added_ anywhere, you'll need to _create_ the custom label in your repository. You'll only need to do this one time. For the purposes of this guide, create the label manually on GitHub. In your repository, click **Issues**, then **Labels**, then click **New label**. Name the new label `needs-response`. {% tip %} -**提示**：如果您的应用能够以编程方式创建标签，那岂不是很棒吗？ [它能](/rest/reference/issues#create-a-label)！ 完成本指南中的步骤后，请尝试添加代码，自行实现。 +**Tip**: Wouldn't it be great if your app could create the label programmatically? [It can](/rest/reference/issues#create-a-label)! Try adding the code to do that on your own after you finish the steps in this guide. {% endtip %} -现在，标签有了，您可以对应用程序进行编程，以使用 REST API [将标签添加到任何新打开的议题中](/rest/reference/issues#add-labels-to-an-issue)。 +Now that the label exists, you can program your app to use the REST API to [add the label to any newly opened issue](/rest/reference/issues#add-labels-to-an-issue). -## 步骤 4. 添加标签处理 +## Step 4. Add label handling -恭喜！您来到了最后一步：向应用程序添加标签处理。 要完成此任务，您需要使用 [Octokit.rb Ruby 库](http://octokit.github.io/octokit.rb/)。 +Congrats—you've made it to the final step: adding label handling to your app. For this task, you'll want to use the [Octokit.rb Ruby library](http://octokit.github.io/octokit.rb/). -在 Octokit.rb 文档中，找到[标签方法](http://octokit.github.io/octokit.rb/Octokit/Client/Labels.html)列表。 您要使用的方法是 [`add_labels_to_an_issue`](http://octokit.github.io/octokit.rb/Octokit/Client/Labels.html#add_labels_to_an_issue-instance_method)。 +In the Octokit.rb docs, find the list of [label methods](http://octokit.github.io/octokit.rb/Octokit/Client/Labels.html). The method you'll want to use is [`add_labels_to_an_issue`](http://octokit.github.io/octokit.rb/Octokit/Client/Labels.html#add_labels_to_an_issue-instance_method). -回到 `template_server.rb`，找到您以前定义的方法： +Back in `template_server.rb`, find the method you defined previously: ``` ruby def handle_issue_opened_event(payload) @@ -167,13 +166,13 @@ def handle_issue_opened_event(payload) end ``` -[`add_labels_to_an_issue`](http://octokit.github.io/octokit.rb/Octokit/Client/Labels.html#add_labels_to_an_issue-instance_method) 文档显示您需要向此方法传递三个参数： +The [`add_labels_to_an_issue`](http://octokit.github.io/octokit.rb/Octokit/Client/Labels.html#add_labels_to_an_issue-instance_method) docs show you'll need to pass three arguments to this method: -* 仓库（`"owner/name"` 格式的字符串） -* 议题编号（整数） -* 标签（数组） +* Repo (string in `"owner/name"` format) +* Issue number (integer) +* Labels (array) -您可以解析有效负载以获取仓库和议题编号。 由于标签名称始终相同 (`needs-response`)，因此可以在标签数组中作为硬编码字符串传递它。 将这些片段放在一起，更新后的方法可能如下所示： +You can parse the payload to get both the repo and the issue number. Since the label name will always be the same (`needs-response`), you can pass it as a hardcoded string in the labels array. Putting these pieces together, your updated method might look like this: ``` ruby # When an issue is opened, add a label @@ -184,56 +183,56 @@ def handle_issue_opened_event(payload) end ``` -尝试在测试仓库中打开一个新议题，看看会发生什么！ 如果没有任何反应，请尝试刷新。 +Try opening a new issue in your test repository and see what happens! If nothing happens right away, try refreshing. -在终端中看不到太多信息，_但是_您应该看到机器人用户已向该议题添加了标签。 +You won't see much in the Terminal, _but_ you should see that a bot user has added a label to the issue. {% note %} -**注：**当 GitHub 应用程序通过 API 执行操作（例如添加标签）时，GitHub 会显示这些操作由_机器人_帐户执行。 更多信息请参阅“[机器与机器人帐户](/apps/differences-between-apps/#machine-vs-bot-accounts)”。 +**Note:** When GitHub Apps take actions via the API, such as adding labels, GitHub shows these actions as being performed by _bot_ accounts. For more information, see "[Machine vs. bot accounts](/apps/differences-between-apps/#machine-vs-bot-accounts)." {% endnote %} -如果是，恭喜！ 您已成功构建了一个可正常工作的应用程序！ 🎉 +If so, congrats! You've successfully built a working app! 🎉 -您可以在[应用程序模板仓库](https://github.com/github-developer/using-the-github-api-in-your-app)的 `server.rb` 中查看最终代码。 +You can see the final code in `server.rb` in the [app template repository](https://github.com/github-developer/using-the-github-api-in-your-app). -有关接下来可以做什么的想法，请参阅“[后续步骤](#next-steps)”。 +See "[Next steps](#next-steps)" for ideas about where you can go from here. -## 疑难解答 +## Troubleshooting -以下是一些常见问题和一些建议的解决方案。 如果您遇到任何其他问题，可以在 {% data variables.product.prodname_support_forum_with_url %} 中寻求帮助或建议。 +Here are a few common problems and some suggested solutions. If you run into any other trouble, you can ask for help or advice in the {% data variables.product.prodname_support_forum_with_url %}. -* **问：**我的服务器没有侦听事件！ Smee 客户端在终端窗口中运行，我通过打开新议题在 GitHub.com 上发送事件，但是在运行服务器的终端窗口中没有看到任何输出。 +* **Q:** My server isn't listening to events! The Smee client is running in a Terminal window, and I'm sending events on GitHub.com by opening new issues, but I don't see any output in the Terminal window where I'm running the server. - **答：**您的应用程序设置中可能没有正确的 Smee 域。 访问[应用程序设置页面](https://github.com/settings/apps)，然后双击“[使用 GitHub 注册新应用程序](/apps/quickstart-guides/setting-up-your-development-environment/#step-2-register-a-new-github-app)”中显示的的字段。 确保这些字段中的域与您在“[启动新的 Smee 通道](/apps/quickstart-guides/setting-up-your-development-environment/#step-1-start-a-new-smee-channel)”中的 `smee -u ` 命令中使用的域相匹配。 + **A:** You may not have the correct Smee domain in your app settings. Visit your [app settings page](https://github.com/settings/apps) and double-check the fields shown in "[Register a new app with GitHub](/apps/quickstart-guides/setting-up-your-development-environment/#step-2-register-a-new-github-app)." Make sure the domain in those fields matches the domain you used in your `smee -u ` command in "[Start a new Smee channel](/apps/quickstart-guides/setting-up-your-development-environment/#step-1-start-a-new-smee-channel)." -* **问：**我的应用程序无法正常工作！ 我打开了一个新议题，但是即使刷新后也没有给它添加标签。 +* **Q:** My app doesn't work! I opened a new issue, but even after refreshing, no label has been added to it. - **答：**请确保满足以下所有条件： + **A:** Make sure all of the following are true: - * 您在打开议题的仓库中[安装了应用程序](/apps/quickstart-guides/setting-up-your-development-environment/#step-7-install-the-app-on-your-account)。 - * 您的 [Smee 客户端正在终端窗口中运行](/apps/quickstart-guides/setting-up-your-development-environment/#step-1-start-a-new-smee-channel)。 - * 您的 [web 服务器](/apps/quickstart-guides/setting-up-your-development-environment/#step-6-start-the-server)能够在其他终端窗口中无错误运行。 - * 您的应用程序具有[对议题的读取和写入权限并且订阅了议题事件](/apps/quickstart-guides/setting-up-your-development-environment/#step-1-start-a-new-smee-channel)。 - * 您在更新权限后[检查了电子邮件](#step-1-update-app-permissions)并接受了新权限。 + * You [installed the app](/apps/quickstart-guides/setting-up-your-development-environment/#step-7-install-the-app-on-your-account) on the repository where you're opening the issue. + * Your [Smee client is running](/apps/quickstart-guides/setting-up-your-development-environment/#step-1-start-a-new-smee-channel) in a Terminal window. + * Your [web server is running](/apps/quickstart-guides/setting-up-your-development-environment/#step-6-start-the-server) with no errors in another Terminal window. + * Your app has [read & write permissions on issues and is subscribed to issue events](/apps/quickstart-guides/setting-up-your-development-environment/#step-1-start-a-new-smee-channel). + * You [checked your email](#step-1-update-app-permissions) after updating the permissions and accepted the new permissions. -## 结论 +## Conclusion -完成本指南后，您已了解开发 GitHub 应用程序的基本构建块！ 回顾一下： +After walking through this guide, you've learned the basic building blocks for developing GitHub Apps! To review, you: -* 编程应用程序以侦听事件 -* 使用 Octokit. rb 库执行 REST API 操作 +* Programmed your app to listen for events +* Used the Octokit.rb library to do REST API operations -## 后续步骤 +## Next steps -以下是有关接下来可以做什么的一些想法： +Here are some ideas for what you can do next: -* [使用 GraphQL 重写应用程序](https://developer.github.com/changes/2018-04-30-graphql-supports-github-apps/)！ -* 使用 [Probot](https://github.com/probot/probot) 在 Node.js 中重写应用程序！ -* 让应用程序检查议题上是否存在 `needs-response` 标签，如果否，则添加它。 -* 当机器人成功添加标签时，在终端中显示消息。 （提示：将 `needs-response` 标签 ID 与有效负载中的标签 ID 进行比较，以作为显示消息的条件，这样只有在添加相关标签时才显示消息。） -* 向应用程序添加登录页面并为它连接 [Sinatra 路由](https://github.com/sinatra/sinatra#routes)。 -* 将代码移动到托管服务器（如 Heroku）。 不要忘记使用新域更新应用程序设置。 -* 在 {% data variables.product.prodname_support_forum_with_url %}{% ifversion fpt or ghec %} 中分享项目或寻求建议 -* 您是否构建了一款让人眼前一亮的新应用程序？您认为它可能对其他人有帮助？ [将其添加到 GitHub Marketplace](/apps/marketplace/creating-and-submitting-your-app-for-approval/)！{% endif %} +* [Rewrite your app using GraphQL](https://developer.github.com/changes/2018-04-30-graphql-supports-github-apps/)! +* Rewrite your app in Node.js using [Probot](https://github.com/probot/probot)! +* Have the app check whether the `needs-response` label already exists on the issue, and if not, add it. +* When the bot successfully adds the label, show a message in the Terminal. (Hint: compare the `needs-response` label ID with the ID of the label in the payload as a condition for your message, so that the message only displays when the relevant label is added and not some other label.) +* Add a landing page to your app and hook up a [Sinatra route](https://github.com/sinatra/sinatra#routes) for it. +* Move your code to a hosted server (like Heroku). Don't forget to update your app settings with the new domain. +* Share your project or get advice in the {% data variables.product.prodname_support_forum_with_url %}{% ifversion fpt or ghec %} +* Have you built a shiny new app you think others might find useful? [Add it to GitHub Marketplace](/apps/marketplace/creating-and-submitting-your-app-for-approval/)!{% endif %} diff --git a/translations/zh-CN/content/developers/apps/index.md b/translations/zh-CN/content/developers/apps/index.md index 441511c065..30fe7ff44f 100644 --- a/translations/zh-CN/content/developers/apps/index.md +++ b/translations/zh-CN/content/developers/apps/index.md @@ -1,12 +1,12 @@ --- -title: 应用 -intro: 您可以通过构建自己的应用程序来自动化和简化工作流程。 +title: Apps +intro: You can automate and streamline your workflow by building your own apps. redirect_from: - - /early-access/integrations/ - - /early-access/integrations/authentication/ - - /early-access/integrations/install-an-integration/ - - /apps/adding-integrations/ - - /apps/building-integrations/setting-up-a-new-integration/about-integrations/ + - /early-access/integrations + - /early-access/integrations/authentication + - /early-access/integrations/install-an-integration + - /apps/adding-integrations + - /apps/building-integrations/setting-up-a-new-integration/about-integrations - /apps - /v3/integrations versions: diff --git a/translations/zh-CN/content/developers/apps/managing-github-apps/deleting-a-github-app.md b/translations/zh-CN/content/developers/apps/managing-github-apps/deleting-a-github-app.md index 4d031ca0e9..5c9cdb43cf 100644 --- a/translations/zh-CN/content/developers/apps/managing-github-apps/deleting-a-github-app.md +++ b/translations/zh-CN/content/developers/apps/managing-github-apps/deleting-a-github-app.md @@ -1,8 +1,8 @@ --- -title: 删除 GitHub 应用程序 +title: Deleting a GitHub App intro: '{% data reusables.shortdesc.deleting_github_apps %}' redirect_from: - - /apps/building-integrations/managing-github-apps/deleting-a-github-app/ + - /apps/building-integrations/managing-github-apps/deleting-a-github-app - /apps/managing-github-apps/deleting-a-github-app - /developers/apps/deleting-a-github-app versions: @@ -13,12 +13,15 @@ versions: topics: - GitHub Apps --- - {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} -4. 选择要删除的 GitHub 应用程序。 ![应用程序选择](/assets/images/github-apps/github_apps_select-app.png) +4. Select the GitHub App you want to delete. +![App selection](/assets/images/github-apps/github_apps_select-app.png) {% data reusables.user-settings.github_apps_advanced %} -6. 单击 **Delete GitHub App（删除 GitHub 应用程序）**。 ![删除 GitHub 应用程序的按钮](/assets/images/github-apps/github_apps_delete.png) -7. 输入 GitHub 应用程序的名称以确认您要删除它。 ![确认要删除的 GitHub 应用程序名称的字段](/assets/images/github-apps/github_apps_delete_integration_name.png) -8. 单击 **I understand the consequences, delete this GitHub App（我了解后果，删除此 GitHub 应用程序）**。 ![确认删除 GitHub 应用程序的按钮](/assets/images/github-apps/github_apps_confirm_deletion.png) +6. Click **Delete GitHub App**. +![Button to delete a GitHub App](/assets/images/github-apps/github_apps_delete.png) +7. Type the name of the GitHub App to confirm you want to delete it. +![Field to confirm the name of the GitHub App you want to delete](/assets/images/github-apps/github_apps_delete_integration_name.png) +8. Click **I understand the consequences, delete this GitHub App**. +![Button to confirm the deletion of your GitHub App](/assets/images/github-apps/github_apps_confirm_deletion.png) diff --git a/translations/zh-CN/content/developers/apps/managing-github-apps/editing-a-github-apps-permissions.md b/translations/zh-CN/content/developers/apps/managing-github-apps/editing-a-github-apps-permissions.md index f24cc5b06b..3d9e709d77 100644 --- a/translations/zh-CN/content/developers/apps/managing-github-apps/editing-a-github-apps-permissions.md +++ b/translations/zh-CN/content/developers/apps/managing-github-apps/editing-a-github-apps-permissions.md @@ -1,8 +1,8 @@ --- -title: 编辑 GitHub 应用程序的权限 +title: Editing a GitHub App's permissions intro: '{% data reusables.shortdesc.editing_permissions_for_github_apps %}' redirect_from: - - /apps/building-integrations/managing-github-apps/editing-a-github-app-s-permissions/ + - /apps/building-integrations/managing-github-apps/editing-a-github-app-s-permissions - /apps/managing-github-apps/editing-a-github-app-s-permissions - /developers/apps/editing-a-github-apps-permissions versions: @@ -12,21 +12,26 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 编辑权限 +shortTitle: Edit permissions --- - {% note %} -**注：**在帐户或组织的所有者批准更改之前，更新的权限不会对安装设施生效。 您可以使用 [InstallationEvent web 挂钩](/webhooks/event-payloads/#installation)了解用户何时接受应用程序的新权限。 [用户级权限](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-level-permissions)是一个例外，它不需要帐户所有者批准权限更改。 +**Note:** Updated permissions won't take effect on an installation until the owner of the account or organization approves the changes. You can use the [InstallationEvent webhook](/webhooks/event-payloads/#installation) to find out when people accept new permissions for your app. One exception is [user-level permissions](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-level-permissions), which don't require the account owner to approve permission changes. {% endnote %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} -4. 选择要更改其权限的 GitHub 应用程序。 ![应用程序选择](/assets/images/github-apps/github_apps_select-app.png) -5. 在左侧栏中，单击 **Permissions & webhooks（权限和 web 挂钩）**。 ![权限和 web 挂钩](/assets/images/github-apps/github_apps_permissions_and_webhooks.png) -6. 修改要更改的权限。 对于每种类型的权限，从下拉列表中选择“Read-only（只读）”、“Read & write（读写）”或“No access（无访问权限）”。 ![GitHub 应用程序的权限选择](/assets/images/github-apps/github_apps_permissions_post2dot13.png) -7. 在“Subscribe to events（订阅事件）”中，选择应用程序要订阅的任何事件。 ![GitHub 应用程序订阅事件的权限选择](/assets/images/github-apps/github_apps_permissions_subscribe_to_events.png) -8. （可选）在“Add a note to users（向用户添加注释）”中，添加注释，告诉用户为什么要更改 GitHub 应用程序请求的权限。 ![用于向用户添加注释以解释 GitHub 应用程序权限更改原因的输入框](/assets/images/github-apps/github_apps_permissions_note_to_users.png) -9. 单击 **Save changes（保存更改）**。 ![保存权限更改的按钮](/assets/images/github-apps/github_apps_save_changes.png) +4. Select the GitHub App whose permissions you want to change. +![App selection](/assets/images/github-apps/github_apps_select-app.png) +5. In the left sidebar, click **Permissions & webhooks**. +![Permissions and webhooks](/assets/images/github-apps/github_apps_permissions_and_webhooks.png) +6. Modify the permissions you'd like to change. For each type of permission, select either "Read-only", "Read & write", or "No access" from the dropdown. +![Permissions selections for your GitHub App](/assets/images/github-apps/github_apps_permissions_post2dot13.png) +7. In "Subscribe to events", select any events to which you'd like to subscribe your app. +![Permissions selections for subscribing your GitHub App to events](/assets/images/github-apps/github_apps_permissions_subscribe_to_events.png) +8. Optionally, in "Add a note to users", add a note telling your users why you are changing the permissions that your GitHub App requests. +![Input box to add a note to users explaining why your GitHub App permissions have changed](/assets/images/github-apps/github_apps_permissions_note_to_users.png) +9. Click **Save changes**. +![Button to save permissions changes](/assets/images/github-apps/github_apps_save_changes.png) diff --git a/translations/zh-CN/content/developers/apps/managing-github-apps/index.md b/translations/zh-CN/content/developers/apps/managing-github-apps/index.md index 9eb138542f..718fa7bb8f 100644 --- a/translations/zh-CN/content/developers/apps/managing-github-apps/index.md +++ b/translations/zh-CN/content/developers/apps/managing-github-apps/index.md @@ -1,8 +1,8 @@ --- -title: 管理 GitHub 应用程序 -intro: 创建并注册 GitHub 应用程序后，您可以修改应用程序、更改权限、转让所有权和删除应用程序。 +title: Managing GitHub Apps +intro: 'After you create and register a GitHub App, you can make modifications to the app, change permissions, transfer ownership, and delete the app.' redirect_from: - - /apps/building-integrations/managing-github-apps/ + - /apps/building-integrations/managing-github-apps - /apps/managing-github-apps versions: fpt: '*' diff --git a/translations/zh-CN/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md b/translations/zh-CN/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md index c8409c004a..2955f8e8c0 100644 --- a/translations/zh-CN/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md +++ b/translations/zh-CN/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md @@ -2,10 +2,10 @@ title: Making a GitHub App public or private intro: '{% data reusables.shortdesc.making-a-github-app-public-or-private %}' redirect_from: - - /apps/building-integrations/setting-up-and-registering-github-apps/about-installation-options-for-github-apps/ - - /apps/building-github-apps/installation-options-for-github-apps/ - - /apps/building-integrations/managing-github-apps/changing-a-github-app-s-installation-option/ - - /apps/managing-github-apps/changing-a-github-app-s-installation-option/ + - /apps/building-integrations/setting-up-and-registering-github-apps/about-installation-options-for-github-apps + - /apps/building-github-apps/installation-options-for-github-apps + - /apps/building-integrations/managing-github-apps/changing-a-github-app-s-installation-option + - /apps/managing-github-apps/changing-a-github-app-s-installation-option - /apps/managing-github-apps/making-a-github-app-public-or-private - /developers/apps/making-a-github-app-public-or-private versions: diff --git a/translations/zh-CN/content/developers/apps/managing-github-apps/modifying-a-github-app.md b/translations/zh-CN/content/developers/apps/managing-github-apps/modifying-a-github-app.md index da4a1b93ed..48fc1ccfb1 100644 --- a/translations/zh-CN/content/developers/apps/managing-github-apps/modifying-a-github-app.md +++ b/translations/zh-CN/content/developers/apps/managing-github-apps/modifying-a-github-app.md @@ -1,8 +1,8 @@ --- -title: 修改 GitHub 应用程序 +title: Modifying a GitHub App intro: '{% data reusables.shortdesc.modifying_github_apps %}' redirect_from: - - /apps/building-integrations/managing-github-apps/modifying-a-github-app/ + - /apps/building-integrations/managing-github-apps/modifying-a-github-app - /apps/managing-github-apps/modifying-a-github-app - /developers/apps/modifying-a-github-app versions: @@ -13,10 +13,11 @@ versions: topics: - GitHub Apps --- - {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} {% data reusables.user-settings.modify_github_app %} -5. 在“Basic information（基本信息）”中，修改您要更改的 GitHub 应用程序信息。 ![GitHub 应用程序的基本信息部分](/assets/images/github-apps/github_apps_basic_information.png) -6. 单击 **Save changes（保存更改）**。 ![保存 GitHub 应用程序更改的按钮](/assets/images/github-apps/github_apps_save_changes.png) +5. In "Basic information", modify the GitHub App information that you'd like to change. +![Basic information section for your GitHub App](/assets/images/github-apps/github_apps_basic_information.png) +6. Click **Save changes**. +![Button to save changes for your GitHub App](/assets/images/github-apps/github_apps_save_changes.png) diff --git a/translations/zh-CN/content/developers/apps/managing-github-apps/transferring-ownership-of-a-github-app.md b/translations/zh-CN/content/developers/apps/managing-github-apps/transferring-ownership-of-a-github-app.md index ef07b69f00..4bbe104d16 100644 --- a/translations/zh-CN/content/developers/apps/managing-github-apps/transferring-ownership-of-a-github-app.md +++ b/translations/zh-CN/content/developers/apps/managing-github-apps/transferring-ownership-of-a-github-app.md @@ -1,8 +1,8 @@ --- -title: 转让 GitHub 应用程序的所有权 +title: Transferring ownership of a GitHub App intro: '{% data reusables.shortdesc.transferring_ownership_of_github_apps %}' redirect_from: - - /apps/building-integrations/managing-github-apps/transferring-ownership-of-a-github-app/ + - /apps/building-integrations/managing-github-apps/transferring-ownership-of-a-github-app - /apps/managing-github-apps/transferring-ownership-of-a-github-app - /developers/apps/transferring-ownership-of-a-github-app versions: @@ -12,15 +12,19 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 转移所有权 +shortTitle: Transfer ownership --- - {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} -4. 选择要转让其所有权的 GitHub 应用程序。 ![应用程序选择](/assets/images/github-apps/github_apps_select-app.png) +4. Select the GitHub App whose ownership you want to transfer. +![App selection](/assets/images/github-apps/github_apps_select-app.png) {% data reusables.user-settings.github_apps_advanced %} -6. 单击 **Transfer ownership（转让所有权）**。 ![转让所有权的按钮](/assets/images/github-apps/github_apps_transfer_ownership.png) -7. 输入要转让的 GitHub 应用程序的名称。 ![输入要转让的应用程序名称的字段](/assets/images/github-apps/github_apps_transfer_app_name.png) -8. 输入要将 GitHub 应用程序转让到的用户或组织的名称。 ![输入要转让到的用户或组织的字段](/assets/images/github-apps/github_apps_transfer_new_owner.png) -9. 单击 **Transfer this GitHub App（转让此 GitHub 应用程序）**。 ![确认转让 GitHub 应用程序的按钮](/assets/images/github-apps/github_apps_transfer_integration.png) +6. Click **Transfer ownership**. +![Button to transfer ownership](/assets/images/github-apps/github_apps_transfer_ownership.png) +7. Type the name of the GitHub App you want to transfer. +![Field to enter the name of the app to transfer](/assets/images/github-apps/github_apps_transfer_app_name.png) +8. Type the name of the user or organization you want to transfer the GitHub App to. +![Field to enter the user or org to transfer to](/assets/images/github-apps/github_apps_transfer_new_owner.png) +9. Click **Transfer this GitHub App**. +![Button to confirm the transfer of a GitHub App](/assets/images/github-apps/github_apps_transfer_integration.png) diff --git a/translations/zh-CN/content/developers/apps/managing-oauth-apps/deleting-an-oauth-app.md b/translations/zh-CN/content/developers/apps/managing-oauth-apps/deleting-an-oauth-app.md index 413ad8a326..26affcb17f 100644 --- a/translations/zh-CN/content/developers/apps/managing-oauth-apps/deleting-an-oauth-app.md +++ b/translations/zh-CN/content/developers/apps/managing-oauth-apps/deleting-an-oauth-app.md @@ -1,8 +1,8 @@ --- -title: 删除 OAuth 应用程序 +title: Deleting an OAuth App intro: '{% data reusables.shortdesc.deleting_oauth_apps %}' redirect_from: - - /apps/building-integrations/managing-oauth-apps/deleting-an-oauth-app/ + - /apps/building-integrations/managing-oauth-apps/deleting-an-oauth-app - /apps/managing-oauth-apps/deleting-an-oauth-app - /developers/apps/deleting-an-oauth-app versions: @@ -13,10 +13,12 @@ versions: topics: - OAuth Apps --- - {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %} -4. 选择要修改的 {% data variables.product.prodname_oauth_app %} 。 ![应用程序选择](/assets/images/oauth-apps/oauth_apps_choose_app_post2dot12.png) -5. 单击 **Delete application（删除应用程序）**。 ![删除应用程序的按钮](/assets/images/oauth-apps/oauth_apps_delete_application.png) -6. 单击 **Delete this OAuth Application（删除此 OAuth 应用程序）**。 ![确认删除的按钮](/assets/images/oauth-apps/oauth_apps_delete_confirm.png) +4. Select the {% data variables.product.prodname_oauth_app %} you want to modify. +![App selection](/assets/images/oauth-apps/oauth_apps_choose_app_post2dot12.png) +5. Click **Delete application**. +![Button to delete the application](/assets/images/oauth-apps/oauth_apps_delete_application.png) +6. Click **Delete this OAuth Application**. +![Button to confirm the deletion](/assets/images/oauth-apps/oauth_apps_delete_confirm.png) diff --git a/translations/zh-CN/content/developers/apps/managing-oauth-apps/index.md b/translations/zh-CN/content/developers/apps/managing-oauth-apps/index.md index ffce55c987..5a40c83444 100644 --- a/translations/zh-CN/content/developers/apps/managing-oauth-apps/index.md +++ b/translations/zh-CN/content/developers/apps/managing-oauth-apps/index.md @@ -1,8 +1,8 @@ --- -title: 管理 OAuth 应用程序 -intro: 创建并注册 OAuth 应用程序后，您可以修改应用程序、更改权限、转让所有权和删除应用程序。 +title: Managing OAuth Apps +intro: 'After you create and register an OAuth App, you can make modifications to the app, change permissions, transfer ownership, and delete the app.' redirect_from: - - /apps/building-integrations/managing-oauth-apps/ + - /apps/building-integrations/managing-oauth-apps - /apps/managing-oauth-apps versions: fpt: '*' diff --git a/translations/zh-CN/content/developers/apps/managing-oauth-apps/modifying-an-oauth-app.md b/translations/zh-CN/content/developers/apps/managing-oauth-apps/modifying-an-oauth-app.md index 4fb01dff58..c6196ae921 100644 --- a/translations/zh-CN/content/developers/apps/managing-oauth-apps/modifying-an-oauth-app.md +++ b/translations/zh-CN/content/developers/apps/managing-oauth-apps/modifying-an-oauth-app.md @@ -1,8 +1,8 @@ --- -title: 修改 OAuth 应用程序 +title: Modifying an OAuth App intro: '{% data reusables.shortdesc.modifying_oauth_apps %}' redirect_from: - - /apps/building-integrations/managing-oauth-apps/modifying-an-oauth-app/ + - /apps/building-integrations/managing-oauth-apps/modifying-an-oauth-app - /apps/managing-oauth-apps/modifying-an-oauth-app - /developers/apps/modifying-an-oauth-app versions: @@ -13,10 +13,9 @@ versions: topics: - OAuth Apps --- - {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %} {% data reusables.user-settings.modify_oauth_app %} -1. 修改您想要更改的 {% data variables.product.prodname_oauth_app %} 信息。 +1. Modify the {% data variables.product.prodname_oauth_app %} information that you'd like to change. {% data reusables.user-settings.update_oauth_app %} diff --git a/translations/zh-CN/content/developers/apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app.md b/translations/zh-CN/content/developers/apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app.md index 3a05e6580f..975ec5bafb 100644 --- a/translations/zh-CN/content/developers/apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app.md +++ b/translations/zh-CN/content/developers/apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app.md @@ -1,8 +1,8 @@ --- -title: 转让 OAuth 应用程序的所有权 +title: Transferring ownership of an OAuth App intro: '{% data reusables.shortdesc.transferring_ownership_of_oauth_apps %}' redirect_from: - - /apps/building-integrations/managing-oauth-apps/transferring-ownership-of-an-oauth-app/ + - /apps/building-integrations/managing-oauth-apps/transferring-ownership-of-an-oauth-app - /apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app - /developers/apps/transferring-ownership-of-an-oauth-app versions: @@ -12,14 +12,18 @@ versions: ghec: '*' topics: - OAuth Apps -shortTitle: 转移所有权 +shortTitle: Transfer ownership --- - {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %} -4. 选择要修改的 {% data variables.product.prodname_oauth_app %} 。 ![应用程序选择](/assets/images/oauth-apps/oauth_apps_choose_app_post2dot12.png) -5. 单击 **Transfer ownership（转让所有权）**。 ![转让所有权的按钮](/assets/images/oauth-apps/oauth_apps_transfer_ownership.png) -6. 输入要转让的 {% data variables.product.prodname_oauth_app %} 的名称。 ![输入要转让的应用程序名称的字段](/assets/images/oauth-apps/oauth_apps_transfer_oauth_name.png) -7. 输入要将 {% data variables.product.prodname_oauth_app %} 转让到的用户或组织的名称。 ![输入要转让到的用户或组织的字段](/assets/images/oauth-apps/oauth_apps_transfer_new_owner.png) -8. 单击 **Transfer this application（转让此应用程序）**。 ![转让应用程序的按钮](/assets/images/oauth-apps/oauth_apps_transfer_application.png) +4. Select the {% data variables.product.prodname_oauth_app %} you want to modify. +![App selection](/assets/images/oauth-apps/oauth_apps_choose_app_post2dot12.png) +5. Click **Transfer ownership**. +![Button to transfer ownership](/assets/images/oauth-apps/oauth_apps_transfer_ownership.png) +6. Type the name of the {% data variables.product.prodname_oauth_app %} you want to transfer. +![Field to enter the name of the app to transfer](/assets/images/oauth-apps/oauth_apps_transfer_oauth_name.png) +7. Type the name of the user or organization you want to transfer the {% data variables.product.prodname_oauth_app %} to. +![Field to enter the user or org to transfer to](/assets/images/oauth-apps/oauth_apps_transfer_new_owner.png) +8. Click **Transfer this application**. +![Button to transfer the application](/assets/images/oauth-apps/oauth_apps_transfer_application.png) diff --git a/translations/zh-CN/content/developers/apps/managing-oauth-apps/troubleshooting-authorization-request-errors.md b/translations/zh-CN/content/developers/apps/managing-oauth-apps/troubleshooting-authorization-request-errors.md index ab29454b66..ce44a8e347 100644 --- a/translations/zh-CN/content/developers/apps/managing-oauth-apps/troubleshooting-authorization-request-errors.md +++ b/translations/zh-CN/content/developers/apps/managing-oauth-apps/troubleshooting-authorization-request-errors.md @@ -1,8 +1,8 @@ --- -title: 排查授权请求错误 +title: Troubleshooting authorization request errors intro: '{% data reusables.shortdesc.troubleshooting_authorization_request_errors_oauth_apps %}' redirect_from: - - /apps/building-integrations/managing-oauth-apps/troubleshooting-authorization-request-errors/ + - /apps/building-integrations/managing-oauth-apps/troubleshooting-authorization-request-errors - /apps/managing-oauth-apps/troubleshooting-authorization-request-errors - /developers/apps/troubleshooting-authorization-request-errors versions: @@ -12,38 +12,42 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 故障排除授权 +shortTitle: Troubleshoot authorization --- +## Application suspended -## 应用程序已挂起 - -如果您设置的 OAuth 应用程序已挂起（由于报告的滥用、垃圾邮件或 API 使用不当），GitHub 将使用以下参数重定向到注册的回调 URL 以总结错误： +If the OAuth App you set up has been suspended (due to reported abuse, spam, or a mis-use of the API), GitHub will redirect to the registered callback URL using the following parameters to summarize the error: http://your-application.com/callback?error=application_suspended &error_description=Your+application+has+been+suspended.+Contact+support@github.com. &error_uri=/apps/building-integrations/setting-up-and-registering-oauth-apps/troubleshooting-authorization-request-errors/%23application-suspended &state=xyz -要解决已挂起应用程序的问题，请联系 {% data variables.contact.contact_support %}。 +To solve issues with suspended applications, please contact {% data variables.contact.contact_support %}. -## 重定向 URI 不匹配 +## Redirect URI mismatch -如果您提供的 `redirect_uri` 与您在应用程序中注册的 URL 不匹配，GitHub 将使用以下参数重定向到注册的回调 URL 以总结错误： +If you provide a `redirect_uri` that doesn't match what you've registered with your application, GitHub will redirect to the registered callback URL with the following parameters summarizing the error: http://your-application.com/callback?error=redirect_uri_mismatch &error_description=The+redirect_uri+MUST+match+the+registered+callback+URL+for+this+application. &error_uri=/apps/building-integrations/setting-up-and-registering-oauth-apps/troubleshooting-authorization-request-errors/%23redirect-uri-mismatch &state=xyz -要更正此错误，请提供一个与您注册的 URL 匹配的 `redirect_uri`，或者忽略此参数以使用在应用程序中注册的默认 URL。 +To correct this error, either provide a `redirect_uri` that matches what you registered or leave out this parameter to use the default one registered with your application. -### 访问被拒绝 +### Access denied -如果用户拒绝访问您的应用程序，GitHub 将使用以下参数重定向到注册的回调 URL 以总结错误： +If the user rejects access to your application, GitHub will redirect to +the registered callback URL with the following parameters summarizing +the error: http://your-application.com/callback?error=access_denied &error_description=The+user+has+denied+your+application+access. &error_uri=/apps/building-integrations/setting-up-and-registering-oauth-apps/troubleshooting-authorization-request-errors/%23access-denied &state=xyz -在这方面您无能为力，因为用户可以自由选择不使用您的应用程序。 通常，用户只是关闭窗口或在浏览器中按返回按钮，所以您可能永远不会看到此错误。 +There's nothing you can do here as users are free to choose not to use +your application. More often than not, users will just close the window +or press back in their browser, so it is likely that you'll never see +this error. diff --git a/translations/zh-CN/content/developers/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors.md b/translations/zh-CN/content/developers/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors.md index 2b3ada7b41..5dc9f10a8b 100644 --- a/translations/zh-CN/content/developers/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors.md +++ b/translations/zh-CN/content/developers/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors.md @@ -1,8 +1,8 @@ --- -title: 排查 OAuth 应用程序访问令牌请求错误 +title: Troubleshooting OAuth App access token request errors intro: '{% data reusables.shortdesc.troubleshooting_access_token_reques_errors_oauth_apps %}' redirect_from: - - /apps/building-integrations/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors/ + - /apps/building-integrations/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors - /apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors - /developers/apps/troubleshooting-oauth-app-access-token-request-errors versions: @@ -12,18 +12,18 @@ versions: ghec: '*' topics: - OAuth Apps -shortTitle: 令牌请求疑难解答 +shortTitle: Troubleshoot token request --- - {% note %} -**注：**这些示例仅显示 JSON 响应。 +**Note:** These examples only show JSON responses. {% endnote %} -## 客户端凭据不正确 +## Incorrect client credentials -如果您传递的 client\_id 和/或 client\_secret 不正确，您将收到此错误响应。 +If the client\_id and or client\_secret you pass are incorrect you will +receive this error response. ```json { @@ -33,11 +33,12 @@ shortTitle: 令牌请求疑难解答 } ``` -要解决此错误，请确保您拥有 {% data variables.product.prodname_oauth_app %} 的正确凭据。 仔细检查 `client_id` 和 `client_secret` 以确保它们正确无误并且正确地传递到 {% data variables.product.product_name %}。 +To solve this error, make sure you have the correct credentials for your {% data variables.product.prodname_oauth_app %}. Double check the `client_id` and `client_secret` to make sure they are correct and being passed correctly +to {% data variables.product.product_name %}. -## 重定向 URI 不匹配 +## Redirect URI mismatch -如果您提供的 `redirect_uri` 与您在 {% data variables.product.prodname_oauth_app %} 中注册的 URL 不匹配，您将收到此错误消息： +If you provide a `redirect_uri` that doesn't match what you've registered with your {% data variables.product.prodname_oauth_app %}, you'll receive this error message: ```json { @@ -47,9 +48,11 @@ shortTitle: 令牌请求疑难解答 } ``` -要更正此错误，请提供一个与您注册的 URL 匹配的 `redirect_uri`，或者忽略此参数以使用在应用程序中注册的默认 URL。 +To correct this error, either provide a `redirect_uri` that matches what +you registered or leave out this parameter to use the default one +registered with your application. -## 验证码错误 +## Bad verification code ```json { @@ -60,7 +63,9 @@ shortTitle: 令牌请求疑难解答 } ``` -如果您传递的验证码不正确、已过期或与您在第一次授权请求中收到的验证码不匹配，您将收到此错误。 +If the verification code you pass is incorrect, expired, or doesn't +match what you received in the first request for authorization you will +receive this error. ```json { @@ -70,4 +75,5 @@ shortTitle: 令牌请求疑难解答 } ``` -要解决此错误，请再次启动 [OAuth 授权流程](/apps/building-oauth-apps/authorizing-oauth-apps/)并获取新代码。 +To solve this error, start the [OAuth authorization process again](/apps/building-oauth-apps/authorizing-oauth-apps/) +and get a new code. diff --git a/translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md b/translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md index b3561fbe98..4a6292a7c8 100644 --- a/translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md +++ b/translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md @@ -1,12 +1,12 @@ --- -title: 上架应用程序的要求 -intro: '{% data variables.product.prodname_marketplace %} 上的应用程序必须满足本页列出的要求才能发布上架。' +title: Requirements for listing an app +intro: 'Apps on {% data variables.product.prodname_marketplace %} must meet the requirements outlined on this page before the listing can be published.' redirect_from: - - /apps/adding-integrations/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace/ - - /apps/marketplace/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace/ - - /apps/marketplace/getting-started-with-github-marketplace-listings/requirements-for-listing-an-app-on-github-marketplace/ - - /apps/marketplace/creating-and-submitting-your-app-for-approval/requirements-for-listing-an-app-on-github-marketplace/ - - /apps/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/ + - /apps/adding-integrations/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace + - /apps/marketplace/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace + - /apps/marketplace/getting-started-with-github-marketplace-listings/requirements-for-listing-an-app-on-github-marketplace + - /apps/marketplace/creating-and-submitting-your-app-for-approval/requirements-for-listing-an-app-on-github-marketplace + - /apps/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace - /marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace - /developers/github-marketplace/requirements-for-listing-an-app versions: @@ -14,68 +14,67 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: 列出要求 +shortTitle: Listing requirements --- - -在 {% data variables.product.prodname_marketplace %} 中上架应用程序的要求取决于您是要提供免费应用程序还是付费应用程序。 +The requirements for listing an app on {% data variables.product.prodname_marketplace %} vary according to whether you want to offer a free or a paid app. -## 对所有 {% data variables.product.prodname_marketplace %} 上架产品的要求 +## Requirements for all {% data variables.product.prodname_marketplace %} listings -{% data variables.product.prodname_marketplace %} 中的所有上架产品应该是能够为 {% data variables.product.product_name %} 社区提供价值的工具。 提交要发布的上架信息时，您必须阅读并接受“[{% data variables.product.prodname_marketplace %} 开发者协议](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement)”的条款。 +All listings on {% data variables.product.prodname_marketplace %} should be for tools that provide value to the {% data variables.product.product_name %} community. When you submit your listing for publication, you must read and accept the terms of the "[{% data variables.product.prodname_marketplace %} Developer Agreement](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement)." -### 所有应用程序的用户体验要求 +### User experience requirements for all apps -所有上架产品应满足以下要求，无论它们是免费应用程序还是付费应用程序。 +All listings should meet the following requirements, regardless of whether they are for a free or paid app. -- 上架信息不得主动诱导用户离开 {% data variables.product.product_name %}。 -- 上架信息必须包含发布者的有效联系信息。 -- 上架信息必须包含应用程序的相关说明。 -- 上架信息必须指定定价计划。 -- 应用程序必须为客户提供价值，并通过身份验证以外的其他方式与平台集成。 -- 应用程序必须在 {% data variables.product.prodname_marketplace %} 中公开可用，并且不能是测试版或只能通过邀请获取。 -- 应用程序必须设置 web 挂钩事件，以便在发生计划更改或取消时通过 {% data variables.product.prodname_marketplace %} API 通知发布者。 更多信息请参阅“[在应用程序中使用 {% data variables.product.prodname_marketplace %} API](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)”。 +- Listings must not actively persuade users away from {% data variables.product.product_name %}. +- Listings must include valid contact information for the publisher. +- Listings must have a relevant description of the application. +- Listings must specify a pricing plan. +- Apps must provide value to customers and integrate with the platform in some way beyond authentication. +- Apps must be publicly available in {% data variables.product.prodname_marketplace %} and cannot be in beta or available by invite only. +- Apps must have webhook events set up to notify the publisher of any plan changes or cancellations using the {% data variables.product.prodname_marketplace %} API. For more information, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -有关提供良好客户体验的更多信息，请参阅“[应用程序的客户体验最佳实践](/developers/github-marketplace/customer-experience-best-practices-for-apps)”。 +For more information on providing a good customer experience, see "[Customer experience best practices for apps](/developers/github-marketplace/customer-experience-best-practices-for-apps)." -### 所有应用程序的品牌和上架要求 +### Brand and listing requirements for all apps -- 使用 GitHub 徽标的应用程序必须遵循 {% data variables.product.company_short %} 指南。 更多信息请参阅“[{% data variables.product.company_short %} 徽标和用法](https://github.com/logos)”。 -- 应用程序必须具有徽标、功能卡和屏幕截图，并且这些内容必须遵循“[编写 {% data variables.product.prodname_marketplace %} 上架说明](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)”中提供的建议。 -- 上架信息必须包含认真编写并且没有语法错误的说明。 有关编写上架信息的指南，请参阅“[编写 {% data variables.product.prodname_marketplace %} 上架说明](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)”。 +- Apps that use GitHub logos must follow the {% data variables.product.company_short %} guidelines. For more information, see "[{% data variables.product.company_short %} Logos and Usage](https://github.com/logos)." +- Apps must have a logo, feature card, and screenshots images that meet the recommendations provided in "[Writing {% data variables.product.prodname_marketplace %} listing descriptions](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)." +- Listings must include descriptions that are well written and free of grammatical errors. For guidance in writing your listing, see "[Writing {% data variables.product.prodname_marketplace %} listing descriptions](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)." -为了保护您的客户，我们建议您还要遵循安全最佳实践。 更多信息请参阅“[应用程序的安全最佳实践](/developers/github-marketplace/security-best-practices-for-apps)”。 +To protect your customers, we recommend that you also follow security best practices. For more information, see "[Security best practices for apps](/developers/github-marketplace/security-best-practices-for-apps)." -## 免费应用程序注意事项 +## Considerations for free apps -{% data reusables.marketplace.free-apps-encouraged %} +{% data reusables.marketplace.free-apps-encouraged %} -## 付费应用程序的要求 +## Requirements for paid apps -要在 {% data variables.product.prodname_marketplace %} 上发布应用程序的付费计划，您的应用程序必须由身份为经验证发布者的组织所拥有。 有关验证流程或转让应用程序所有权的更多信息，请参阅“[为组织申请发布者验证](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)”。 +To publish a paid plan for your app on {% data variables.product.prodname_marketplace %}, your app must be owned by an organization that is a verified publisher. For more information about the verification process or transferring ownership of your app, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)." -如果您的应用程序已发布，并且您是经验证的发布者，则您可以使用定价计划编辑器发布新的付费计划。 更多信息请参阅“[为上架产品设置定价计划](/developers/github-marketplace/setting-pricing-plans-for-your-listing)”。 +If your app is already published and you're a verified publisher, then you can publish a new paid plan from the pricing plan editor. For more information, see "[Setting pricing plans for your listing](/developers/github-marketplace/setting-pricing-plans-for-your-listing)." -要发布付费应用程序（或提供付费计划的应用程序），您还必须满足以下要求： +To publish a paid app (or an app that offers a paid plan), you must also meet the following requirements: -- {% data variables.product.prodname_github_apps %} 应至少有 100 个安装设施。 -- {% data variables.product.prodname_oauth_apps %} 应至少有 200 个用户。 -- 所有付费应用程序必须处理关于新购买、升级、降级、取消和免费试用的 {% data variables.product.prodname_marketplace %} 购买事件。 更多信息请参阅下面的“[付费应用程序的计费要求](#billing-requirements-for-paid-apps)”。 +- {% data variables.product.prodname_github_apps %} should have a minimum of 100 installations. +- {% data variables.product.prodname_oauth_apps %} should have a minimum of 200 users. +- All paid apps must handle {% data variables.product.prodname_marketplace %} purchase events for new purchases, upgrades, downgrades, cancellations, and free trials. For more information, see "[Billing requirements for paid apps](#billing-requirements-for-paid-apps)" below. -当您准备在 {% data variables.product.prodname_marketplace %} 上发布应用程序时，您必须请求验证应用程序上架信息。 +When you are ready to publish the app on {% data variables.product.prodname_marketplace %} you must request verification for the app listing. {% note %} -**注：**{% data reusables.marketplace.app-transfer-to-org-for-verification %} 有关如何将应用程序转让给组织，请参阅“[提交要发布的上架信息](/developers/github-marketplace/submitting-your-listing-for-publication#transferring-an-app-to-an-organization-before-you-submit)”。 +**Note:** {% data reusables.marketplace.app-transfer-to-org-for-verification %} For information on how to transfer an app to an organization, see: "[Submitting your listing for publication](/developers/github-marketplace/submitting-your-listing-for-publication#transferring-an-app-to-an-organization-before-you-submit)." {% endnote %} -## 付费应用程序的计费要求 +## Billing requirements for paid apps -您的应用程序无需处理付款，但需要使用 {% data variables.product.prodname_marketplace %} 购买事件来管理新购买、升级、降级、取消和免费试用。 有关如何将这些事件集成到您的应用程序中，请参阅“[在应用程序中使用 {% data variables.product.prodname_marketplace %} API](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)”。 +Your app does not need to handle payments but does need to use {% data variables.product.prodname_marketplace %} purchase events to manage new purchases, upgrades, downgrades, cancellations, and free trials. For information about how integrate these events into your app, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -GitHub 的计费 API 允许客户在不离开 GitHub 的情况下购买应用程序，并使用已附加到其在 {% data variables.product.product_location %} 上帐户的付款方式来支付服务费用。 +Using GitHub's billing API allows customers to purchase an app without leaving GitHub and to pay for the service with the payment method already attached to their account on {% data variables.product.product_location %}. -- 应用程序必须在付费订阅计划中支持月度和年度计费。 -- 上架产品可提供免费和付费计划的任何组合。 免费计划是可选项，但建议提供。 更多信息请参阅“[设置 {% data variables.product.prodname_marketplace %} 上架产品的定价计划](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)”。 +- Apps must support both monthly and annual billing for paid subscriptions purchases. +- Listings may offer any combination of free and paid plans. Free plans are optional but encouraged. For more information, see "[Setting a {% data variables.product.prodname_marketplace %} listing's pricing plan](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)." diff --git a/translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/security-best-practices-for-apps.md b/translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/security-best-practices-for-apps.md index 5de0196d5b..edf1015910 100644 --- a/translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/security-best-practices-for-apps.md +++ b/translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/security-best-practices-for-apps.md @@ -1,63 +1,63 @@ --- -title: 应用程序的安全最佳实践 -intro: '准备在 {% data variables.product.prodname_marketplace %} 上分享安全应用程序的指南。' +title: Security best practices for apps +intro: 'Guidelines for preparing a secure app to share on {% data variables.product.prodname_marketplace %}.' redirect_from: - - /apps/marketplace/getting-started/security-review-process/ + - /apps/marketplace/getting-started/security-review-process - /marketplace/getting-started/security-review-process - /developers/github-marketplace/security-review-process-for-submitted-apps - /developers/github-marketplace/security-best-practices-for-apps -shortTitle: 安全最佳实践 +shortTitle: Security best practice versions: fpt: '*' ghec: '*' topics: - Marketplace --- +If you follow these best practices it will help you to provide a secure user experience. -遵循这些最佳实践将有助于您提供安全的用户体验。 +## Authorization, authentication, and access control -## 授权、身份验证和访问控制 +We recommend creating a GitHub App rather than an OAuth App. {% data reusables.marketplace.github_apps_preferred %}. See "[Differences between GitHub Apps and OAuth Apps](/apps/differences-between-apps/)" for more details. +- Apps should use the principle of least privilege and should only request the OAuth scopes and GitHub App permissions that the app needs to perform its intended functionality. For more information, see [Principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege) in Wikipedia. +- Apps should provide customers with a way to delete their account, without having to email or call a support person. +- Apps should not share tokens between different implementations of the app. For example, a desktop app should have a separate token from a web-based app. Individual tokens allow each app to request the access needed for GitHub resources separately. +- Design your app with different user roles, depending on the functionality needed by each type of user. For example, a standard user should not have access to admin functionality, and billing managers might not need push access to repository code. +- Apps should not share service accounts such as email or database services to manage your SaaS service. +- All services used in your app should have unique login and password credentials. +- Admin privilege access to the production hosting infrastructure should only be given to engineers and employees with administrative duties. +- Apps should not use personal access tokens to authenticate and should authenticate as an [OAuth App](/apps/about-apps/#about-oauth-apps) or a [GitHub App](/apps/about-apps/#about-github-apps): + - OAuth Apps should authenticate using an [OAuth token](/apps/building-oauth-apps/authorizing-oauth-apps/). + - GitHub Apps should authenticate using either a [JSON Web Token (JWT)](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app), [OAuth token](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/), or [installation access token](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation). -我们建议创建 GitHub 应用程序，而不是 OAuth 应用程序。 {% data reusables.marketplace.github_apps_preferred %}. 更多信息请参阅“[GitHub 应用程序和 OAuth 应用程序之间的差异](/apps/differences-between-apps/)”。 -- 应用程序应使用最小权限原则，只请求应用程序执行其预期功能所需的 OAuth 作用域和 GitHub 应用程序权限。 更多信息请参阅维基百科中的[最小权限原则](https://en.wikipedia.org/wiki/Principle_of_least_privilege)。 -- 应用程序应为客户提供删除其帐户的方法，而无需发送电子邮件或呼叫支持人员。 -- 应用程序不应在应用程序的不同实现之间共享令牌。 例如，桌面应用程序应该使用与基于 Web 的应用程序不同的令牌。 单个令牌允许每个应用程序单独请求 GitHub 资源所需的访问权限。 -- 根据每种用户类型所需的功能，针对不同的用户角色设计应用程序。 例如，标准用户不应有权访问管理功能，帐单管理员可能不需要仓库代码推送权限。 -- 应用程序不应共享服务帐户（如电子邮件或数据库服务）来管理 SaaS 服务。 -- 应用程序中使用的所有服务都应具有唯一的登录名和密码凭据。 -- 对生产托管基础架构的管理员权限只能授予担当管理职责的工程师和员工。 -- 应用程序不应使用个人访问令牌进行身份验证，应验证为 [OAuth 应用程序](/apps/about-apps/#about-oauth-apps)或 [GitHub 应用程序](/apps/about-apps/#about-github-apps)： - - OAuth 应用程序应使用 [OAuth 令牌](/apps/building-oauth-apps/authorizing-oauth-apps/)进行身份验证。 - - GitHub 应用程序应使用 [JSON Web 令牌 (JWT)](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)、[OAuth 令牌](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)或[安装访问令牌](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)进行身份验证。 +## Data protection -## 数据保护 +- Apps should encrypt data transferred over the public internet using HTTPS, with a valid TLS certificate, or SSH for Git. +- Apps should store client ID and client secret keys securely. We recommend storing them as [environmental variables](http://en.wikipedia.org/wiki/Environment_variable#Getting_and_setting_environment_variables). +- Apps should delete all GitHub user data within 30 days of receiving a request from the user, or within 30 days of the end of the user's legal relationship with GitHub. +- Apps should not require the user to provide their GitHub password. +- Apps should encrypt tokens, client IDs, and client secrets. -- 应用程序应使用带有有效 TLS 证书或 SSH for Git 的 HTTPS 对通过公共互联网传输的数据进行加密。 -- 应用程序应安全地存储客户端 ID 和客户端密钥。 我们建议将它们存储为[环境变量](http://en.wikipedia.org/wiki/Environment_variable#Getting_and_setting_environment_variables)。 -- 应用程序应在收到用户请求后 30 天内或在用户与 GitHub 的法律关系终止后 30 天内删除所有 GitHub 用户数据。 -- 应用程序不应要求用户提供其 GitHub 密码。 -- 应用程序应该对令牌、客户端 ID 和客户端密钥进行加密。 +## Logging and monitoring -## 日志记录和监视 +Apps should have logging and monitoring capabilities. App logs should be retained for at least 30 days and archived for at least one year. +A security log should include: -应用程序应具有日志记录和监视功能。 应用程序日志应保留至少 30 天，并存档至少一年。 安全日志应包括： +- Authentication and authorization events +- Service configuration changes +- Object reads and writes +- All user and group permission changes +- Elevation of role to admin +- Consistent timestamping for each event +- Source users, IP addresses, and/or hostnames for all logged actions -- 身份验证和授权事件 -- 服务配置更改 -- 对象读取和写入 -- 所有用户和组权限更改 -- 角色提升到管理员 -- 每个事件的一致时间戳 -- 所有记录操作的源用户、IP 地址和/或主机名 +## Incident response workflow -## 事件响应工作流程 +To provide a secure experience for users, you should have a clear incident response plan in place before listing your app. We recommend having a security and operations incident response team in your company rather than using a third-party vendor. You should have the capability to notify {% data variables.product.product_name %} within 24 hours of a confirmed incident. -要为用户提供安全体验，应在上架应用程序之前制定明确的事件响应计划。 我们建议您在自己的公司内成立安全和运营事件响应团队，而不是使用第三方供应商。 您应该能够在确认事件后 24 小时内通知 {% data variables.product.product_name %}。 +For an example of an incident response workflow, see the "Data Breach Response Policy" on the [SANS Institute website](https://www.sans.org/information-security-policy/). A short document with clear steps to take in the event of an incident is more valuable than a lengthy policy template. -有关事件响应工作流程的示例，请参阅 [SANS 研究所网站](https://www.sans.org/information-security-policy/)上的“数据泄露响应策略”。 包含明确的事件响应措施的简短文档比冗长的策略模板更有价值。 +## Vulnerability management and patching workflow -## 漏洞管理和补丁工作流程 +You should conduct regular vulnerability scans of production infrastructure. You should triage the results of vulnerability scans and define a period of time in which you agree to remediate the vulnerability. -您应该定期对生产基础架构进行漏洞扫描。 您应该对漏洞扫描的结果进行分类，并定义您同意修复漏洞的时间段。 - -如果您还没有准备好设置完整的漏洞管理程序，最好先创建一个修补流程。 有关创建补丁管理策略的指南，请参阅这篇 TechRepublic 文章“[建立补丁管理策略](https://www.techrepublic.com/blog/it-security/establish-a-patch-management-policy-87756/)”。 +If you are not ready to set up a full vulnerability management program, it's useful to start by creating a patching process. For guidance in creating a patch management policy, see this TechRepublic article "[Establish a patch management policy](https://www.techrepublic.com/blog/it-security/establish-a-patch-management-policy-87756/)." diff --git a/translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/viewing-metrics-for-your-listing.md b/translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/viewing-metrics-for-your-listing.md index 213519bf58..1faccc7c50 100644 --- a/translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/viewing-metrics-for-your-listing.md +++ b/translations/zh-CN/content/developers/github-marketplace/creating-apps-for-github-marketplace/viewing-metrics-for-your-listing.md @@ -1,10 +1,10 @@ --- -title: 查看上架产品的指标 -intro: '{% data variables.product.prodname_marketplace %} Insights 页面显示 {% data variables.product.prodname_github_app %} 的指标。 您可以使用这些指标来跟踪 {% data variables.product.prodname_github_app %} 的表现，并就价格、计划、免费试用以及如何看待营销活动的效果做出更明智的决定。' +title: Viewing metrics for your listing +intro: 'The {% data variables.product.prodname_marketplace %} Insights page displays metrics for your {% data variables.product.prodname_github_app %}. You can use the metrics to track your {% data variables.product.prodname_github_app %}''s performance and make more informed decisions about pricing, plans, free trials, and how to visualize the effects of marketing campaigns.' redirect_from: - - /apps/marketplace/managing-github-marketplace-listings/viewing-performance-metrics-for-a-github-marketplace-listing/ - - /apps/marketplace/viewing-performance-metrics-for-a-github-marketplace-listing/ - - /apps/marketplace/github-marketplace-insights/ + - /apps/marketplace/managing-github-marketplace-listings/viewing-performance-metrics-for-a-github-marketplace-listing + - /apps/marketplace/viewing-performance-metrics-for-a-github-marketplace-listing + - /apps/marketplace/github-marketplace-insights - /marketplace/github-marketplace-insights - /developers/github-marketplace/viewing-metrics-for-your-listing versions: @@ -12,45 +12,45 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: 查看列表指标 +shortTitle: View listing metrics --- - -您可以查看 {% data variables.product.prodname_github_app %} 在过去一天（24 小时）、一周、一月或整个上架期间的指标。 +You can view metrics for the past day (24 hours), week, month, or for the entire duration of time that your {% data variables.product.prodname_github_app %} has been listed. {% note %} -**注：**由于聚合数据需要时间，因此您会注意到显示的日期略有延迟。 选择时间段时，可以在页面顶部看到指标的确切日期。 +**Note:** Because it takes time to aggregate data, you'll notice a slight delay in the dates shown. When you select a time period, you can see exact dates for the metrics at the top of the page. {% endnote %} -## 性能指标 +## Performance metrics -Insights 页面显示选定时段的以下性能指标： +The Insights page displays these performance metrics, for the selected time period: -* **Subscription value（订阅价值）：**订阅的可能总收入（美元）。 此值表示在没有计划或免费试用被取消并且所有信用交易都成功的情况下的可能收入。 订阅价值包括计划在选定时段内的全部价值，从免费试用开始计算，即使在该时段内没有任何财务交易。 订阅价值还包括选定时段内升级计划的全部价值，但不包括按比例分配的金额。 要查看和下载单个交易，请参阅“[GitHub Marketplace 交易](/marketplace/github-marketplace-transactions/)”。 -* **Visitors（访客数）：**查看过 GitHub 应用程序上架页面的人数。 此数字包括已登录和已注销的访客。 -* **Pageviews（网页浏览量）：**GitHub 应用程序上架页面获得的浏览次数。 单个访客可以产生多个网页浏览量。 +* **Subscription value:** Total possible revenue (in US dollars) for subscriptions. This value represents the possible revenue if no plans or free trials are cancelled and all credit transactions are successful. The subscription value includes the full value for plans that begin with a free trial in the selected time period, even when there are no financial transactions in that time period. The subscription value also includes the full value of upgraded plans in the selected time period but does not include the prorated amount. To see and download individual transactions, see "[GitHub Marketplace transactions](/marketplace/github-marketplace-transactions/)." +* **Visitors:** Number of people that have viewed a page in your GitHub Apps listing. This number includes both logged in and logged out visitors. +* **Pageviews:** Number of views the pages in your GitHub App's listing received. A single visitor can generate more than one pageview. {% note %} -**注：**您估计的订阅价值可能远远高于此期间处理的交易。 +**Note:** Your estimated subscription value could be much higher than the transactions processed for this period. {% endnote %} -### 转化性能 +### Conversion performance -* **Unique visitors to landing page（登录页面的绝对访客数）：**查看过 GitHub 应用程序登录页面的人数。 -* **Unique visitors to checkout page（结账页面的绝对访客数）：**查看过 GitHub 应用程序结账页面的人数。 -* **Checkout page to new subscriptions（结账页面产生的新订阅数）：**付费订阅、免费试用和免费订阅的总数。 有关每种类型订阅的具体数量，请参阅“订阅总数的细分”。 +* **Unique visitors to landing page:** Number of people who viewed your GitHub App's landing page. +* **Unique visitors to checkout page:** Number of people who viewed one of your GitHub App's checkout pages. +* **Checkout page to new subscriptions:** Total number of paid subscriptions, free trials, and free subscriptions. See the "Breakdown of total subscriptions" for the specific number of each type of subscription. ![Marketplace insights](/assets/images/marketplace/marketplace_insights.png) -要访问 {% data variables.product.prodname_marketplace %} Insights： +To access {% data variables.product.prodname_marketplace %} Insights: {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.marketplace_apps %} -4. 选择要查看其 Insights 的 {% data variables.product.prodname_github_app %}。 +4. Select the {% data variables.product.prodname_github_app %} that you'd like to view Insights for. {% data reusables.user-settings.edit_marketplace_listing %} -6. 单击 **Insights** 选项卡。 -7. （可选）通过单击 Insights 页面右上角的 Period（时段）下拉列表选择不同的时间段。 ![Marketplace 时段](/assets/images/marketplace/marketplace_insights_time_period.png) +6. Click the **Insights** tab. +7. Optionally, select a different time period by clicking the Period dropdown in the upper-right corner of the Insights page. +![Marketplace time period](/assets/images/marketplace/marketplace_insights_time_period.png) diff --git a/translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md b/translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md index 9b9bc6f646..7370b55b41 100644 --- a/translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md +++ b/translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md @@ -2,7 +2,7 @@ title: About GitHub Marketplace intro: 'Learn about {% data variables.product.prodname_marketplace %} where you can share your apps and actions publicly with all {% data variables.product.product_name %} users.' redirect_from: - - /apps/marketplace/getting-started/ + - /apps/marketplace/getting-started - /marketplace/getting-started - /developers/github-marketplace/about-github-marketplace versions: diff --git a/translations/zh-CN/content/developers/github-marketplace/index.md b/translations/zh-CN/content/developers/github-marketplace/index.md index 7a303fa048..7bfbc295fd 100644 --- a/translations/zh-CN/content/developers/github-marketplace/index.md +++ b/translations/zh-CN/content/developers/github-marketplace/index.md @@ -1,9 +1,9 @@ --- title: GitHub Marketplace -intro: '在 {% data variables.product.prodname_dotcom %} Marketplace 中上架您的工具，供开发者使用或购买。' +intro: 'List your tools in {% data variables.product.prodname_dotcom %} Marketplace for developers to use or purchase.' redirect_from: - - /apps/adding-integrations/listing-apps-on-github-marketplace/about-github-marketplace/ - - /apps/marketplace/ + - /apps/adding-integrations/listing-apps-on-github-marketplace/about-github-marketplace + - /apps/marketplace - /marketplace versions: fpt: '*' diff --git a/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md b/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md index 040c291b06..d1b387eead 100644 --- a/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md +++ b/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md @@ -1,11 +1,11 @@ --- -title: 配置 web 挂钩以通知您计划更改 -intro: '在[创建 {% data variables.product.prodname_marketplace %} 上架信息草稿](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/) 后，您可以配置 web 挂钩，以便在客户帐户计划发生更改时通知您。 配置 web 挂钩后，您可以在应用程序中[处理 `marketplace_purchase` 事件类型](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)。' +title: Configuring a webhook to notify you of plan changes +intro: 'After [creating a draft {% data variables.product.prodname_marketplace %} listing](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/), you can configure a webhook that notifies you when changes to customer account plans occur. After you configure the webhook, you can [handle the `marketplace_purchase` event types](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) in your app.' redirect_from: - - /apps/adding-integrations/managing-listings-on-github-marketplace/adding-webhooks-for-a-github-marketplace-listing/ - - /apps/marketplace/managing-github-marketplace-listings/adding-webhooks-for-a-github-marketplace-listing/ - - /apps/marketplace/setting-up-github-marketplace-webhooks/creating-a-webhook-for-a-github-marketplace-listing/ - - /apps/marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook/ + - /apps/adding-integrations/managing-listings-on-github-marketplace/adding-webhooks-for-a-github-marketplace-listing + - /apps/marketplace/managing-github-marketplace-listings/adding-webhooks-for-a-github-marketplace-listing + - /apps/marketplace/setting-up-github-marketplace-webhooks/creating-a-webhook-for-a-github-marketplace-listing + - /apps/marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook - /marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook - /developers/github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes versions: @@ -13,33 +13,32 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: 计划更改的 web 挂钩 +shortTitle: Webhooks for plan changes --- +The {% data variables.product.prodname_marketplace %} event webhook can only be set up from your application's {% data variables.product.prodname_marketplace %} listing page. You can configure all other events from your [application's developer settings page](https://github.com/settings/developers). If you haven't created a {% data variables.product.prodname_marketplace %} listing, read "[Creating a draft {% data variables.product.prodname_marketplace %} listing](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)" to learn how. -{% data variables.product.prodname_marketplace %} 事件 web 挂钩只能在应用程序的 {% data variables.product.prodname_marketplace %} 上架页面中进行设置。 您可以在[应用程序的开发者设置页面](https://github.com/settings/developers)中配置所有其他事件。 如果您尚未创建 {% data variables.product.prodname_marketplace %} 上架信息，请阅读“[创建 {% data variables.product.prodname_marketplace %} 上架信息](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)”了解方法。 +## Creating a webhook -## 创建 web 挂钩 +To create a webhook for your {% data variables.product.prodname_marketplace %} listing, click **Webhook** in the left sidebar of your [{% data variables.product.prodname_marketplace %} listing page](https://github.com/marketplace/manage). You'll see the following webhook configuration options needed to configure your webhook: -要为 {% data variables.product.prodname_marketplace %} 上架信息创建 web 挂钩，请在 [{% data variables.product.prodname_marketplace %} 上架页面](https://github.com/marketplace/manage)的左边栏中单击 **Webhook（web 挂钩）**。 您将看到配置 web 挂钩所需的以下 web 挂钩配置选项： - -### 有效负载 URL +### Payload URL {% data reusables.webhooks.payload_url %} -### 内容类型 +### Content type -{% data reusables.webhooks.content_type %} GitHub 建议使用 `application/json` 内容类型。 +{% data reusables.webhooks.content_type %} GitHub recommends using the `application/json` content type. -### 密钥 +### Secret {% data reusables.webhooks.secret %} -### 已激活 +### Active -默认情况下，web 挂钩交付为“Active（激活）”。 您可以通过取消选择“Active（激活）”来选择在开发过程中禁用 web 挂钩交付。 如果您禁用了 web 挂钩交付，则在提交应用程序以供审查之前需要选择“Active（激活）”。 +By default, webhook deliveries are "Active." You can choose to disable the delivery of webhook payloads during development by deselecting "Active." If you've disabled webhook deliveries, you will need to select "Active" before you submit your app for review. -## 查看 web 挂钩交付 +## Viewing webhook deliveries -配置 {% data variables.product.prodname_marketplace %} web 挂钩后，您可以在应用程序的 [{% data variables.product.prodname_marketplace %} 上架信息](https://github.com/marketplace/manage)的 **Webhook（web 挂钩）**页面中检查 `POST` 请求有效负载。 GitHub 不会重新发送失败的递送尝试。 确保您的应用程序可以接收 GitHub 发送的所有 web 挂钩有效负载。 +Once you've configured your {% data variables.product.prodname_marketplace %} webhook, you'll be able to inspect `POST` request payloads from the **Webhook** page of your application's [{% data variables.product.prodname_marketplace %} listing](https://github.com/marketplace/manage). GitHub doesn't resend failed delivery attempts. Ensure your app can receive all webhook payloads sent by GitHub. -![检查最近的 {% data variables.product.prodname_marketplace %} web 挂钩交付](/assets/images/marketplace/marketplace_webhook_deliveries.png) +![Inspect recent {% data variables.product.prodname_marketplace %} webhook deliveries](/assets/images/marketplace/marketplace_webhook_deliveries.png) diff --git a/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md b/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md index 66bac51270..9dd64a8959 100644 --- a/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md +++ b/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md @@ -1,16 +1,16 @@ --- -title: 起草应用程序上架信息 -intro: '当您创建 {% data variables.product.prodname_marketplace %} 上架信息时，GitHub 将其保存为草稿模式，直到您提交应用程序以供审批。 您的上架信息向客户显示如何使用您的应用程序。' +title: Drafting a listing for your app +intro: 'When you create a {% data variables.product.prodname_marketplace %} listing, GitHub saves it in draft mode until you submit the app for approval. Your listing shows customers how they can use your app.' redirect_from: - - /apps/adding-integrations/listing-apps-on-github-marketplace/listing-an-app-on-github-marketplace/ - - /apps/marketplace/listing-apps-on-github-marketplace/listing-an-app-on-github-marketplace/ - - /apps/marketplace/getting-started-with-github-marketplace-listings/listing-an-app-on-github-marketplace/ - - /apps/marketplace/creating-and-submitting-your-app-for-approval/listing-an-app-on-github-marketplace/ - - /apps/adding-integrations/managing-listings-on-github-marketplace/removing-a-listing-from-github-marketplace/ - - /apps/marketplace/managing-github-marketplace-listings/removing-a-listing-from-github-marketplace/ - - /apps/adding-integrations/managing-listings-on-github-marketplace/editing-a-github-marketplace-listing/ - - /apps/marketplace/managing-github-marketplace-listings/editing-a-github-marketplace-listing/ - - /apps/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/ + - /apps/adding-integrations/listing-apps-on-github-marketplace/listing-an-app-on-github-marketplace + - /apps/marketplace/listing-apps-on-github-marketplace/listing-an-app-on-github-marketplace + - /apps/marketplace/getting-started-with-github-marketplace-listings/listing-an-app-on-github-marketplace + - /apps/marketplace/creating-and-submitting-your-app-for-approval/listing-an-app-on-github-marketplace + - /apps/adding-integrations/managing-listings-on-github-marketplace/removing-a-listing-from-github-marketplace + - /apps/marketplace/managing-github-marketplace-listings/removing-a-listing-from-github-marketplace + - /apps/adding-integrations/managing-listings-on-github-marketplace/editing-a-github-marketplace-listing + - /apps/marketplace/managing-github-marketplace-listings/editing-a-github-marketplace-listing + - /apps/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing - /marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing - /developers/github-marketplace/drafting-a-listing-for-your-app versions: @@ -18,50 +18,51 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: 草拟应用程序列表 +shortTitle: Draft an app listing --- +## Create a new draft {% data variables.product.prodname_marketplace %} listing -## 创建新的 {% data variables.product.prodname_marketplace %} 上架信息草稿 +You can only create draft listings for apps that are public. Before creating your draft listing, you can read the following guidelines for writing and configuring settings in your {% data variables.product.prodname_marketplace %} listing: -您只能为公共应用程序创建上架信息草稿。 在创建上架信息草稿之前，请阅读以下有关在 {% data variables.product.prodname_marketplace %} 上架信息中编写和配置设置的指南： +* [Writing {% data variables.product.prodname_marketplace %} listing descriptions](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/) +* [Setting a {% data variables.product.prodname_marketplace %} listing's pricing plan](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/) +* [Configuring the {% data variables.product.prodname_marketplace %} Webhook](/marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook/) -* [编写 {% data variables.product.prodname_marketplace %} 上架产品说明](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/) -* [设置 {% data variables.product.prodname_marketplace %} 上架产品的定价计划](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/) -* [配置 {% data variables.product.prodname_marketplace %} web 挂钩](/marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook/) - -要创建 {% data variables.product.prodname_marketplace %} 上架信息： +To create a {% data variables.product.prodname_marketplace %} listing: {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} -3. 在左边栏中，单击 **OAuth Apps（OAuth 应用程序）**或 **GitHub Apps（GitHub 应用程序）**，具体取决于您要添加到 {% data variables.product.prodname_marketplace %} 的应用程序。 +3. In the left sidebar, click either **OAuth Apps** or **GitHub Apps** depending on the app you're adding to {% data variables.product.prodname_marketplace %}. {% note %} - **注**：您也可以通过以下方法添加上架信息：导航到 https://github.com/marketplace/new，查看可用的应用程序，然后单击 **Create draft listing（创建上架信息草稿）**。 + **Note**: You can also add a listing by navigating to https://github.com/marketplace/new, viewing your available apps, and clicking **Create draft listing**. {% endnote %} - ![应用程序类型选择](/assets/images/settings/apps_choose_app.png) + ![App type selection](/assets/images/settings/apps_choose_app.png) -4. 选择您想添加到 {% data variables.product.prodname_marketplace %} 的应用程序。 ![选择在 {% data variables.product.prodname_marketplace %} 中上架的应用程序](/assets/images/github-apps/github_apps_select-app.png) +4. Select the app you'd like to add to {% data variables.product.prodname_marketplace %}. +![App selection for {% data variables.product.prodname_marketplace %} listing](/assets/images/github-apps/github_apps_select-app.png) {% data reusables.user-settings.edit_marketplace_listing %} -5. 创建新的上架草稿后，您将看到在完成 {% data variables.product.prodname_marketplace %} 上架信息之前需要访问的部分的概览。 ![GitHub Marketplace 上架信息](/assets/images/marketplace/marketplace_listing_overview.png) +5. Once you've created a new draft listing, you'll see an overview of the sections that you'll need to visit before your {% data variables.product.prodname_marketplace %} listing will be complete. +![GitHub Marketplace listing](/assets/images/marketplace/marketplace_listing_overview.png) {% note %} -**注：**在上架信息的“联系信息”部分，我们建议您使用个人电子邮件地址，而不是像 support@domain.com 这样的团体电子邮件地址。 GitHub 将使用这些电子邮件地址与您联系，以告知可能影响您的上架产品的 {% data variables.product.prodname_marketplace %} 更新、新功能发布、营销机会、付款以及会议和赞助信息。 +**Note:** In the "Contact info" section of your listing, we recommend using individual email addresses, rather than group emails addresses like support@domain.com. GitHub will use these email addresses to contact you about updates to {% data variables.product.prodname_marketplace %} that might affect your listing, new feature releases, marketing opportunities, payouts, and information on conferences and sponsorships. {% endnote %} -## 编辑您的上架信息 +## Editing your listing -创建 {% data variables.product.prodname_marketplace %} 上架信息草稿后，您可以随时回来修改上架信息。 如果您的应用程序已获批准并且在 {% data variables.product.prodname_marketplace %} 中，您可以编辑上架产品的信息和图像，但无法更改现有的已发布定价计划。 请参阅“[设置 {% data variables.product.prodname_marketplace %} 上架产品的定价计划](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)”。 +Once you've created a {% data variables.product.prodname_marketplace %} draft listing, you can come back to modify information in your listing anytime. If your app is already approved and in {% data variables.product.prodname_marketplace %}, you can edit the information and images in your listing, but you will not be able to change existing published pricing plans. See "[Setting a {% data variables.product.prodname_marketplace %} listing's pricing plan](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)." -## 提交应用程序 +## Submitting your app -完成 {% data variables.product.prodname_marketplace %} 上架信息后，您可以在 **Overview（概览）**页面中提交您的上架信息以供审查。 您需要阅读并接收“[{% data variables.product.prodname_marketplace %} 开发者协议](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement/)”，然后才可以单击 **Submit for review（提交审查）**。 提交应用程序以供审查后，上架专家将与您联系，提供有关上架流程的其他信息。 +Once you've completed your {% data variables.product.prodname_marketplace %} listing, you can submit your listing for review from the **Overview** page. You'll need to read and accept the "[{% data variables.product.prodname_marketplace %} Developer Agreement](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement/)," and then you can click **Submit for review**. After you submit your app for review, an onboarding expert will contact you with additional information about the onboarding process. -## 删除 {% data variables.product.prodname_marketplace %} 上架信息 +## Removing a {% data variables.product.prodname_marketplace %} listing -如果您不想再在 {% data variables.product.prodname_marketplace %} 中上架应用程序，请联系 {% data variables.contact.contact_support %} 删除您的上架信息。 +If you no longer want to list your app in {% data variables.product.prodname_marketplace %}, contact {% data variables.contact.contact_support %} to remove your listing. diff --git a/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/index.md b/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/index.md index a22caa46cb..c587c34a71 100644 --- a/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/index.md +++ b/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/index.md @@ -1,14 +1,14 @@ --- -title: 在 GitHub Marketplace 中上架应用程序 -intro: '了解在 {% data variables.product.prodname_marketplace %} 中上架应用程序的要求和最佳实践。' +title: Listing an app on GitHub Marketplace +intro: 'Learn about requirements and best practices for listing your app on {% data variables.product.prodname_marketplace %}.' redirect_from: - - /apps/adding-integrations/listing-apps-on-github-marketplace/ - - /apps/marketplace/listing-apps-on-github-marketplace/ - - /apps/marketplace/getting-started-with-github-marketplace-listings/ - - /apps/marketplace/creating-and-submitting-your-app-for-approval/ - - /apps/adding-integrations/managing-listings-on-github-marketplace/ - - /apps/marketplace/managing-github-marketplace-listings/ - - /apps/marketplace/listing-on-github-marketplace/ + - /apps/adding-integrations/listing-apps-on-github-marketplace + - /apps/marketplace/listing-apps-on-github-marketplace + - /apps/marketplace/getting-started-with-github-marketplace-listings + - /apps/marketplace/creating-and-submitting-your-app-for-approval + - /apps/adding-integrations/managing-listings-on-github-marketplace + - /apps/marketplace/managing-github-marketplace-listings + - /apps/marketplace/listing-on-github-marketplace - /marketplace/listing-on-github-marketplace versions: fpt: '*' @@ -21,6 +21,6 @@ children: - /setting-pricing-plans-for-your-listing - /configuring-a-webhook-to-notify-you-of-plan-changes - /submitting-your-listing-for-publication -shortTitle: 在 Marketplace 中上架应用程序 +shortTitle: List an app on the Marketplace --- diff --git a/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing.md b/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing.md index 4c50cb384a..ffdba1e720 100644 --- a/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing.md +++ b/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing.md @@ -1,17 +1,17 @@ --- -title: 为上架产品设置定价计划 -intro: '在 {% data variables.product.prodname_marketplace %} 中上架应用程序时，您可以选择免费提供或有偿出售您的应用程序。 如果打算出售应用程序，您可以为不同的功能等级创建不同的定价计划。' +title: Setting pricing plans for your listing +intro: 'When you list your app on {% data variables.product.prodname_marketplace %}, you can choose to provide your app as a free service or sell your app. If you plan to sell your app, you can create different pricing plans for different feature tiers.' redirect_from: - - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/setting-a-github-marketplace-listing-s-pricing-plan/ - - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/setting-a-github-marketplace-listing-s-pricing-plan/ - - /apps/marketplace/pricing-payments-and-free-trials/setting-a-github-marketplace-listing-s-pricing-plan/ - - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/about-github-marketplace-pricing-plans/ - - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/about-github-marketplace-pricing-plans/ - - /apps/marketplace/pricing-payments-and-free-trials/about-github-marketplace-pricing-plans/ - - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/changing-a-github-marketplace-listing-s-pricing-plan/ - - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/changing-a-github-marketplace-listing-s-pricing-plan/ - - /apps/marketplace/managing-github-marketplace-listings/changing-a-github-marketplace-listing-s-pricing-plan/ - - /apps/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/ + - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/setting-a-github-marketplace-listing-s-pricing-plan + - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/setting-a-github-marketplace-listing-s-pricing-plan + - /apps/marketplace/pricing-payments-and-free-trials/setting-a-github-marketplace-listing-s-pricing-plan + - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/about-github-marketplace-pricing-plans + - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/about-github-marketplace-pricing-plans + - /apps/marketplace/pricing-payments-and-free-trials/about-github-marketplace-pricing-plans + - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/changing-a-github-marketplace-listing-s-pricing-plan + - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/changing-a-github-marketplace-listing-s-pricing-plan + - /apps/marketplace/managing-github-marketplace-listings/changing-a-github-marketplace-listing-s-pricing-plan + - /apps/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan - /marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan - /developers/github-marketplace/setting-pricing-plans-for-your-listing versions: @@ -19,70 +19,69 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: 设置上市定价计划 +shortTitle: Set listing pricing plans --- +## About setting pricing plans -## 关于设置定价计划 +{% data variables.product.prodname_marketplace %} offers several different types of pricing plans. For detailed information, see "[Pricing plans for {% data variables.product.prodname_marketplace %}](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)." -{% data variables.product.prodname_marketplace %} 提供几种不同类型的定价计划。 更多信息请参阅“[{% data variables.product.prodname_marketplace %} 的定价计划](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)”。 +To offer a paid plan for your app, your app must be owned by an organization that has completed the publisher verification process and met certain criteria. For more information, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)" and "[Requirements for listing an app on {% data variables.product.prodname_marketplace %}](/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/)." -要为应用程序提供付费计划，该应用程序必须由已完成发布者验证流程并满足特定条件的组织所拥有。 更多信息请参阅“[为组织申请发布者验证](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)”和“[在 {% data variables.product.prodname_marketplace %} 中上架应用程序的要求](/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/)”。 +If your app is already published with a paid plan and you're a verified publisher, then you can publish a new paid plan from the "Edit a pricing plan" page in your Marketplace app listing settings. -如果含有付费计划的应用程序已发布，并且您是经验证的发布者，则您可以在 Marketplace 应用程序上架设置中的“Edit a pricing plan（编辑定价计划）”页面发布新的付费计划。 +![Publish this plan button](/assets/images/marketplace/publish-this-plan-button.png) -![发布此计划按钮](/assets/images/marketplace/publish-this-plan-button.png) +If your app is already published with a paid plan and but you are not a verified publisher, then you can cannot publish a new paid plan until you are a verified publisher. For more information about becoming a verified publisher, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)." -如果您的应用已经在付费计划中发布，但您不是验证的发布者，则您可以发布新的付费计划，直到您成为验证的发布者。 有关成为验证的发布者的更多信息，请参阅“[为组织申请发布者验证](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)”。 +## About saving pricing plans -## 关于保存定价计划 +You can save pricing plans in a draft or published state. If you haven't submitted your {% data variables.product.prodname_marketplace %} listing for approval, a published plan will function in the same way as a draft plan until your listing is approved and shown on {% data variables.product.prodname_marketplace %}. Draft plans allow you to create and save new pricing plans without making them available on your {% data variables.product.prodname_marketplace %} listing page. Once you publish a pricing plan on a published listing, it's available for customers to purchase immediately. You can publish up to 10 pricing plans. -您可以将定价计划保存为草稿或已发布状态。 如果尚未提交 {% data variables.product.prodname_marketplace %} 上架信息以供审批，则已发布的计划与计划草案的运作方式相同，直到您的上架信息得到批准并显示在 {% data variables.product.prodname_marketplace %} 上。 计划草案允许您创建和保存新的定价计划，而无需在您的 {% data variables.product.prodname_marketplace %} 上架页面上提供它们。 一旦您在已发布的上架信息中发布定价计划，它就可以立即供客户购买。 您最多可以发布 10 个定价计划。 +For guidelines on billing customers, see "[Billing customers](/developers/github-marketplace/billing-customers)." -有关向客户计费的指南，请参阅“[向客户计费](/developers/github-marketplace/billing-customers)”。 +## Creating pricing plans -## 创建定价计划 +To create a pricing plan for your {% data variables.product.prodname_marketplace %} listing, click **Plans and pricing** in the left sidebar of your [{% data variables.product.prodname_marketplace %} listing page](https://github.com/marketplace/manage). For more information, see "[Creating a draft {% data variables.product.prodname_marketplace %} listing](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)." -要为 {% data variables.product.prodname_marketplace %} 上架信息创建定价计划，请在 [{% data variables.product.prodname_marketplace %} 上架页面](https://github.com/marketplace/manage)的左边栏中单击 **Plans and pricing（计划和定价）**。 更多信息请参阅“[创建 {% data variables.product.prodname_marketplace %} 上架信息草稿](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)”。 +When you click **New draft plan**, you'll see a form that allows you to customize your pricing plan. You'll need to configure the following fields to create a pricing plan: -单击 **New draft plan（新建计划草稿）**时，您将会看到一个用于自定义定价计划的表单。 您需要配置以下字段以创建定价计划： +- **Plan name** - Your pricing plan's name will appear on your {% data variables.product.prodname_marketplace %} app's landing page. You can customize the name of your pricing plan to align with the plan's resources, the size of the company that will use the plan, or anything you'd like. -- **Plan name（计划名称）** - 定价计划的名称将显示在 {% data variables.product.prodname_marketplace %} 应用程序的登录页面上。 您可以自定义定价计划的名称，使其与计划的资源、将使用该计划的公司规模或任何您想要的内容保持一致。 +- **Pricing models** - There are three types of pricing plan: free, flat-rate, and per-unit. All plans require you to process new purchase and cancellation events from the marketplace API. In addition, for paid plans: -- **Pricing models（定价模式）** - 有三种类型的定价计划：免费、统一定价和每单位定价。 所有计划都要求通过 Marketplace API 处理新购买和取消事件。 此外，对于付费计划： - - - 您必须以美元设置每月和每年订阅价格。 - - 您的应用程序必须处理计划更改事件。 - - 您必须请求验证才能发布包含付费计划的上架产品。 + - You must set a price for both monthly and yearly subscriptions in US dollars. + - Your app must process plan change events. + - You must request verification to publish a listing with a paid plan. - {% data reusables.marketplace.marketplace-pricing-free-trials %} - 更多信息请参阅“[{% data variables.product.prodname_marketplace %} 应用程序的定价计划](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)”和“[在应用程序中使用 {% data variables.product.prodname_marketplace %} API](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)”。 + For detailed information, see "[Pricing plans for {% data variables.product.prodname_marketplace %} apps](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)" and "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -- **Available for（适用对象）** - {% data variables.product.prodname_marketplace %} 定价计划可以适用于 **Personal and organization accounts（个人和组织帐户）**、**Personal accounts only（仅个人帐户）**或 **Organization accounts only（仅组织帐户）**。 例如，如果您的定价计划为每单位定价并提供多个席位，则您将选择 **Organization accounts only（仅组织帐户）**，因为无法从个人帐户为组织中的人员分配席位。 +- **Available for** - {% data variables.product.prodname_marketplace %} pricing plans can apply to **Personal and organization accounts**, **Personal accounts only**, or **Organization accounts only**. For example, if your pricing plan is per-unit and provides multiple seats, you would select **Organization accounts only** because there is no way to assign seats to people in an organization from a personal account. -- **Short description（简要说明）** - 编写有关定价计划细节的简短摘要。 说明可包括计划的目标客户类型或所包含的资源。 +- **Short description** - Write a brief summary of the details of the pricing plan. The description might include the type of customer the plan is intended for or the resources the plan includes. -- **Bullets（项目符号）** - 您最多可以编写四个项目符号，其中包括有关定价计划的更多细节。 项目符号可包括应用程序的用例，或列出有关计划中包含的资源或功能的更多详细信息。 +- **Bullets** - You can write up to four bullets that include more details about your pricing plan. The bullets might include the use cases of your app or list more detailed information about the resources or features included in the plan. {% data reusables.marketplace.free-plan-note %} -## 创建 {% data variables.product.prodname_marketplace %} 上架产品的定价计划 +## Changing a {% data variables.product.prodname_marketplace %} listing's pricing plan -如果不再需要 {% data variables.product.prodname_marketplace %} 上架产品的定价计划，或者需要调整定价细节，您可以删除它。 +If a pricing plan for your {% data variables.product.prodname_marketplace %} listing is no longer needed, or if you need to adjust pricing details, you can remove it. -![删除定价计划的按钮](/assets/images/marketplace/marketplace_remove_this_plan.png) +![Button to remove your pricing plan](/assets/images/marketplace/marketplace_remove_this_plan.png) -为 {% data variables.product.prodname_marketplace %} 中已上架的应用程序发布定价计划后，就无法对该计划进行更改。 您需要删除该定价计划，然后创建一个新计划。 已经购买已删除定价计划的客户将继续使用它，直到他们选择退出并转到新的定价计划。 有关定价计划的更多信息，请参阅“[{% data variables.product.prodname_marketplace %} 定价计划](/marketplace/selling-your-app/github-marketplace-pricing-plans/)”。 +Once you publish a pricing plan for an app that is already listed in {% data variables.product.prodname_marketplace %}, you can't make changes to the plan. Instead, you'll need to remove the pricing plan and create a new plan. Customers who already purchased the removed pricing plan will continue to use it until they opt out and move onto a new pricing plan. For more on pricing plans, see "[{% data variables.product.prodname_marketplace %} pricing plans](/marketplace/selling-your-app/github-marketplace-pricing-plans/)." -您删除定价计划后，用户将无法使用该计划购买您的应用程序。 使用已删除定价计划的现有用户将继续使用该计划，直到他们取消其计划订阅。 +Once you remove a pricing plan, users won't be able to purchase your app using that plan. Existing users on the removed pricing plan will continue to stay on the plan until they cancel their plan subscription. {% note %} -**注：**{% data variables.product.product_name %} 不能从已删除的定价计划中删除用户。 您可以推出一个活动，鼓励用户从已删除的定价计划升级或降级到新的定价计划。 +**Note:** {% data variables.product.product_name %} can't remove users from a removed pricing plan. You can run a campaign to encourage users to upgrade or downgrade from the removed pricing plan onto a new pricing plan. {% endnote %} -您可以禁用 GitHub Marketplace 免费试用而不撤销定价计划，但这会阻止您在未来为该计划启动免费试用。 如果您选择禁用定价计划的免费试用，则已注册的用户仍可以完成其免费试用。 +You can disable GitHub Marketplace free trials without retiring the pricing plan, but this prevents you from initiating future free trials for that plan. If you choose to disable free trials for a pricing plan, users already signed up can complete their free trial. -撤销定价计划后，您可以创建与已删除的定价计划同名的新定价计划。 例如，如果您有一个 "Pro" 定价计划，但需要更改统一价格，您可以删除该 "Pro" 定价计划，然后使用更新后的价格创建新的 "Pro" 定价计划。 用户将能够立即购买新的定价计划。 +After retiring a pricing plan, you can create a new pricing plan with the same name as the removed pricing plan. For instance, if you have a "Pro" pricing plan but need to change the flat rate price, you can remove the "Pro" pricing plan and create a new "Pro" pricing plan with an updated price. Users will be able to purchase the new pricing plan immediately. -如果您不是经过验证的发布者，则无法更改应用的定价计划。 有关成为验证的发布者的更多信息，请参阅“[为组织申请发布者验证](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)”。 +If you are not a verified publisher, then you cannot change a pricing plan for your app. For more information about becoming a verified publisher, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)." diff --git a/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md b/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md index f705baef4d..0fc3e55f1b 100644 --- a/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md +++ b/translations/zh-CN/content/developers/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md @@ -1,14 +1,14 @@ --- -title: 编写应用程序的上架说明 -intro: '要在 {% data variables.product.prodname_marketplace %} 中[上架应用程序](/marketplace/listing-on-github-marketplace/)，您需要根据 GitHub 的指南编写应用程序的说明并提供图像。' +title: Writing a listing description for your app +intro: 'To [list your app](/marketplace/listing-on-github-marketplace/) in the {% data variables.product.prodname_marketplace %}, you''ll need to write descriptions of your app and provide images that follow GitHub''s guidelines.' redirect_from: - - /apps/marketplace/getting-started-with-github-marketplace-listings/guidelines-for-writing-github-app-descriptions/ - - /apps/marketplace/creating-and-submitting-your-app-for-approval/writing-github-app-descriptions/ - - /apps/adding-integrations/listing-apps-on-github-marketplace/guidelines-for-creating-a-github-marketplace-listing/ - - /apps/marketplace/listing-apps-on-github/guidelines-for-creating-a-github-marketplace-listing/ - - /apps/marketplace/getting-started-with-github-marketplace-listings/guidelines-for-creating-github-marketplace-listing-images/ - - /apps/marketplace/creating-and-submitting-your-app-for-approval/creating-github-marketplace-listing-images/ - - /apps/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/ + - /apps/marketplace/getting-started-with-github-marketplace-listings/guidelines-for-writing-github-app-descriptions + - /apps/marketplace/creating-and-submitting-your-app-for-approval/writing-github-app-descriptions + - /apps/adding-integrations/listing-apps-on-github-marketplace/guidelines-for-creating-a-github-marketplace-listing + - /apps/marketplace/listing-apps-on-github/guidelines-for-creating-a-github-marketplace-listing + - /apps/marketplace/getting-started-with-github-marketplace-listings/guidelines-for-creating-github-marketplace-listing-images + - /apps/marketplace/creating-and-submitting-your-app-for-approval/creating-github-marketplace-listing-images + - /apps/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions - /marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions - /developers/github-marketplace/writing-a-listing-description-for-your-app versions: @@ -16,183 +16,181 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: 写入列表说明 +shortTitle: Write listing descriptions --- +Here are guidelines about the fields you'll need to fill out in the **Listing description** section of your draft listing. -以下是有关您在上架信息草稿的 **Listing description（上架说明）**部分中需要填写字段的指南。 +## Naming and links -## 命名和链接 +### Listing name -### 上架产品名称 +Your listing's name will appear on the [{% data variables.product.prodname_marketplace %} homepage](https://github.com/marketplace). The name is limited to 255 characters and can be different from your app's name. Your listing cannot have the same name as an existing account on {% data variables.product.product_location %}, unless the name is your own user or organization name. -列表的名称将显示在 [{% data variables.product.prodname_marketplace %} 主页](https://github.com/marketplace)上。 名称仅限于 255 个字符，可能与应用名称不同。 您的列表不能与 {% data variables.product.product_location %} 上现有的帐户同名，除非该名称是您自己的用户或组织名称。 +### Very short description -### 简短说明 +The community will see the "very short" description under your app's name on the [{% data variables.product.prodname_marketplace %} homepage](https://github.com/marketplace). -在 [{% data variables.product.prodname_marketplace %} 主页](https://github.com/marketplace)上，社区将会看到应用程序名称下面“非常简短”的说明。 +![{% data variables.product.prodname_marketplace %} app short description](/assets/images/marketplace/marketplace_short_description.png) -![{% data variables.product.prodname_marketplace %} 应用程序简短说明](/assets/images/marketplace/marketplace_short_description.png) +#### Length -#### 长度 +We recommend keeping short descriptions to 40-80 characters. Although you are allowed to use more characters, concise descriptions are easier for customers to read and understand quickly. -我们建议将简短说明控制在 40-80 个字符。 尽管可以使用更多字符，但简洁的描述使客户更容易快速阅读和理解。 +#### Content -#### 内容 +- Describe the app’s functionality. Don't use this space for a call to action. For example: -- 介绍应用程序的功能。 不要在此空间使用呼吁用语。 例如： + **DO:** Lightweight project management for GitHub issues - **宜：**GitHub 议题的轻量级项目管理 + **DON'T:** Manage your projects and issues on GitHub - **不宜：**Manage your projects and issues on GitHub（在 GitHub 上管理项目和议题） + **Tip:** Add an "s" to the end of the verb in a call to action to turn it into an acceptable description: _Manages your projects and issues on GitHub_ - **提示：**在呼吁用语中动词的末尾加上 "s" 可转变为可接受的说明：_Manages your projects and issues on GitHub_ +- Don’t repeat the app’s name in the description. -- 不要在说明中重复应用程序的名称。 + **DO:** A container-native continuous integration tool - **宜：**容器原生持续集成工具 + **DON'T:** Skycap is a container-native continuous integration tool - **不宜：**Skycap 是一个容器原生持续集成工具 +#### Formatting -#### 格式 +- Always use sentence-case capitalization. Only capitalize the first letter and proper nouns. -- 始终使用句子大小写规则。 只大写第一个字母和专有名词。 +- Don't use punctuation at the end of your short description. Short descriptions should not include complete sentences, and definitely should not include more than one sentence. -- 在简短说明的末尾不要使用标点符号。 简短说明不应包含完整的句子，并且绝对不能包含一个以上的句子。 +- Only capitalize proper nouns. For example: -- 仅大写专有名词。 例如： + **DO:** One-click delivery automation for web developers - **宜：**One-click delivery automation for web developers + **DON'T:** One-click delivery automation for Web Developers - **不宜：**One-click delivery automation for Web Developers +- Always use a [serial comma](https://en.wikipedia.org/wiki/Serial_comma) in lists. -- 在列表中始终使用[连续逗号](https://en.wikipedia.org/wiki/Serial_comma)。 +- Avoid referring to the GitHub community as "users." -- 避免将 GitHub 社区称为“用户”。 + **DO:** Create issues automatically for people in your organization - **宜：**为组织中的人员自动创建议题 + **DON'T:** Create issues automatically for an organization's users - **不宜：**为组织的用户自动创建议题 +- Avoid acronyms unless they’re well established (such as API). For example: -- 避免使用首字母缩写词，除非是约定俗成的缩写（如 API）。 例如： + **DO:** Agile task boards, estimates, and reports without leaving GitHub - **宜：**Agile task boards, estimates, and reports without leaving GitHub + **DON'T:** Agile task boards, estimates, and reports without leaving GitHub’s UI - **不宜：** Agile task boards, estimates, and reports without leaving GitHub’s UI +### Categories -### 分类 +Apps in {% data variables.product.prodname_marketplace %} can be displayed by category. Select the category that best describes the main functionality of your app in the **Primary category** dropdown, and optionally select a **Secondary category** that fits your app. -{% data variables.product.prodname_marketplace %} 中的应用程序可以按类别显示。 在 **Primary category（主要类别）**下拉列表中选择最适合描述应用程序主要功能的类别，（可选）然后选择适合应用程序的 **Secondary category（次要类别）**。 +### Supported languages -### 支持的语言 +If your app only works with specific languages, select up to 10 programming languages that your app supports. These languages are displayed on your app's {% data variables.product.prodname_marketplace %} listing page. This field is optional. -如果您的应用程序仅适用于特定语言，请选择它支持的最多 10 种编程语言。 这些语言显示在应用程序的 {% data variables.product.prodname_marketplace %} 上架信息页面上。 此字段是可选的。 +### Listing URLs -### 上架信息中的 URL +**Required URLs** +* **Customer support URL:** The URL of a web page that your customers will go to when they have technical support, product, or account inquiries. +* **Privacy policy URL:** The web page that displays your app's privacy policy. +* **Installation URL:** This field is shown for OAuth Apps only. (GitHub Apps don't use this URL because they use the optional Setup URL from the GitHub App's settings page instead.) When a customer purchases your OAuth App, GitHub will redirect customers to the installation URL after they install the app. You will need to redirect customers to `https://github.com/login/oauth/authorize` to begin the OAuth authorization flow. See "[New purchases for OAuth Apps](/marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials/)" for more details. Skip this field if you're listing a GitHub App. -**必需的 URL** -* **Customer support URL（客户支持 URL）：**客户寻求技术支持、产品或帐户查询时前往的网页 URL。 -* **Privacy policy URL（隐私政策 URL）：**显示应用程序隐私政策的网页。 -* **Installation URL（安装 URL）：**此字段仅对 OAuth 应用程序显示。 （GitHub 应用程序不使用此 URL，因为它们使用 GitHub 应用程序设置页面中可选的设置 URL。） 当客户购买您的 OAuth 应用程序时，GitHub 将在客户安装应用程序后将其重定向到安装 URL。 您需要将客户重定向到 `https://github.com/login/oauth/authorize` 以开始 OAuth 授权流程。 更多信息请参阅“[新购买 OAuth 应用程序](/marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials/)”。 如果您要上架 GitHub 应用程序，请跳过此字段。 +**Optional URLs** +* **Company URL:** A link to your company's website. +* **Status URL:** A link to a web page that displays the status of your app. Status pages can include current and historical incident reports, web application uptime status, and scheduled maintenance. +* **Documentation URL:** A link to documentation that teaches customers how to use your app. -**可选的 URL** -* **Company URL（公司 URL）：**指向公司网站的链接。 -* **Status URL（状态 URL）：**显示应用程序状态的网页链接。 状态页面可以包括当前和历史事件报告、Web 应用程序正常运行时间状态以及预定维护。 -* **Documentation URL（文档 URL）：**指导客户如何使用应用程序的文档链接。 +## Logo and feature card -## 徽标和特征卡 +{% data variables.product.prodname_marketplace %} displays all listings with a square logo image inside a circular badge to visually distinguish apps. -{% data variables.product.prodname_marketplace %} 使用圆形徽章内的方形徽标图像显示所有上架产品，以便从视觉上区分应用程序。 +![GitHub Marketplace logo and badge images](/assets/images/marketplace/marketplace-logo-and-badge.png) -![GitHub Marketplace 徽标和徽章图像](/assets/images/marketplace/marketplace-logo-and-badge.png) +A feature card consists of your app's logo, name, and a custom background image that captures your brand personality. {% data variables.product.prodname_marketplace %} displays this card if your app is one of the four randomly featured apps at the top of the [homepage](https://github.com/marketplace). Each app's very short description is displayed below its feature card. -特征卡由应用程序的徽标、名称和自定义背景图像组成，可体现您的品牌个性。 如果您的应用程序是[主页](https://github.com/marketplace)顶部的四个随机精选应用程序之一，{% data variables.product.prodname_marketplace %} 将显示此卡。 每个应用程序的简短说明显示在其特征卡的下方。 +![Feature card](/assets/images/marketplace/marketplace_feature_card.png) -![特征卡](/assets/images/marketplace/marketplace_feature_card.png) +As you upload images and select colors, your {% data variables.product.prodname_marketplace %} draft listing will display a preview of your logo and feature card. -当您上传图像和选择颜色时，{% data variables.product.prodname_marketplace %} 上架草稿将显示徽标和特征卡的预览。 +#### Guidelines for logos -#### 徽标指南 +You must upload a custom image for the logo. For the badge, choose a background color. -您必须上传徽标的自定义图像。 对于徽章，请选择背景颜色。 +- Upload a logo image that is at least 200 pixels x 200 pixels so your logo won't have to be upscaled when your listing is published. +- Logos will be cropped to a square. We recommend uploading a square image file with your logo in the center. +- For best results, upload a logo image with a transparent background. +- To give the appearance of a seamless badge, choose a badge background color that matches the background color (or transparency) of your logo image. +- Avoid using logo images with words or text in them. Logos with text do not scale well on small screens. -- 上传至少为 200 像素 x 200 像素的徽标图像，这样在发布上架信息时就不必放大徽标。 -- 徽标将被裁剪为正方形。 建议上传徽标居中的正方形图像文件。 -- 为获得最佳效果，请上传透明背景的徽标图像。 -- 要显示无缝徽章的外观，请选择与徽标图像的背景颜色（或透明度）匹配的徽章背景颜色。 -- 避免使用带有文字的徽标图像。 带有文字的徽标在小屏幕上缩放效果不佳。 +#### Guidelines for feature cards -#### 特征卡指南 +You must upload a custom background image for the feature card. For the app's name, choose a text color. -您必须上传特征卡的自定义背景图像。 对于应用程序的名称，请选择文本颜色。 +- Use a pattern or texture in your background image to give your card a visual identity and help it stand out against the dark background of the {% data variables.product.prodname_marketplace %} homepage. Feature cards should capture your app's brand personality. +- Background image measures 965 pixels x 482 pixels (width x height). +- Choose a text color for your app's name that shows up clearly over the background image. -- 在背景图像中使用图案或纹理赋予卡片视觉特征，使其在 {% data variables.product.prodname_marketplace %} 主页的深色背景下引人注目。 特征卡应体现应用程序的品牌个性。 -- 背景图像尺寸为 965 像素 x 482 像素（宽 x 高）。 -- 为应用程序的名称选择文本颜色，使其清晰地显示在背景图像上。 +## Listing details -## 上架详细信息 +To get to your app's landing page, click your app's name from the {% data variables.product.prodname_marketplace %} homepage or category page. The landing page displays a longer description of the app, which includes two parts: an "Introductory description" and a "Detailed description." -要获取应用程序的登录页面，请在 {% data variables.product.prodname_marketplace %} 主页或类别页面上单击应用程序的名称。 登录页面显示应用程序的较长说明，包括两个部分：“Introductory description（简介）”和“Detailed description（详细说明）”。 +Your "Introductory description" is displayed at the top of your app's {% data variables.product.prodname_marketplace %} landing page. -“Introductory description（简介）”显示在应用程序 {% data variables.product.prodname_marketplace %} 登录页面的顶部。 +![{% data variables.product.prodname_marketplace %} introductory description](/assets/images/marketplace/marketplace_intro_description.png) -![{% data variables.product.prodname_marketplace %} 简介](/assets/images/marketplace/marketplace_intro_description.png) +Clicking **Read more...**, displays the "Detailed description." -单击 **Read more（阅读更多）...**，显示“Detailed description（详细说明）”。 +![{% data variables.product.prodname_marketplace %} detailed description](/assets/images/marketplace/marketplace_detailed_description.png) -![{% data variables.product.prodname_marketplace %} 详细说明](/assets/images/marketplace/marketplace_detailed_description.png) +Follow these guidelines for writing these descriptions. -请遵循以下指南编写这些说明。 +### Length -### 长度 +We recommend writing a 1-2 sentence high-level summary between 150-250 characters in the required "Introductory description" field when [listing your app](/marketplace/listing-on-github-marketplace/). Although you are allowed to use more characters, concise summaries are easier for customers to read and understand quickly. -我们建议您[上架应用程序](/marketplace/listing-on-github-marketplace/)时，在必填字段“Introductory description（简介）”中写 1-2 句高度概述的说明，长度控制在 150-250 个字符。 尽管可以使用更多字符，但简洁的概述使客户更容易快速阅读和理解。 +You can add more information in the optional "Detailed description" field. You see this description when you click **Read more...** below the introductory description on your app's landing page. A detailed description consists of 3-5 [value propositions](https://en.wikipedia.org/wiki/Value_proposition), with 1-2 sentences describing each one. You can use up to 1,000 characters for this description. -您可以在可选的“Detailed description（详细说明）”字段中添加更多信息。 在应用程序登录页面中“Introductory description（简介）”的下方单击 **Read more（阅读更多）...** 将会看到此说明。 详细说明包括 3-5 个[价值主张](https://en.wikipedia.org/wiki/Value_proposition)，每个价值主张用 1-2 个句子阐明。 此说明最多可以使用 1,000 个字符。 +### Content -### 内容 +- Always begin introductory descriptions with your app's name. -- 始终用应用程序的名称开始简介。 +- Always write descriptions and value propositions using the active voice. -- 始终用主动语态编写说明和价值主张。 +### Formatting -### 格式 +- Always use sentence-case capitalization in value proposition titles. Only capitalize the first letter and proper nouns. -- 始终在价值主张标题中使用句子大小写规则。 只大写第一个字母和专有名词。 +- Use periods in your descriptions. Avoid exclamation marks. -- 在说明中使用句点。 避免使用感叹号。 +- Don't use punctuation at the end of your value proposition titles. Value proposition titles should not include complete sentences, and should not include more than one sentence. -- 在价值主张标题的末尾不要使用标点符号。 价值主张标题不应包含完整的句子，并且不能包含一个以上的句子。 +- For each value proposition, include a title followed by a paragraph of description. Format the title as a [level-three header](/articles/basic-writing-and-formatting-syntax/#headings) using Markdown. For example: -- 对于每个价值主张，请在其标题后加上一段说明。 使用 Markdown 将标题格式设置为[三级标题](/articles/basic-writing-and-formatting-syntax/#headings)。 例如： + ### Learn the skills you need + GitHub Learning Lab can help you learn how to use GitHub, communicate more effectively with Markdown, handle merge conflicts, and more. - ### 学习所需的技能 +- Only capitalize proper nouns. - GitHub Learning Lab 可以帮助您学习如何使用 GitHub、如何使用 Markdown 更有效地沟通以及如何处理合并冲突等。 +- Always use the [serial comma](https://en.wikipedia.org/wiki/Serial_comma) in lists. -- 仅大写专有名词。 +- Avoid referring to the GitHub community as "users." -- 在列表中始终使用[连续逗号](https://en.wikipedia.org/wiki/Serial_comma)。 + **DO:** Create issues automatically for people in your organization -- 避免将 GitHub 社区称为“用户”。 + **DON'T:** Create issues automatically for an organization's users - **宜：**为组织中的人员自动创建议题 +- Avoid acronyms unless they’re well established (such as API). - **不宜：**为组织的用户自动创建议题 +## Product screenshots -- 避免使用首字母缩写词，除非是约定俗成的缩写（如 API）。 +You can upload up to five screenshot images of your app to display on your app's landing page. Add an optional caption to each screenshot to provide context. After you upload your screenshots, you can drag them into the order you want them to be displayed on the landing page. -## 产品屏幕截图 +### Guidelines for screenshots -您可以上传应用程序的最多五张屏幕截图，以显示在应用程序的登录页面上。 向每个屏幕截图添加可选标题以提供上下文。 上传屏幕截图后，您将其拖动到希望它们在登录页面上显示的位置。 +- Images must be of high resolution (at least 1200px wide). +- All images must be the same height and width (aspect ratio) to avoid page jumps when people click from one image to the next. +- Show as much of the user interface as possible so people can see what your app does. +- When taking screenshots of your app in a browser, only include the content in the display window. Avoid including the address bar, title bar, or toolbar icons, which do not scale well to smaller screen sizes. +- GitHub displays the screenshots you upload in a box on your app's landing page, so you don't need to add boxes or borders around your screenshots. +- Captions are most effective when they are short and snappy. -### 屏幕截图指南 - -- 图像必须具有高分辨率(至少 1200 像素宽)。 -- 所有图像必须具有相同的高度和宽度（宽高比），以避免用户切换图像时出现页面跳跃。 -- 显示尽可能多的用户界面，以便用户看到应用程序执行的操作。 -- 在浏览器中截取应用程序的屏幕时，仅包括显示窗口中的内容。 避免包括地址栏、标题栏或工具栏图标，它们不能很好地适应较小的屏幕尺寸。 -- GitHub 在应用程序登录页面的图框中显示您上传的屏幕截图，因此您无需在屏幕截图周围添加图框或边框。 -- 简短明快的字幕效果最好。 - -![GitHub Marketplace 屏幕截图](/assets/images/marketplace/marketplace-screenshots.png) +![GitHub Marketplace screenshot image](/assets/images/marketplace/marketplace-screenshots.png) diff --git a/translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/billing-customers.md b/translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/billing-customers.md index 84d0213e66..e7cd6e457d 100644 --- a/translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/billing-customers.md +++ b/translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/billing-customers.md @@ -1,9 +1,9 @@ --- -title: 向客户计费 -intro: '{% data variables.product.prodname_marketplace %} 上的应用程序应遵守 GitHub 的计费指南并支持推荐的服务。 遵循我们的指南可帮助客户顺利完成帐单流程。' +title: Billing customers +intro: 'Apps on {% data variables.product.prodname_marketplace %} should adhere to GitHub''s billing guidelines and support recommended services. Following our guidelines helps customers navigate the billing process without any surprises.' redirect_from: - - /apps/marketplace/administering-listing-plans-and-user-accounts/billing-customers-in-github-marketplace/ - - /apps/marketplace/selling-your-app/billing-customers-in-github-marketplace/ + - /apps/marketplace/administering-listing-plans-and-user-accounts/billing-customers-in-github-marketplace + - /apps/marketplace/selling-your-app/billing-customers-in-github-marketplace - /marketplace/selling-your-app/billing-customers-in-github-marketplace - /developers/github-marketplace/billing-customers versions: @@ -12,39 +12,38 @@ versions: topics: - Marketplace --- +## Understanding the billing cycle -## 了解结算周期 +Customers can choose a monthly or yearly billing cycle when they purchase your app. All changes customers make to the billing cycle and plan selection will trigger a `marketplace_purchase` event. You can refer to the `marketplace_purchase` webhook payload to see which billing cycle a customer selects and when the next billing date begins (`effective_date`). For more information about webhook payloads, see "[Webhook events for the {% data variables.product.prodname_marketplace %} API](/developers/github-marketplace/webhook-events-for-the-github-marketplace-api)." -客户在购买您的应用程序时可选择月度或年度结算周期、 客户对结算周期和计划选择所做的所有更改都将触发 `marketplace_purchase` 事件。 您可以参考 `marketplace_purchase` web 挂钩有效负载，以查看客户选择了哪个结算周期以及下一个计费日期 (`effective_date`) 何时开始 。 有关 web 挂钩有效负载的更多信息，请参阅“[{% data variables.product.prodname_marketplace %} API 的 web 挂钩事件](/developers/github-marketplace/webhook-events-for-the-github-marketplace-api)”。 +## Providing billing services in your app's UI -## 在应用程序 UI 中提供帐单服务 - -客户应该能够从您的应用程序网站执行以下操作： -- 客户应该能够单独修改或取消其个人和组织帐户的 {% data variables.product.prodname_marketplace %} 计划。 +Customers should be able to perform the following actions from your app's website: +- Customers should be able to modify or cancel their {% data variables.product.prodname_marketplace %} plans for personal and organizational accounts separately. {% data reusables.marketplace.marketplace-billing-ui-requirements %} -## 升级、降级和取消的帐单服务 +## Billing services for upgrades, downgrades, and cancellations -请遵循以下升级、降级和取消指南，以维护清晰一致的帐单流程。 有关 {% data variables.product.prodname_marketplace %} 购买事件的详细说明，请参阅“[在应用程序中使用 {% data variables.product.prodname_marketplace %} API](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)”。 +Follow these guidelines for upgrades, downgrades, and cancellations to maintain a clear and consistent billing process. For more detailed instructions about the {% data variables.product.prodname_marketplace %} purchase events, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -您可以使用 `marketplace_purchase` web 挂钩的 `effective_date` 键来确定计划何时发生更改，并定期同步[列出计划的帐户](/rest/reference/apps#list-accounts-for-a-plan)。 +You can use the `marketplace_purchase` webhook's `effective_date` key to determine when a plan change will occur and periodically synchronize the [List accounts for a plan](/rest/reference/apps#list-accounts-for-a-plan). -### 升级 +### Upgrades -当客户升级其定价计划或将其结算周期从每月更改为每年时，您应立即使更改对他们生效。 您需要对新计划应用按比例的折扣并更改结算周期。 +When a customer upgrades their pricing plan or changes their billing cycle from monthly to yearly, you should make the change effective for them immediately. You need to apply a pro-rated discount to the new plan and change the billing cycle. {% data reusables.marketplace.marketplace-failed-purchase-event %} -有关为应用程序构建升级或降级工作流程的信息，请参阅“[处理计划更改](/developers/github-marketplace/handling-plan-changes)”。 +For information about building upgrade and downgrade workflows into your app, see "[Handling plan changes](/developers/github-marketplace/handling-plan-changes)." -### 降级和取消 +### Downgrades and cancellations -当客户从付费计划转为免费计划、选择成本比其当前计划低的计划或将结算周期从每年更改为每月时，就会发生降级。 当降级或取消发生时，您不需要提供退款。 相反，当前计划将保持有效状态，直到当前结算周期的最后一天。 `marketplace-purpose` 事件将在客户的新计划生效，即下一个结算周期开始时发送。 - -当客户取消计划时，您必须： -- 自动降级到免费计划（如果有）。 +Downgrades occur when a customer moves to a free plan from a paid plan, selects a plan with a lower cost than their current plan, or changes their billing cycle from yearly to monthly. When downgrades or cancellations occur, you don't need to provide a refund. Instead, the current plan will remain active until the last day of the current billing cycle. The `marketplace_purchase` event will be sent when the new plan takes effect at the beginning of the customer's next billing cycle. +When a customer cancels a plan, you must: +- Automatically downgrade them to the free plan, if it exists. + {% data reusables.marketplace.cancellation-clarification %} -- 让他们能够通过 GitHub 升级计划（如果他们以后想要继续订阅计划）。 +- Enable them to upgrade the plan through GitHub if they would like to continue the plan at a later time. -有关为应用程序构建取消工作流程的信息，请参阅“[处理计划取消](/developers/github-marketplace/handling-plan-cancellations)”。 +For information about building cancellation workflows into your app, see "[Handling plan cancellations](/developers/github-marketplace/handling-plan-cancellations)." diff --git a/translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/index.md b/translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/index.md index ed11adbedf..b8325be8fc 100644 --- a/translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/index.md +++ b/translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/index.md @@ -1,12 +1,12 @@ --- -title: 在 GitHub Marketplace 上出售应用程序 -intro: '了解在 {% data variables.product.prodname_marketplace %} 上出售应用程序的要求和最佳实践。' +title: Selling your app on GitHub Marketplace +intro: 'Learn about requirements and best practices for selling your app on {% data variables.product.prodname_marketplace %}.' redirect_from: - - /apps/marketplace/administering-listing-plans-and-user-accounts/ - - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/ - - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/ - - /apps/marketplace/pricing-payments-and-free-trials/ - - /apps/marketplace/selling-your-app/ + - /apps/marketplace/administering-listing-plans-and-user-accounts + - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing + - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing + - /apps/marketplace/pricing-payments-and-free-trials + - /apps/marketplace/selling-your-app - /marketplace/selling-your-app versions: fpt: '*' @@ -17,6 +17,6 @@ children: - /pricing-plans-for-github-marketplace-apps - /billing-customers - /receiving-payment-for-app-purchases -shortTitle: 在 Marketplace 上销售应用 +shortTitle: Sell apps on the Marketplace --- diff --git a/translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md b/translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md index 0e82fe0615..98d5bcce1c 100644 --- a/translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md +++ b/translations/zh-CN/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md @@ -1,8 +1,8 @@ --- -title: GitHub Marketplace 应用程序的定价计划 -intro: '定价计划允许您为应用程序提供不同级别的服务或资源。 您可以在 {% data variables.product.prodname_marketplace %} 上架信息中提供最多 10 个定价计划。' +title: Pricing plans for GitHub Marketplace apps +intro: 'Pricing plans allow you to provide your app with different levels of service or resources. You can offer up to 10 pricing plans in your {% data variables.product.prodname_marketplace %} listing.' redirect_from: - - /apps/marketplace/selling-your-app/github-marketplace-pricing-plans/ + - /apps/marketplace/selling-your-app/github-marketplace-pricing-plans - /marketplace/selling-your-app/github-marketplace-pricing-plans - /developers/github-marketplace/pricing-plans-for-github-marketplace-apps versions: @@ -10,51 +10,50 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: 应用定价计划 +shortTitle: Pricing plans for apps --- +{% data variables.product.prodname_marketplace %} pricing plans can be free, flat rate, or per-unit. Prices are set, displayed, and processed in US dollars. Paid plans are restricted to apps published by verified publishers. For more information about becoming a verified publisher, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)." -{% data variables.product.prodname_marketplace %} 定价计划可以是免费、统一定价或每单位定价。 价格以美元设置、显示和处理。 付费计划仅限验证的发布者发布的应用。 有关成为验证的发布者的更多信息，请参阅“[为组织申请发布者验证](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)”。 +Customers purchase your app using a payment method attached to their account on {% data variables.product.product_location %}, without having to leave {% data variables.product.prodname_dotcom_the_website %}. You don't have to write code to perform billing transactions, but you will have to handle events from the {% data variables.product.prodname_marketplace %} API. For more information, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -客户使用附加到其在 {% data variables.product.product_location %} 上帐户的付款方式购买您的应用程序，而不必离开 {% data variables.product.prodname_dotcom_the_website %}。 您不必编写代码来执行结算交易，但必须处理来自 {% data variables.product.prodname_marketplace %} API 的事件。 更多信息请参阅“[在应用程序中使用 {% data variables.product.prodname_marketplace %} API](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)”。 +If the app you're listing on {% data variables.product.prodname_marketplace %} has multiple plan options, you can set up corresponding pricing plans. For example, if your app has two plan options, an open source plan and a pro plan, you can set up a free pricing plan for your open source plan and a flat pricing plan for your pro plan. Each {% data variables.product.prodname_marketplace %} listing must have an annual and a monthly price for every plan that's listed. -如果您在 {% data variables.product.prodname_marketplace %} 中上架的应用程序有多个计划选项，您可以设置相应的定价计划。 例如，如果您的应用程序有两个计划选项：开源计划和专业计划，您可以为开源计划设置一个免费定价计划，为专业计划设置一个统一定价计划。 每个 {% data variables.product.prodname_marketplace %} 上架产品必须为列出的每个计划提供年度和月度价格。 - -有关如何创建定价计划的更多信息，请参阅“[设置 {% data variables.product.prodname_marketplace %} 上架产品的定价计划](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)”。 +For more information on how to create a pricing plan, see "[Setting a {% data variables.product.prodname_marketplace %} listing's pricing plan](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)." {% data reusables.marketplace.free-plan-note %} -## 定价计划的类型 +## Types of pricing plans -### 免费定价计划 +### Free pricing plans {% data reusables.marketplace.free-apps-encouraged %} -免费计划对用户完全免费。 如果您设置免费定价计划，则无法向选择免费定价计划的用户收取使用应用程序的费用。 您可以为上架产品同时创建免费和付费计划。 +Free plans are completely free for users. If you set up a free pricing plan, you cannot charge users that choose the free pricing plan for the use of your app. You can create both free and paid plans for your listing. -所有应用程序都需要处理新购买和取消事件。 仅含免费计划的应用程序无需处理免费试用、升级和降级事件。 更多信息请参阅“[在应用程序中使用 {% data variables.product.prodname_marketplace %} API](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)”。 +All apps need to handle events for new purchases and cancellations. Apps that only have free plans do not need to handle events for free trials, upgrades, and downgrades. For more information, see: "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -如果您向已作为免费服务在 {% data variables.product.prodname_marketplace %} 中上架的应用程序添加付费计划，则需要请求验证应用程序并完成财务手续。 +If you add a paid plan to an app that you've already listed in {% data variables.product.prodname_marketplace %} as a free service, you'll need to request verification for the app and go through financial onboarding. -### 付费定价计划 +### Paid pricing plans -有两种类型的付费定价计划： +There are two types of paid pricing plan: -- 统一定价计划按月和按年收取固定费用。 +- Flat rate pricing plans charge a set fee on a monthly and yearly basis. -- 每单位定价计划按月或按年向您指定的单位收取固定费用。 “单位”可以是您愿意指定的任何对象（例如用户、席位或人员）。 +- Per-unit pricing plans charge a set fee on either a monthly or yearly basis for a unit that you specify. A "unit" can be anything you'd like (for example, a user, seat, or person). -您可能还希望提供免费试用。 这些选项为客户提供为期 14 天免费试用 OAuth 或 GitHub 应用程序的机会。 设置 Marketplace 定价计划时，您可以选择为统一定价或每单位定价计划提供免费试用选项。 +You may also want to offer free trials. These provide free, 14-day trials of OAuth or GitHub Apps to customers. When you set up a Marketplace pricing plan, you can select the option to provide a free trial for flat-rate or per-unit pricing plans. -## 免费试用 +## Free trials -客户可以免费试用 Marketplace 上架产品中包含免费试用选项的任何付费计划。 但是，客户不能对一个 Marketplace 产品使用多次免费试用机会。 +Customers can start a free trial for any paid plan on a Marketplace listing that includes free trials. However, customers cannot create more than one free trial per marketplace product. -免费试用的固定期限为 14 天。 客户在试用期结束前 4 天（免费试用期第 11 天）收到通知，他们的计划将升级。 在免费试用结束时，如果客户不取消，他们将自动注册到他们正在试用的计划中。 +Free trials have a fixed length of 14 days. Customers are notified 4 days before the end of their trial period (on day 11 of the free trial) that their plan will be upgraded. At the end of a free trial, customers will be auto-enrolled into the plan they are trialing if they do not cancel. -更多信息请参阅“[处理新购买和免费试用](/developers/github-marketplace/handling-new-purchases-and-free-trials/)”。 +For more information, see: "[Handling new purchases and free trials](/developers/github-marketplace/handling-new-purchases-and-free-trials/)." {% note %} -**注：**GitHub 希望您在取消试用后 30 天（从收到取消事件开始算起）内删除任何私人客户数据。 。 +**Note:** GitHub expects you to delete any private customer data within 30 days of a cancelled trial, beginning at the receipt of the cancellation event. {% endnote %} diff --git a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md index bc99d680d1..54fb39ac9f 100644 --- a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md +++ b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md @@ -2,9 +2,9 @@ title: Handling new purchases and free trials intro: 'When a customer purchases a paid plan, free trial, or the free version of your {% data variables.product.prodname_marketplace %} app, you''ll receive the [`marketplace_purchase` event](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) webhook with the `purchased` action, which kicks off the purchasing flow.' redirect_from: - - /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-github-apps/ - - /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-oauth-apps/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials/ + - /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-github-apps + - /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-oauth-apps + - /apps/marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials - /marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials - /developers/github-marketplace/handling-new-purchases-and-free-trials versions: diff --git a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations.md b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations.md index bc12439ba6..bc5ef37804 100644 --- a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations.md +++ b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations.md @@ -1,9 +1,9 @@ --- -title: 处理计划取消 -intro: '取消 {% data variables.product.prodname_marketplace %} 应用程序将触发 [`marketplace_purchase` 事件](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) web 挂钩，挂钩中带有可启动取消流程的 `cancelled` 操作。' +title: Handling plan cancellations +intro: 'Cancelling a {% data variables.product.prodname_marketplace %} app triggers the [`marketplace_purchase` event](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) webhook with the `cancelled` action, which kicks off the cancellation flow.' redirect_from: - - /apps/marketplace/administering-listing-plans-and-user-accounts/cancelling-plans/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/cancelling-plans/ + - /apps/marketplace/administering-listing-plans-and-user-accounts/cancelling-plans + - /apps/marketplace/integrating-with-the-github-marketplace-api/cancelling-plans - /marketplace/integrating-with-the-github-marketplace-api/cancelling-plans - /developers/github-marketplace/handling-plan-cancellations versions: @@ -11,26 +11,25 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: 计划取消 +shortTitle: Plan cancellations --- +For more information about cancelling as it relates to billing, see "[Billing customers in {% data variables.product.prodname_marketplace %}](/apps//marketplace/administering-listing-plans-and-user-accounts/billing-customers-in-github-marketplace)." -有关与计费相关之取消的更多信息，请参阅“[在 {% data variables.product.prodname_marketplace %} 中向客户计费](/apps//marketplace/administering-listing-plans-and-user-accounts/billing-customers-in-github-marketplace)”。 +## Step 1. Cancellation event -## 步骤 1. 取消事件 +If a customer chooses to cancel a {% data variables.product.prodname_marketplace %} order, GitHub sends a [`marketplace_purchase`](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhook with the action `cancelled` to your app when the cancellation takes effect. If the customer cancels during a free trial, your app will receive the event immediately. When a customer cancels a paid plan, the cancellation will occur at the end of the customer's billing cycle. -如果客户选择取消 {% data variables.product.prodname_marketplace %}，则在取消生效时，GitHub 会向您的应用程序发送带有操作 `cancelled` 的 [`marketplace_purchase`](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) web 挂钩。 如果客户在免费试用期间取消，您的应用程序将立即收到此事件。 如果客户取消付费计划，则取消将在客户结算周期结束时生效。 +## Step 2. Deactivating customer accounts -## 步骤 2. 停用客户帐户 +When a customer cancels a free or paid plan, your app must perform these steps to complete cancellation: -当客户取消免费或付费计划时，您的应用程序必须执行以下步骤才能完成取消： - -1. 停用取消计划的客户的帐户。 -1. 撤消您的应用程序为客户接收的 OAuth 令牌。 -1. 如果您的应用程序是 OAuth 应用程序，则删除应用程序为仓库创建的所有 web 挂钩。 -1. 在收到 `cancelled` 事件后的 30 天内删除所有客户数据。 +1. Deactivate the account of the customer who cancelled their plan. +1. Revoke the OAuth token your app received for the customer. +1. If your app is an OAuth App, remove all webhooks your app created for repositories. +1. Remove all customer data within 30 days of receiving the `cancelled` event. {% note %} -**注：**我们建议使用 [`marketplace_purchase`](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) web 挂钩的 `effective_date` 来确定计划更改何时生效，并定期同步[列出计划的帐户](/rest/reference/apps#list-accounts-for-a-plan)。 有关 web 挂钩的更多信息，请参阅“[{% data variables.product.prodname_marketplace %} web 挂钩事件](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)”。 +**Note:** We recommend using the [`marketplace_purchase`](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhook's `effective_date` to determine when a plan change will occur and periodically synchronizing the [List accounts for a plan](/rest/reference/apps#list-accounts-for-a-plan). For more information on webhooks, see "[{% data variables.product.prodname_marketplace %} webhook events](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)." {% endnote %} diff --git a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-changes.md b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-changes.md index 850ce259ab..34142dbb37 100644 --- a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-changes.md +++ b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-changes.md @@ -1,9 +1,9 @@ --- -title: 处理计划更改 -intro: '升级或降级 {% data variables.product.prodname_marketplace %} 应用程序将触发 [`marketplace_purchase` 事件](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) web 挂钩，挂钩中带有可启动升级或降级流程的 `changed` 操作。' +title: Handling plan changes +intro: 'Upgrading or downgrading a {% data variables.product.prodname_marketplace %} app triggers the [`marketplace_purchase` event](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhook with the `changed` action, which kicks off the upgrade or downgrade flow.' redirect_from: - - /apps/marketplace/administering-listing-plans-and-user-accounts/upgrading-or-downgrading-plans/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/upgrading-and-downgrading-plans/ + - /apps/marketplace/administering-listing-plans-and-user-accounts/upgrading-or-downgrading-plans + - /apps/marketplace/integrating-with-the-github-marketplace-api/upgrading-and-downgrading-plans - /marketplace/integrating-with-the-github-marketplace-api/upgrading-and-downgrading-plans - /developers/github-marketplace/handling-plan-changes versions: @@ -12,55 +12,54 @@ versions: topics: - Marketplace --- +For more information about upgrading and downgrading as it relates to billing, see "[Integrating with the {% data variables.product.prodname_marketplace %} API](/marketplace/integrating-with-the-github-marketplace-api/)." -有关与计费相关之升级和降级的更多信息，请参阅“[与 {% data variables.product.prodname_marketplace %} API 集成](/marketplace/integrating-with-the-github-marketplace-api/)”。 +## Step 1. Pricing plan change event -## 步骤 1. 定价计划更改事件 +GitHub send the `marketplace_purchase` webhook with the `changed` action to your app, when a customer makes any of these changes to their {% data variables.product.prodname_marketplace %} order: +* Upgrades to a more expensive pricing plan or downgrades to a lower priced plan. +* Adds or removes seats to their existing plan. +* Changes the billing cycle. -当客户对其 {% data variables.product.prodname_marketplace %} 订单进行以下任何更改时，GitHub 会将带有 `changed` 操作的 `marketplace_purchase` web 挂钩发送到您的应用程序： -* 升级到更昂贵的定价计划或降级到价格较低的计划。 -* 在其现有计划中增加或删除席位。 -* 更改结算周期。 +GitHub will send the webhook when the change takes effect. For example, when a customer downgrades a plan, GitHub sends the webhook at the end of the customer's billing cycle. GitHub sends a webhook to your app immediately when a customer upgrades their plan to allow them access to the new service right away. If a customer switches from a monthly to a yearly billing cycle, it's considered an upgrade. See "[Billing customers in {% data variables.product.prodname_marketplace %}](/marketplace/selling-your-app/billing-customers-in-github-marketplace/)" to learn more about what actions are considered an upgrade or downgrade. -更改生效时，GitHub 将发送 web 挂钩。 例如，当客户降级计划时，GitHub 会在客户的结算周期结束时发送 web 挂钩。 当客户升级其计划以便立即访问新服务时，GitHub 会立即向您的应用程序发送 web 挂钩。 如果客户从月度结算周期切换到年度结算周期，则视为升级。 有关哪些操作被视为升级或降级，请参阅“[在 {% data variables.product.prodname_marketplace %} 中向客户计费](/marketplace/selling-your-app/billing-customers-in-github-marketplace/)”。 +Read the `effective_date`, `marketplace_purchase`, and `previous_marketplace_purchase` from the `marketplace_purchase` webhook to update the plan's start date and make changes to the customer's billing cycle and pricing plan. See "[{% data variables.product.prodname_marketplace %} webhook events](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)" for an example of the `marketplace_purchase` event payload. -从 `marketplace_purchase` web 挂钩读取 `effective_date`、`marketplace_purchase` 和 `previous_marketplace_purchase`，以更新计划的开始日期，并更改客户的结算周期和定价计划。 有关 `marketplace_purchase` 事件有效负载的示例，请参阅“[{% data variables.product.prodname_marketplace %} web 挂钩事件](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)”。 +If your app offers free trials, you'll receive the `marketplace_purchase` webhook with the `changed` action when the free trial expires. If the customer's free trial expires, upgrade the customer to the paid version of the free-trial plan. -如果您的应用程序提供免费试用，则在免费试用到期时您将收到带有 `changed` 操作的 `marketplace_purchase` web 挂钩。 如果客户的免费试用到期，则将客户升级到免费试用计划的付费版本。 +## Step 2. Updating customer accounts -## 步骤 2. 更新客户账户 +You'll need to update the customer's account information to reflect the billing cycle and pricing plan changes the customer made to their {% data variables.product.prodname_marketplace %} order. Display upgrades to the pricing plan, `seat_count` (for per-unit pricing plans), and billing cycle on your Marketplace app's website or your app's UI when you receive the `changed` action webhook. -您需要更新客户的帐户信息，以反映客户对其 {% data variables.product.prodname_marketplace %} 订单所做的结算周期和定价计划更改。 当您收到 `changed` 操作 web 挂钩时，您的 Marketplace 应用程序的网站或应用程序的 UI 上会显示定价计划、`seat_count`（对于每单位定价计划）和结算周期的升级。 +When a customer downgrades a plan, it's recommended to review whether a customer has exceeded their plan limits and engage with them directly in your UI or by reaching out to them by phone or email. -当客户降级计划时，建议查看客户是否超出了计划限制，然后直接在您的 UI 中与他们互动，或者通过电话或电子邮件与他们联系。 - -要鼓励用户升级，您可以在应用程序的 UI 中显示升级 URL。 更多信息请参阅“[关于升级 URL](#about-upgrade-urls)”。 +To encourage people to upgrade you can display an upgrade URL in your app's UI. See "[About upgrade URLs](#about-upgrade-urls)" for more details. {% note %} -**注：**建议您使用 `GET /marketplace_listing/plans/:id/accounts` 进行定期同步，以确保您的应用程序具有每个帐户的正确计划、结算周期信息和单位计数（对于每单位定价）。 +**Note:** We recommend performing a periodic synchronization using `GET /marketplace_listing/plans/:id/accounts` to ensure your app has the correct plan, billing cycle information, and unit count (for per-unit pricing) for each account. {% endnote %} -## 升级付款失败 +## Failed upgrade payments {% data reusables.marketplace.marketplace-failed-purchase-event %} -## 关于升级 URL +## About upgrade URLs -您可以使用升级 URL 将用户从应用程序的 UI 重定向到 GitHub 上的升级页面： +You can redirect users from your app's UI to upgrade on GitHub using an upgrade URL: ``` https://www.github.com/marketplace//upgrade// ``` -例如，如果您发现某个客户需要从 5 人计划转换到 10 人计划，您可以在应用程序 UI 中显示一个“升级指南”按钮，或者显示包含升级 URL 链接的横幅。 升级 URL 可将客户带到您的上架产品计划的升级确认页面。 +For example, if you notice that a customer is on a 5 person plan and needs to move to a 10 person plan, you could display a button in your app's UI that says "Here's how to upgrade" or show a banner with a link to the upgrade URL. The upgrade URL takes the customer to your listing plan's upgrade confirmation page. -对客户想要购买的计划使用 `LISTING_PLAN_NUMBER`。 当您创建新的定价计划时，他们会收到 `LISTING_PLAN_NUMBER`（对于您的上架产品中每个计划而言是唯一的）和 `LISTING_PLAN_ID`（对于 {% data variables.product.prodname_marketplace %} 中每个计划而言是唯一的）。 当您[列出计划](/rest/reference/apps#list-plans)时，可以找到这些编号，它们用于标识上架产品的定价计划。 使用 `LISTING_PLAN_ID` 和“[列出计划的帐户](/rest/reference/apps#list-accounts-for-a-plan)”端点获取 `CUSTOMER_ACCOUNT_ID`。 +Use the `LISTING_PLAN_NUMBER` for the plan the customer would like to purchase. When you create new pricing plans they receive a `LISTING_PLAN_NUMBER`, which is unique to each plan across your listing, and a `LISTING_PLAN_ID`, which is unique to each plan in the {% data variables.product.prodname_marketplace %}. You can find these numbers when you [List plans](/rest/reference/apps#list-plans), which identifies your listing's pricing plans. Use the `LISTING_PLAN_ID` and the "[List accounts for a plan](/rest/reference/apps#list-accounts-for-a-plan)" endpoint to get the `CUSTOMER_ACCOUNT_ID`. {% note %} -**注：**如果您的客户升级到更多单位（例如席位），您仍然可以将他们送到适合其购买的计划中，但我们目前无法支持 `unit_count` 参数。 +**Note:** If your customer upgrades to additional units (such as seats), you can still send them to the appropriate plan for their purchase, but we are unable to support `unit_count` parameters at this time. {% endnote %} diff --git a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/index.md b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/index.md index f919d46309..074d42544b 100644 --- a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/index.md +++ b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/index.md @@ -1,9 +1,9 @@ --- -title: 在应用程序中使用 GitHub Marketplace API -intro: '了解如何将 {% data variables.product.prodname_marketplace %} API 和 web 挂钩集成到用于 {% data variables.product.prodname_marketplace %} 的应用程序中。' +title: Using the GitHub Marketplace API in your app +intro: 'Learn how to integrate the {% data variables.product.prodname_marketplace %} API and webhook events into your app for the {% data variables.product.prodname_marketplace %} .' redirect_from: - - /apps/marketplace/setting-up-github-marketplace-webhooks/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/ + - /apps/marketplace/setting-up-github-marketplace-webhooks + - /apps/marketplace/integrating-with-the-github-marketplace-api - /marketplace/integrating-with-the-github-marketplace-api versions: fpt: '*' @@ -17,6 +17,6 @@ children: - /handling-new-purchases-and-free-trials - /handling-plan-changes - /handling-plan-cancellations -shortTitle: Marketplace API 使用 +shortTitle: Marketplace API usage --- diff --git a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md index ca15a45d4c..8a02a458a7 100644 --- a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md +++ b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md @@ -1,9 +1,9 @@ --- -title: GitHub Marketplace API 的 REST 端点 -intro: '要帮助管理 {% data variables.product.prodname_marketplace %} 上的应用程序，请使用这些 {% data variables.product.prodname_marketplace %} API 端点。' +title: REST endpoints for the GitHub Marketplace API +intro: 'To help manage your app on {% data variables.product.prodname_marketplace %}, use these {% data variables.product.prodname_marketplace %} API endpoints.' redirect_from: - - /apps/marketplace/github-marketplace-api-endpoints/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-rest-api-endpoints/ + - /apps/marketplace/github-marketplace-api-endpoints + - /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-rest-api-endpoints - /marketplace/integrating-with-the-github-marketplace-api/github-marketplace-rest-api-endpoints - /developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api versions: @@ -13,21 +13,20 @@ topics: - Marketplace shortTitle: REST API --- +Here are some useful endpoints available for Marketplace listings: -以下是一些可用于 Marketplace 上架产品的有用端点： +* [List plans](/rest/reference/apps#list-plans) +* [List accounts for a plan](/rest/reference/apps#list-accounts-for-a-plan) +* [Get a subscription plan for an account](/rest/reference/apps#get-a-subscription-plan-for-an-account) +* [List subscriptions for the authenticated user](/rest/reference/apps#list-subscriptions-for-the-authenticated-user) -* [列出计划](/rest/reference/apps#list-plans) -* [列出计划的帐户](/rest/reference/apps#list-accounts-for-a-plan) -* [获取帐户的订阅计划](/rest/reference/apps#get-a-subscription-plan-for-an-account) -* [列出经验证用户的订阅](/rest/reference/apps#list-subscriptions-for-the-authenticated-user) +See these pages for details on how to authenticate when using the {% data variables.product.prodname_marketplace %} API: -有关在使用 {% data variables.product.prodname_marketplace %} API 时如何进行身份验证的详细信息，请参阅以下页面： - -* [OAuth 应用程序的授权选项](/apps/building-oauth-apps/authorizing-oauth-apps/) -* [GitHub 应用程序的身份验证选项](/apps/building-github-apps/authenticating-with-github-apps/) +* [Authorization options for OAuth Apps](/apps/building-oauth-apps/authorizing-oauth-apps/) +* [Authentication options for GitHub Apps](/apps/building-github-apps/authenticating-with-github-apps/) {% note %} -**注：**[REST API 的速率限制](/rest#rate-limiting)适用于所有 {% data variables.product.prodname_marketplace %} API 端点。 +**Note:** [Rate limits for the REST API](/rest#rate-limiting) apply to all {% data variables.product.prodname_marketplace %} API endpoints. {% endnote %} diff --git a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app.md b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app.md index 405408611c..537d8fe792 100644 --- a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app.md +++ b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app.md @@ -1,9 +1,9 @@ --- -title: 测试应用程序 -intro: 'GitHub 建议在将上架信息提交到 {% data variables.product.prodname_marketplace %} 之前，先使用 API 和 web 挂钩测试您的应用，以便为客户提供理想的体验。 在上架专家批准您的应用程序之前，它必须能够完全处理帐单流程。' +title: Testing your app +intro: 'GitHub recommends testing your app with APIs and webhooks before submitting your listing to {% data variables.product.prodname_marketplace %} so you can provide an ideal experience for customers. Before an onboarding expert approves your app, it must adequately handle the billing flows.' redirect_from: - - /apps/marketplace/testing-apps-apis-and-webhooks/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps/ + - /apps/marketplace/testing-apps-apis-and-webhooks + - /apps/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps - /marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps - /developers/github-marketplace/testing-your-app versions: @@ -12,35 +12,34 @@ versions: topics: - Marketplace --- +## Testing apps -## 测试应用程序 +You can use a draft {% data variables.product.prodname_marketplace %} listing to simulate each of the billing flows. A listing in the draft state means that it has not been submitted for approval. Any purchases you make using a draft {% data variables.product.prodname_marketplace %} listing will _not_ create real transactions, and GitHub will not charge your credit card. Note that you can only simulate purchases for plans published in the draft listing and not for draft plans. For more information, see "[Drafting a listing for your app](/developers/github-marketplace/drafting-a-listing-for-your-app)" and "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -您可以使用 {% data variables.product.prodname_marketplace %} 上架草稿来模拟每个帐单流程。 上架信息处于草稿状态意味着它尚未提交以供审批。 使用 {% data variables.product.prodname_marketplace %} 上架草稿进行的任何购买都_不会_产生真正的交易，GitHub 不会从您的信用卡中扣款。 请注意，您只能模拟在列表草案中公布的计划的购买情况，而不能模拟计划草案中的购买情况。 更多信息请参阅“[起草应用程序上架信息](/developers/github-marketplace/drafting-a-listing-for-your-app)”和“[在应用程序中使用 {% data variables.product.prodname_marketplace %} API](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)”。 +### Using a development app with a draft listing to test changes -### 使用带有上架草稿的开发应用程序来测试更改 +A {% data variables.product.prodname_marketplace %} listing can only be associated with a single app registration, and each app can only access its own {% data variables.product.prodname_marketplace %} listing. For these reasons, we recommend configuring a separate development app, with the same configuration as your production app, and creating a _draft_ {% data variables.product.prodname_marketplace %} listing that you can use for testing. The draft {% data variables.product.prodname_marketplace %} listing allows you to test changes without affecting the active users of your production app. You will never have to submit your development {% data variables.product.prodname_marketplace %} listing, since you will only use it for testing. -{% data variables.product.prodname_marketplace %} 上架信息只能与单个应用程序注册相关联，并且每个应用程序只能访问它自己的 {% data variables.product.prodname_marketplace %} 上架信息。 出于这些原因，我们建议配置一个与生产应用程序配置相同的单独开发应用程序，并创建可用于测试的 {% data variables.product.prodname_marketplace %} 上架_草稿_。 {% data variables.product.prodname_marketplace %} 草稿允许您测试更改而不影响生产应用程序的活动用户。 您无需提交开发 {% data variables.product.prodname_marketplace %} 上架信息，因为它仅用于测试。 +Because you can only create draft {% data variables.product.prodname_marketplace %} listings for public apps, you must make your development app public. Public apps are not discoverable outside of published {% data variables.product.prodname_marketplace %} listings as long as you don't share the app's URL. A Marketplace listing in the draft state is only visible to the app's owner. -由于只能为公共应用程序创建 {% data variables.product.prodname_marketplace %} 上架草稿，因此您必须将开发应用程序设为公共。 公共应用程序不会在已发布的 {% data variables.product.prodname_marketplace %} 上架信息之外被发现，只要您不分享该应用程序的 URL。 处于草稿状态的 Marketplace 上架信息仅对应用程序的所有者可见。 - -一旦有了带有上架草稿的开发应用程序，就可以在与 {% data variables.product.prodname_marketplace %} API 和 web 挂钩集成的同时，使用它来测试您对应用程序所做的更改。 +Once you have a development app with a draft listing, you can use it to test changes you make to your app while integrating with the {% data variables.product.prodname_marketplace %} API and webhooks. {% warning %} -不要使用 {% data variables.product.prodname_marketplace %} 中上线的应用程序来测试购买。 +Do not make test purchases with an app that is live in {% data variables.product.prodname_marketplace %}. {% endwarning %} -### 模拟 Marketplace 购买事件 +### Simulating Marketplace purchase events -您的测试场景可能需要设置可提供免费试用并且可在免费和付费订阅之间切换的上架计划。 由于降级和取消要到下一个结算周期才会生效，因此 GitHub 提供一个开发者专用功能“应用待处理更改”，以强制 `changed` 和 `cancelled` 计划操作立即生效。 您可以在 https://github.com/settings/billing#pending-cycle 中对带有 Marketplace 上架_草稿_的应用程序使用 **Apply Pending Change（应用待处理更改）**： +Your testing scenarios may require setting up listing plans that offer free trials and switching between free and paid subscriptions. Because downgrades and cancellations don't take effect until the next billing cycle, GitHub provides a developer-only feature to "Apply Pending Change" to force `changed` and `cancelled` plan actions to take effect immediately. You can access **Apply Pending Change** for apps with _draft_ Marketplace listings in https://github.com/settings/billing#pending-cycle: -![应用待处理更改](/assets/images/github-apps/github-apps-apply-pending-changes.png) +![Apply pending change](/assets/images/github-apps/github-apps-apply-pending-changes.png) -## 测试 API +## Testing APIs -对于大多数 {% data variables.product.prodname_marketplace %} API 端点，我们还提供存根 API 端点，它们返回可用于测试的硬编码假数据。 要接收存根数据，您必须指定存根 URL，其路由中包括 `/stubbed`（例如，`/user/marketplace_purchases/stubbed`）。 有关支持此存根数据方法的端点列表，请参阅 [{% data variables.product.prodname_marketplace %} 端点](/rest/reference/apps#github-marketplace)。 +For most {% data variables.product.prodname_marketplace %} API endpoints, we also provide stubbed API endpoints that return hard-coded, fake data you can use for testing. To receive stubbed data, you must specify stubbed URLs, which include `/stubbed` in the route (for example, `/user/marketplace_purchases/stubbed`). For a list of endpoints that support this stubbed-data approach, see [{% data variables.product.prodname_marketplace %} endpoints](/rest/reference/apps#github-marketplace). -## 测试 web 挂钩 +## Testing webhooks -GitHub 提供用于测试已部署有效负载的工具。 更多信息请参阅“[测试 web 挂钩](/webhooks/testing/)”。 +GitHub provides tools for testing your deployed payloads. For more information, see "[Testing webhooks](/webhooks/testing/)." diff --git a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api.md b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api.md index 434e8202fd..eb0ffba0ac 100644 --- a/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api.md +++ b/translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api.md @@ -1,9 +1,9 @@ --- -title: GitHub Marketplace API 的 web 挂钩事件 -intro: '{% data variables.product.prodname_marketplace %} app 从 Marketplace 购买事件 web 挂钩接收有关用户计划更改的信息。 当用户购买、取消或更改其付款计划时，就会触发 Marketplace 购买事件。' +title: Webhook events for the GitHub Marketplace API +intro: 'A {% data variables.product.prodname_marketplace %} app receives information about changes to a user''s plan from the Marketplace purchase event webhook. A Marketplace purchase event is triggered when a user purchases, cancels, or changes their payment plan.' redirect_from: - - /apps/marketplace/setting-up-github-marketplace-webhooks/about-webhook-payloads-for-a-github-marketplace-listing/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/ + - /apps/marketplace/setting-up-github-marketplace-webhooks/about-webhook-payloads-for-a-github-marketplace-listing + - /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events - /marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events - /developers/github-marketplace/webhook-events-for-the-github-marketplace-api versions: @@ -11,66 +11,65 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: Web 挂钩事件 +shortTitle: Webhook events --- +## {% data variables.product.prodname_marketplace %} purchase webhook payload -## {% data variables.product.prodname_marketplace %} 购买 web 挂钩有效负载 +Webhooks `POST` requests have special headers. See "[Webhook delivery headers](/webhooks/event-payloads/#delivery-headers)" for more details. GitHub doesn't resend failed delivery attempts. Ensure your app can receive all webhook payloads sent by GitHub. -Web 挂钩 `POST` 请求具有特殊标头。 有关详细信息，请参阅“[web 挂钩递送标头](/webhooks/event-payloads/#delivery-headers)”。 GitHub 不会重新发送失败的递送尝试。 确保您的应用程序可以接收 GitHub 发送的所有 web 挂钩有效负载。 - -取消和降级在下一个结算周期的第一天生效。 如果新计划在下一个结算周期开始时生效，则将发送降级和取消事件。 新的购买和升级事件会立即生效。 使用 web 挂钩有效负载中的 `effective_date` 可确定更改何时开始生效。 +Cancellations and downgrades take effect on the first day of the next billing cycle. Events for downgrades and cancellations are sent when the new plan takes effect at the beginning of the next billing cycle. Events for new purchases and upgrades begin immediately. Use the `effective_date` in the webhook payload to determine when a change will begin. {% data reusables.marketplace.marketplace-malicious-behavior %} -每个 `marketplace_purchase` web 挂钩有效负载都含有以下信息： +Each `marketplace_purchase` webhook payload will have the following information: -| 键 | 类型 | 描述 | -| ---------------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | `字符串` | 为生成 web 挂钩而执行的操作。 可以是 `purchased`、`cancelled`、`pending_change`、`pending_change_cancelled` 或 `changed`。 更多信息请参阅下面的 web 挂钩有效负载示例。 **注：**`pending_change` 和 `pending_change_cancelled` 有效负载包含与 [`changed` 有效负载示例](#example-webhook-payload-for-a-changed-event)中所示键相同的键。 | -| `effective_date` | `字符串` | `action` 开始生效的日期。 | -| `sender` | `对象` | 执行 `action` 触发 web 挂钩的人。 | -| `marketplace_purchase` | `对象` | {% data variables.product.prodname_marketplace %} 购买信息。 | +Key | Type | Description +----|------|------------- +`action` | `string` | The action performed to generate the webhook. Can be `purchased`, `cancelled`, `pending_change`, `pending_change_cancelled`, or `changed`. For more information, see the example webhook payloads below. **Note:** The `pending_change` and `pending_change_cancelled` payloads contain the same keys as shown in the [`changed` payload example](#example-webhook-payload-for-a-changed-event). +`effective_date` | `string` | The date the `action` becomes effective. +`sender` | `object` | The person who took the `action` that triggered the webhook. +`marketplace_purchase` | `object` | The {% data variables.product.prodname_marketplace %} purchase information. -`marketplace_purchase` 对象含有以下键： +The `marketplace_purchase` object has the following keys: -| 键 | 类型 | 描述 | -| -------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `帐户` | `对象` | 与订阅关联的 `organization` 或 `user` 帐户。 组织帐户将包含 `Organization_billing_email`, 这是组织的行政电子邮件地址。 要查找个人帐户的电子邮件地址，您可以使用[获取经过身份验证的用户](/rest/reference/users#get-the-authenticated-user)端点。 | -| `billing_cycle` | `字符串` | 可以是 `yearly` 或 `monthly`。 如果 `account` 所有者拥有免费 GitHub 计划并且购买了免费 {% data variables.product.prodname_marketplace %} 计划，则 `billing_cycle` 将为 `nil`。 | -| `unit_count` | `整数` | 购买的单位数。 | -| `on_free_trial` | `布尔值` | 当 `account` 处于免费试用期时，该值为 `true`。 | -| `free_trial_ends_on` | `字符串` | 免费试用到期日期。 | -| `next_billing_date` | `字符串` | 下一个结算周期开始日期。 如果 `account` 所有者拥有免费 GitHub.com 计划并且购买了免费 {% data variables.product.prodname_marketplace %} 计划，则 `next_billing_date` 将为 `nil`。 | -| `plan` | `对象` | `user` 或 `organization` 购买的计划。 | +Key | Type | Description +----|------|------------- +`account` | `object` | The `organization` or `user` account associated with the subscription. Organization accounts will include `organization_billing_email`, which is the organization's administrative email address. To find email addresses for personal accounts, you can use the [Get the authenticated user](/rest/reference/users#get-the-authenticated-user) endpoint. +`billing_cycle` | `string` | Can be `yearly` or `monthly`. When the `account` owner has a free GitHub plan and has purchased a free {% data variables.product.prodname_marketplace %} plan, `billing_cycle` will be `nil`. +`unit_count` | `integer` | Number of units purchased. +`on_free_trial` | `boolean` | `true` when the `account` is on a free trial. +`free_trial_ends_on` | `string` | The date the free trial will expire. +`next_billing_date` | `string` | The date that the next billing cycle will start. When the `account` owner has a free GitHub.com plan and has purchased a free {% data variables.product.prodname_marketplace %} plan, `next_billing_date` will be `nil`. +`plan` | `object` | The plan purchased by the `user` or `organization`. -`plan` 对象含有以下键： +The `plan` object has the following keys: -| 键 | 类型 | 描述 | -| ------------------------ | ------- | -------------------------------------------------- | -| `id` | `整数` | 此计划的唯一标识符。 | -| `name` | `字符串` | 计划的名称。 | -| `说明` | `字符串` | 此计划的说明。 | -| `monthly_price_in_cents` | `整数` | 此计划的每月价格（以美分为单位）。 例如，每月费用 10 美元的商品将显示价格 1000 美分。 | -| `yearly_price_in_cents` | `整数` | 此计划的每年价格（以美分为单位）。 例如，每月费用 100 美元的商品将显示价格 10000 美分。 | -| `price_model` | `字符串` | 此商品的定价模型。 可以是 `flat-rate`、`per-unit` 或 `free` 之一。 | -| `has_free_trial` | `布尔值` | 当此商品提供免费试用时，该值为 `true`。 | -| `unit_name` | `字符串` | 单位的名称。 如果定价模型不是 `per-unit`，则该值为 `nil`。 | -| `bullet` | `字符串数组` | 定价计划中设置的项目符号的名称。 | +Key | Type | Description +----|------|------------- +`id` | `integer` | The unique identifier for this plan. +`name` | `string` | The plan's name. +`description` | `string` | This plan's description. +`monthly_price_in_cents` | `integer` | The monthly price of this plan in cents (US currency). For example, a listing that costs 10 US dollars per month will be 1000 cents. +`yearly_price_in_cents` | `integer` | The yearly price of this plan in cents (US currency). For example, a listing that costs 100 US dollars per month will be 10000 cents. +`price_model` | `string` | The pricing model for this listing. Can be one of `flat-rate`, `per-unit`, or `free`. +`has_free_trial` | `boolean` | `true` when this listing offers a free trial. +`unit_name` | `string` | The name of the unit. If the pricing model is not `per-unit` this will be `nil`. +`bullet` | `array of strings` | The names of the bullets set in the pricing plan.
-### `purchased` 事件的 web 挂钩有效负载示例 -此示例提供 `purchased` 事件有效负载。 +### Example webhook payload for a `purchased` event +This example provides the `purchased` event payload. {{ webhookPayloadsForCurrentVersion.marketplace_purchase.purchased }} -### `changed` 事件的 web 挂钩有效负载示例 +### Example webhook payload for a `changed` event -计划中的更改包括升级和降级。 此示例表示 `changed`、`pending_change` 和 `pending_change_cancelled` 事件有效负载。 该操作标识这三个事件中发生了哪一个。 +Changes in a plan include upgrades and downgrades. This example represents the `changed`,`pending_change`, and `pending_change_cancelled` event payloads. The action identifies which of these three events has occurred. {{ webhookPayloadsForCurrentVersion.marketplace_purchase.changed }} -### `cancelled` 事件的 web 挂钩有效负载示例 +### Example webhook payload for a `cancelled` event {{ webhookPayloadsForCurrentVersion.marketplace_purchase.cancelled }} diff --git a/translations/zh-CN/content/developers/overview/managing-deploy-keys.md b/translations/zh-CN/content/developers/overview/managing-deploy-keys.md index b651619a2c..6d51247d42 100644 --- a/translations/zh-CN/content/developers/overview/managing-deploy-keys.md +++ b/translations/zh-CN/content/developers/overview/managing-deploy-keys.md @@ -2,7 +2,7 @@ title: Managing deploy keys intro: Learn different ways to manage SSH keys on your servers when you automate deployment scripts and which way is best for you. redirect_from: - - /guides/managing-deploy-keys/ + - /guides/managing-deploy-keys - /v3/guides/managing-deploy-keys versions: fpt: '*' diff --git a/translations/zh-CN/content/developers/overview/replacing-github-services.md b/translations/zh-CN/content/developers/overview/replacing-github-services.md index 9869efb646..7e39883b4a 100644 --- a/translations/zh-CN/content/developers/overview/replacing-github-services.md +++ b/translations/zh-CN/content/developers/overview/replacing-github-services.md @@ -1,9 +1,9 @@ --- -title: 替换 GitHub 服务 -intro: '如果您仍然依赖已弃用的 {% data variables.product.prodname_dotcom %} 服务，请了解如何将服务挂钩迁移到 web 挂钩。' +title: Replacing GitHub Services +intro: 'If you''re still relying on the deprecated {% data variables.product.prodname_dotcom %} Services, learn how to migrate your service hooks to webhooks.' redirect_from: - - /guides/replacing-github-services/ - - /v3/guides/automating-deployments-to-integrators/ + - /guides/replacing-github-services + - /v3/guides/automating-deployments-to-integrators - /v3/guides/replacing-github-services versions: fpt: '*' @@ -14,61 +14,61 @@ topics: --- -我们弃用了 GitHub 服务，转而支持与 web 挂钩集成。 本指南可帮助您从 GitHub 服务过渡到 web 挂钩。 有关此公告的更多信息，请参阅[博客文章](https://developer.github.com/changes/2018-10-01-denying-new-github-services)。 +We have deprecated GitHub Services in favor of integrating with webhooks. This guide helps you transition to webhooks from GitHub Services. For more information on this announcement, see the [blog post](https://developer.github.com/changes/2018-10-01-denying-new-github-services). {% note %} -作为电子邮件服务的替代方法，您现在可以开始使用推送到仓库的电子邮件通知。 有关如何配置提交电子邮件通知，请参阅“[关于推送到仓库的电子邮件通知](/github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository/)”。 +As an alternative to the email service, you can now start using email notifications for pushes to your repository. See "[About email notifications for pushes to your repository](/github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository/)" to learn how to configure commit email notifications. {% endnote %} -## 弃用时间表 +## Deprecation timeline -- **2018 年 10 月 1 日**：GitHub 停止允许用户安装服务。 我们从 GitHub.com 用户界面中删除了 GitHub 服务。 -- **2019 年 1 月 29 日**：作为电子邮件服务的替代方法，您现在可以开始使用推送到仓库的电子邮件通知。 有关如何配置提交电子邮件通知，请参阅“[关于推送到仓库的电子邮件通知](/github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository/)”。 -- **2019 年 1 月 31 日**：GitHub 将停止在 GitHub.com 上交付已安装服务的事件。 +- **October 1, 2018**: GitHub discontinued allowing users to install services. We removed GitHub Services from the GitHub.com user interface. +- **January 29, 2019**: As an alternative to the email service, you can now start using email notifications for pushes to your repository. See "[About email notifications for pushes to your repository](/github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository/)" to learn how to configure commit email notifications. +- **January 31, 2019**: GitHub will stop delivering installed services' events on GitHub.com. -## GitHub 服务背景信息 +## GitHub Services background -GitHub 服务（有时称为服务挂钩）是传统的集成方法，其中 GitHub 通过[ `github-services` 仓库](https://github.com/github/github-services)托管集成者的部分服务。 在 GitHub 上执行的操作会触发这些服务，您可以使用这些服务在 GitHub 之外触发操作。 +GitHub Services (sometimes referred to as Service Hooks) is the legacy method of integrating where GitHub hosted a portion of our integrator’s services via [the `github-services` repository](https://github.com/github/github-services). Actions performed on GitHub trigger these services, and you can use these services to trigger actions outside of GitHub. {% ifversion ghes or ghae %} -## 查找使用 GitHub 服务的仓库 -我们提供命令行脚本，帮助您识别设备上哪些仓库使用 GitHub 服务。 更多信息请参阅 [ghe-legacy-github-services-report](/enterprise/{{currentVersion}}/admin/articles/command-line-utilities/#ghe-legacy-github-services-report)。{% endif %} +## Finding repositories that use GitHub Services +We provide a command-line script that helps you identify which repositories on your appliance use GitHub Services. For more information, see [ghe-legacy-github-services-report](/enterprise/{{currentVersion}}/admin/articles/command-line-utilities/#ghe-legacy-github-services-report).{% endif %} -## GitHub 服务与 web 挂钩 +## GitHub Services vs. webhooks -GitHub 服务与 web 挂钩之间的主要区别： -- **配置**：GitHub 服务具有特定于服务的配置选项，而 web 挂钩只需指定 URL 和一组事件即可进行配置。 -- **自定义逻辑**：GitHub 服务可以具有自定义逻辑，在处理单个事件时使用多个操作进行响应，而 web 挂钩没有自定义逻辑。 -- **服务类型**：GitHub 服务可以发出 HTTP 和非 HTTP 请求，而 web 挂钩只能发出 HTTP 请求。 +The key differences between GitHub Services and webhooks: +- **Configuration**: GitHub Services have service-specific configuration options, while webhooks are simply configured by specifying a URL and a set of events. +- **Custom logic**: GitHub Services can have custom logic to respond with multiple actions as part of processing a single event, while webhooks have no custom logic. +- **Types of requests**: GitHub Services can make HTTP and non-HTTP requests, while webhooks can make HTTP requests only. -## 用 web 挂钩替换服务 +## Replacing Services with webhooks -要用 web 挂钩替换 GitHub 服务: +To replace GitHub Services with Webhooks: -1. 从[此列表](/webhooks/#events)确定您需要订阅的相关 web 挂钩事件。 +1. Identify the relevant webhook events you’ll need to subscribe to from [this list](/webhooks/#events). -2. 根据您当前如何使用 GitHub 服务更改您的配置： +2. Change your configuration depending on how you currently use GitHub Services: - - **GitHub 应用程序**：更新应用程序的权限和订阅的事件，以配置应用程序接收相关的 web 挂钩事件。 - - **OAuth 应用程序**：请求 `repo_hook` 和/或 `org_hook` 作用域以代表用户管理相关事件。 - - **GitHub 服务提供商**：请求用户手动配置包含发送给您的相关事件的 web 挂钩，或者借此机会构建一个应用程序来管理此功能。 更多信息请参阅“[关于应用程序](/apps/about-apps/)”。 + - **GitHub Apps**: Update your app's permissions and subscribed events to configure your app to receive the relevant webhook events. + - **OAuth Apps**: Request either the `repo_hook` and/or `org_hook` scope(s) to manage the relevant events on behalf of users. + - **GitHub Service providers**: Request that users manually configure a webhook with the relevant events sent to you, or take this opportunity to build an app to manage this functionality. For more information, see "[About apps](/apps/about-apps/)." -3. 从 GitHub 外部移动额外配置。 某些 GitHub 服务需要在 GitHub 中的配置页面上进行额外的自定义配置。 如果您的服务这样做，则需要将此功能移动到应用程序中，或在适用的情况下依赖 GitHub 或 OAuth 应用程序。 +3. Move additional configuration from outside of GitHub. Some GitHub Services require additional, custom configuration on the configuration page within GitHub. If your service does this, you will need to move this functionality into your application or rely on GitHub or OAuth Apps where applicable. -## 支持 {% data variables.product.prodname_ghe_server %} +## Supporting {% data variables.product.prodname_ghe_server %} -- **{% data variables.product.prodname_ghe_server %} 2.17**：{% data variables.product.prodname_ghe_server %} 2.17 及更高版本将停止允许管理员安装服务。 在 {% data variables.product.prodname_ghe_server %} 2.17 至 2.19 版本中，管理员仍然能够修改现有服务挂钩和接收服务挂钩。 在 {% data variables.product.prodname_ghe_server %} 2.17 及更高版本中，作为电子邮件服务的替代方法，您将能够使用推送到仓库的电子邮件通知。 更多信息请参阅[这篇博客文章](https://developer.github.com/changes/2019-01-29-life-after-github-services)。 -- **{% data variables.product.prodname_ghe_server %} 2.20**：{% data variables.product.prodname_ghe_server %} 2.20 及更高版本将停止交付所有已安装服务的事件。 +- **{% data variables.product.prodname_ghe_server %} 2.17**: {% data variables.product.prodname_ghe_server %} release 2.17 and higher will discontinue allowing admins to install services. Admins will continue to be able to modify existing service hooks and receive service hooks in {% data variables.product.prodname_ghe_server %} release 2.17 through 2.19. As an alternative to the email service, you will be able to use email notifications for pushes to your repository in {% data variables.product.prodname_ghe_server %} 2.17 and higher. See [this blog post](https://developer.github.com/changes/2019-01-29-life-after-github-services) to learn more. +- **{% data variables.product.prodname_ghe_server %} 2.20**: {% data variables.product.prodname_ghe_server %} release 2.20 and higher will stop delivering all installed services' events. -{% data variables.product.prodname_ghe_server %} 2.17 版将是不允许管理员安装 GitHub 服务的第一个版本。 我们将仅支持现有的 GitHub 服务，直到 {% data variables.product.prodname_ghe_server %} 2.20 版本。 我们还将接受 {% data variables.product.prodname_ghe_server %} 上运行的 GitHub 服务的任何重要补丁，直到 2019 年 10 月 1 日。 +The {% data variables.product.prodname_ghe_server %} 2.17 release will be the first release that does not allow admins to install GitHub Services. We will only support existing GitHub Services until the {% data variables.product.prodname_ghe_server %} 2.20 release. We will also accept any critical patches for your GitHub Service running on {% data variables.product.prodname_ghe_server %} until October 1, 2019. -## 在我们的帮助下迁移 +## Migrating with our help -如有任何问题，请[联系我们](https://github.com/contact?form%5Bsubject%5D=GitHub+Services+Deprecation)。 +Please [contact us](https://github.com/contact?form%5Bsubject%5D=GitHub+Services+Deprecation) with any questions. -作为高度概述，迁移过程通常涉及： - - 确定产品使用 GitHub 服务的方式和位置。 - - 确定需要配置的相应 web 挂钩事件，以便移动到普通 web 挂钩。 - - 使用 [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/) 或 [{% data variables.product.prodname_github_apps %} 实现设计。 {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) 优先。 要了解为什么优先使用 {% data variables.product.prodname_github_apps %}，请参阅“[切换到 {% data variables.product.prodname_github_apps %} 的原因](/apps/migrating-oauth-apps-to-github-apps/#reasons-for-switching-to-github-apps)”。 +As a high-level overview, the process of migration typically involves: + - Identifying how and where your product is using GitHub Services. + - Identifying the corresponding webhook events you need to configure in order to move to plain webhooks. + - Implementing the design using either [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/) or [{% data variables.product.prodname_github_apps %}. {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) are preferred. To learn more about why {% data variables.product.prodname_github_apps %} are preferred, see "[Reasons for switching to {% data variables.product.prodname_github_apps %}](/apps/migrating-oauth-apps-to-github-apps/#reasons-for-switching-to-github-apps)." diff --git a/translations/zh-CN/content/developers/overview/secret-scanning-partner-program.md b/translations/zh-CN/content/developers/overview/secret-scanning-partner-program.md index a67ec00631..c1967ee2cc 100644 --- a/translations/zh-CN/content/developers/overview/secret-scanning-partner-program.md +++ b/translations/zh-CN/content/developers/overview/secret-scanning-partner-program.md @@ -3,7 +3,7 @@ title: Secret scanning partner program intro: 'As a service provider, you can partner with {% data variables.product.prodname_dotcom %} to have your secret token formats secured through secret scanning, which searches for accidental commits of your secret format and can be sent to a service provider''s verify endpoint.' miniTocMaxHeadingLevel: 3 redirect_from: - - /partnerships/token-scanning/ + - /partnerships/token-scanning - /partnerships/secret-scanning - /developers/overview/secret-scanning versions: diff --git a/translations/zh-CN/content/developers/overview/using-ssh-agent-forwarding.md b/translations/zh-CN/content/developers/overview/using-ssh-agent-forwarding.md index 50ea38f038..1a5c54cd28 100644 --- a/translations/zh-CN/content/developers/overview/using-ssh-agent-forwarding.md +++ b/translations/zh-CN/content/developers/overview/using-ssh-agent-forwarding.md @@ -1,8 +1,8 @@ --- -title: 使用 SSH 代理转发 -intro: 为简化向服务器的部署，您可以设置 SSH 代理转发以安全地使用本地 SSH 密钥。 +title: Using SSH agent forwarding +intro: 'To simplify deploying to a server, you can set up SSH agent forwarding to securely use local SSH keys.' redirect_from: - - /guides/using-ssh-agent-forwarding/ + - /guides/using-ssh-agent-forwarding - /v3/guides/using-ssh-agent-forwarding versions: fpt: '*' @@ -11,22 +11,22 @@ versions: ghec: '*' topics: - API -shortTitle: SSH 代理转发 +shortTitle: SSH agent forwarding --- -SSH 代理转发可用于简化向服务器的部署。 它允许您使用本地 SSH 密钥，而不是将密钥（不带密码！）放在服务器上。 +SSH agent forwarding can be used to make deploying to a server simple. It allows you to use your local SSH keys instead of leaving keys (without passphrases!) sitting on your server. -如果已设置 SSH 密钥 来与 {% data variables.product.product_name %} 交互，您可能已经熟悉了 `ssh-agent`。 这是一个在后台运行的程序，它将密钥加载到内存中，因此您不需要每次使用密钥时都输入密码。 最妙的是，您可以选择让服务器访问您的本地 `ssh-agent`，就像它们已经在服务器上运行一样。 这有点像要求朋友输入他们的密码，以便您可以使用他们的计算机。 +If you've already set up an SSH key to interact with {% data variables.product.product_name %}, you're probably familiar with `ssh-agent`. It's a program that runs in the background and keeps your key loaded into memory, so that you don't need to enter your passphrase every time you need to use the key. The nifty thing is, you can choose to let servers access your local `ssh-agent` as if they were already running on the server. This is sort of like asking a friend to enter their password so that you can use their computer. -有关 SSH 代理转发的更详细说明，请参阅 [Steve Friedl 的技术提示指南][tech-tips]。 +Check out [Steve Friedl's Tech Tips guide][tech-tips] for a more detailed explanation of SSH agent forwarding. -## 设置 SSH 代理转发 +## Setting up SSH agent forwarding -确保您自己的 SSH 密钥已设置并正常运行。 如果您还没有 SSH 密钥，请使用[我们的 SSH 密钥生成指南][generating-keys]。 +Ensure that your own SSH key is set up and working. You can use [our guide on generating SSH keys][generating-keys] if you've not done this yet. -您可以在终端输入 `ssh -T git@{% ifversion ghes or ghae %}主机名{% else %}github.com{% endif %}` 来测试您的本地密钥是否有效： +You can test that your local key works by entering `ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}` in the terminal: ```shell $ ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %} @@ -35,26 +35,26 @@ $ ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %} > shell access. ``` -开局不错。 让我们设置 SSH 以允许代理转发到您的服务器。 +We're off to a great start. Let's set up SSH to allow agent forwarding to your server. -1. 使用您喜欢的文本编辑器打开位于 `~/.ssh/config` 的文件。 如果此文件不存在，您可以通过在终端输入 `touch ~/.ssh/config` 来创建它。 +1. Using your favorite text editor, open up the file at `~/.ssh/config`. If this file doesn't exist, you can create it by entering `touch ~/.ssh/config` in the terminal. + +2. Enter the following text into the file, replacing `example.com` with your server's domain name or IP: -2. 在文件中输入以下文本，将 `example.com` 替换为服务器的域名或 IP： - Host example.com ForwardAgent yes {% warning %} -**警告：**您可能想使用 `Host *` 这样的通配符将此设置应用于所有 SSH 连接。 但这并不是一个好主意，因为您将与 SSH 到的*每台*服务器共享您的本地 SSH 密钥。 它们无法直接访问密钥，但是在建立连接后，它们可以*像您一样*使用这些密钥。 **您应该只添加您信任的服务器以及打算用于代理转发的服务器。** +**Warning:** You may be tempted to use a wildcard like `Host *` to just apply this setting to all SSH connections. That's not really a good idea, as you'd be sharing your local SSH keys with *every* server you SSH into. They won't have direct access to the keys, but they will be able to use them *as you* while the connection is established. **You should only add servers you trust and that you intend to use with agent forwarding.** {% endwarning %} -## 测试 SSH 代理转发 +## Testing SSH agent forwarding -要测试代理转发是否对您的服务器有效，您可以 SSH 到服务器，然后再次运行 `ssh -T git@{% ifversion ghes or ghae %}主机名{% else %}github.com{% endif %}`。 如果一切正常，您将收到与本地使用相同的提示。 +To test that agent forwarding is working with your server, you can SSH into your server and run `ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}` once more. If all is well, you'll get back the same prompt as you did locally. -如果不确定是否在使用本地密钥，您还可以检查服务器上的 `SSH_AUTH_SOCK` 变量： +If you're unsure if your local key is being used, you can also inspect the `SSH_AUTH_SOCK` variable on your server: ```shell $ echo "$SSH_AUTH_SOCK" @@ -62,7 +62,7 @@ $ echo "$SSH_AUTH_SOCK" > /tmp/ssh-4hNGMk8AZX/agent.79453 ``` -如果未设置变量，则表示代理转发不起作用： +If the variable is not set, it means that agent forwarding is not working: ```shell $ echo "$SSH_AUTH_SOCK" @@ -73,13 +73,13 @@ $ ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %} > Permission denied (publickey). ``` -## SSH 代理转发疑难解答 +## Troubleshooting SSH agent forwarding -以下是排查 SSH 代理转发时需要注意的一些事项。 +Here are some things to look out for when troubleshooting SSH agent forwarding. -### 您必须使用 SSH URL 检出代码 +### You must be using an SSH URL to check out code -SSH 转发仅适用于 SSH URL，而不是 HTTP(s) URL。 检查服务器上的 *.git/config* 文件，并确保 URL 是 SSH 样式的 URL，如下所示： +SSH forwarding only works with SSH URLs, not HTTP(s) URLs. Check the *.git/config* file on your server and ensure the URL is an SSH-style URL like below: ```shell [remote "origin"] @@ -87,13 +87,13 @@ SSH 转发仅适用于 SSH URL，而不是 HTTP(s) URL。 检查服务器上的 fetch = +refs/heads/*:refs/remotes/origin/* ``` -### 您的 SSH 密钥必须在本地有效 +### Your SSH keys must work locally -在通过代理转发使密钥起作用之前，它们必须首先在本地有效。 [我们的 SSH 密钥生成指南][generating-keys]可帮助您在本地设置 SSH 密钥。 +Before you can make your keys work through agent forwarding, they must work locally first. [Our guide on generating SSH keys][generating-keys] can help you set up your SSH keys locally. -### 您的系统必须允许 SSH 代理转发 +### Your system must allow SSH agent forwarding -有时，系统配置不允许 SSH 代理转发。 您可以通过在终端中输入以下命令来检查是否正在使用系统配置文件： +Sometimes, system configurations disallow SSH agent forwarding. You can check if a system configuration file is being used by entering the following command in the terminal: ```shell $ ssh -v example.com @@ -107,7 +107,7 @@ $ exit # Returns to your local command prompt ``` -在上面的示例中，先加载 *~/.ssh/config* 文件，然后读取 */etc/ssh_config* 文件。 通过运行以下命令，我们可以检查该文件以查看它是否覆盖了我们的选项： +In the example above, the file *~/.ssh/config* is loaded first, then */etc/ssh_config* is read. We can inspect that file to see if it's overriding our options by running the following commands: ```shell $ cat /etc/ssh_config @@ -117,17 +117,17 @@ $ cat /etc/ssh_config > ForwardAgent no ``` -在此示例中，我们的 */etc/ssh_config* 文件特别表示 `ForwardAgent no`，这是一种阻止代理转发的方式。 从文件中删除此行应该会使代理转发再次起作用。 +In this example, our */etc/ssh_config* file specifically says `ForwardAgent no`, which is a way to block agent forwarding. Deleting this line from the file should get agent forwarding working once more. -### 您的服务器必须允许入站连接上的 SSH 代理转发 +### Your server must allow SSH agent forwarding on inbound connections -代理转发也可能在您的服务器上被阻止。 您可以通过 SSH 到服务器并运行 `sshd_config` 来检查是否允许代理转发。 此命令的输出应指示 `AllowAgentForwarding` 已设置。 +Agent forwarding may also be blocked on your server. You can check that agent forwarding is permitted by SSHing into the server and running `sshd_config`. The output from this command should indicate that `AllowAgentForwarding` is set. -### 您的本地 `ssh-agent` 必须正在运行 +### Your local `ssh-agent` must be running -在大多数计算机上，操作系统会自动为您启动 `ssh-agent`。 但是在 Windows 上，您需要手动执行此操作。 我们提供了[在每次打开 Git Bash 时如何启动 `ssh-agent` 的指南][autolaunch-ssh-agent]。 +On most computers, the operating system automatically launches `ssh-agent` for you. On Windows, however, you need to do this manually. We have [a guide on how to start `ssh-agent` whenever you open Git Bash][autolaunch-ssh-agent]. -要验证 `ssh-agent` 是否正在您的计算机上运行，请在终端中键入以下命令： +To verify that `ssh-agent` is running on your computer, type the following command in the terminal: ```shell $ echo "$SSH_AUTH_SOCK" @@ -135,15 +135,15 @@ $ echo "$SSH_AUTH_SOCK" > /tmp/launch-kNSlgU/Listeners ``` -### 您的密钥必须可用于 `ssh-agent` +### Your key must be available to `ssh-agent` -您可以通过运行以下命令来检查您的密钥是否对 `ssh-agent` 可见： +You can check that your key is visible to `ssh-agent` by running the following command: ```shell ssh-add -L ``` -如果命令说没有身份可用，则需要添加密钥： +If the command says that no identity is available, you'll need to add your key: ```shell $ ssh-add yourkey @@ -151,7 +151,7 @@ $ ssh-add yourkey {% tip %} -在 MacOS 上，一旦在重新引导过程中重新启动 `ssh-agent`，它将“忘记”该密钥。 但是，您可以使用此命令将 SSH 密钥导入密钥链： +On macOS, `ssh-agent` will "forget" this key, once it gets restarted during reboots. But you can import your SSH keys into Keychain using this command: ```shell $ ssh-add -K yourkey @@ -161,4 +161,5 @@ $ ssh-add -K yourkey [tech-tips]: http://www.unixwiz.net/techtips/ssh-agent-forwarding.html [generating-keys]: /articles/generating-ssh-keys +[ssh-passphrases]: /ssh-key-passphrases/ [autolaunch-ssh-agent]: /github/authenticating-to-github/working-with-ssh-key-passphrases#auto-launching-ssh-agent-on-git-for-windows diff --git a/translations/zh-CN/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/translations/zh-CN/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index 83686ec401..f98ec58b61 100644 --- a/translations/zh-CN/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/translations/zh-CN/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -3,8 +3,8 @@ title: Webhook events and payloads intro: 'For each webhook event, you can review when the event occurs, an example payload, and descriptions about the payload object parameters.' product: '{% data reusables.gated-features.enterprise_account_webhooks %}' redirect_from: - - /early-access/integrations/webhooks/ - - /v3/activity/events/types/ + - /early-access/integrations/webhooks + - /v3/activity/events/types - /webhooks/event-payloads - /developers/webhooks-and-events/webhook-events-and-payloads versions: @@ -1197,8 +1197,9 @@ Key | Type | Description {% ifversion fpt or ghes or ghec %} ## security_advisory -Activity related to a security advisory. A security advisory provides information about security-related vulnerabilities in software on GitHub. The security advisory dataset also powers the GitHub security alerts, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)." -{% endif %} +Activity related to a security advisory that has been reviewed by {% data variables.product.company_short %}. A {% data variables.product.company_short %}-reviewed security advisory provides information about security-related vulnerabilities in software on {% data variables.product.prodname_dotcom %}. + +The security advisory dataset also powers the GitHub {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)." ### Availability @@ -1215,6 +1216,8 @@ Key | Type | Description {{ webhookPayloadsForCurrentVersion.security_advisory.published }} +{% endif %} + {% ifversion fpt or ghec %} ## sponsorship diff --git a/translations/zh-CN/content/get-started/index.md b/translations/zh-CN/content/get-started/index.md index 8917ef270e..8131599b42 100644 --- a/translations/zh-CN/content/get-started/index.md +++ b/translations/zh-CN/content/get-started/index.md @@ -37,6 +37,7 @@ featuredLinks: - /github/getting-started-with-github/signing-up-for-a-new-github-account - /get-started/quickstart/hello-world - /github/getting-started-with-github/set-up-git + - /get-started/learning-about-github/about-versions-of-github-docs - /github/getting-started-with-github/github-glossary - /github/getting-started-with-github/fork-a-repo - /github/getting-started-with-github/keyboard-shortcuts diff --git a/translations/zh-CN/content/get-started/learning-about-github/about-versions-of-github-docs.md b/translations/zh-CN/content/get-started/learning-about-github/about-versions-of-github-docs.md new file mode 100644 index 0000000000..71486683c9 --- /dev/null +++ b/translations/zh-CN/content/get-started/learning-about-github/about-versions-of-github-docs.md @@ -0,0 +1,56 @@ +--- +title: About versions of GitHub Docs +intro: "You can read documentation that reflects the {% data variables.product.company_short %} product you're currently using." +versions: '*' +shortTitle: Docs versions +--- + +## About versions of {% data variables.product.prodname_docs %} + +{% data variables.product.company_short %} offers different products for storing and collaborating on code. The product you use determines which features are available to you. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products)." + +This website, {% data variables.product.prodname_docs %}, provides documentation for all of {% data variables.product.company_short %}'s products. If the content you're reading applies to more than one product, you can choose the version of the documentation that's relevant to you by selecting the product you're currently using. + +At the top of a page on {% data variables.product.prodname_docs %}, select the dropdown menu and click a product. If your browser window is not wide enough to display the full navigation bar, you may need to click {% octicon "three-bars" aria-label="The three bars icon" %} first. + +![Screenshot of the dropdown menu for picking a version of {% data variables.product.prodname_docs %} to view](/assets/images/help/docs/version-picker.png) + +{% note %} + +**Note**: You can try changing the version now. You're viewing {% ifversion ghes %}a{% else %}the{% endif %} {% ifversion fpt %}Free, Pro, & Team{% else %}{% data variables.product.product_name %}{% endif %} version of this article. + +{% endnote %} + +## Determining which {% data variables.product.company_short %} product you use + +You can determine which {% data variables.product.company_short %} product you're currently using by reviewing the URL in the address bar of your browser and the heading for the {% data variables.product.prodname_dotcom %} website you're on. + +You may use more than one {% data variables.product.company_short %} product. For example, you might contribute to open source on {% data variables.product.prodname_dotcom_the_website %} and collaborate on code on your employer's {% data variables.product.prodname_ghe_server %} instance. You may need to view different versions of the same article at different times, depending on the problem you're currently trying to solve. + +### {% data variables.product.prodname_dotcom_the_website %} plans or {% data variables.product.prodname_ghe_cloud %} + +If you access {% data variables.product.prodname_dotcom %} at https://github.com, you're either using the features of a Free, Pro, or Team plan, or you're using {% data variables.product.prodname_ghe_cloud %}. + +In a wide browser window, there is no text that immediately follows the {% data variables.product.company_short %} logo on the left side of the header. + +![Screenshot of the address bar and the {% data variables.product.prodname_dotcom_the_website %} header in a browser](/assets/images/help/docs/header-dotcom.png) + +On {% data variables.product.prodname_dotcom_the_website %}, each account has its own plan. Each personal account has an associated plan that provides access to certain features, and each organization has a different associated plan. If your personal account is a member of an organization on {% data variables.product.prodname_dotcom_the_website %}, you may have access to different features when you use resources owned by that organization than when you use resources owned by your personal account. For more information, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/get-started/learning-about-github/types-of-github-accounts)." + +If you don't know whether an organization uses {% data variables.product.prodname_ghe_cloud %}, ask an organization owner. For more information, see "[Viewing people's roles in an organization](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization)." + +### {% data variables.product.prodname_ghe_server %} + +If you access {% data variables.product.prodname_dotcom %} at a URL other than https://github.com, `https://*.githubenterprise.com`, `https://*.github.us`, or `https://*.ghe.com`, you're using {% data variables.product.prodname_ghe_server %}. For example, you may access {% data variables.product.prodname_ghe_server %} at `https://github.YOUR-COMPANY-NAME.com`. Your administrators may choose a URL that doesn't include the word "{% data variables.product.company_short %}." + +In a wide browser window, the word "Enterprise" immediately follows the {% data variables.product.company_short %} logo on the left side of the header. + +![Screenshot of address bar and {% data variables.product.prodname_ghe_server %} header in a browser](/assets/images/help/docs/header-ghes.png) + +### {% data variables.product.prodname_ghe_managed %} + +If you access {% data variables.product.prodname_dotcom %} at `https://*.githubenterprise.com`, `https://*.github.us`, or `https://*.ghe.com`, you're using {% data variables.product.prodname_ghe_managed %}. + +In a wide browser window, the words "{% data variables.product.prodname_ghe_managed %}" immediately follow the {% data variables.product.company_short %} logo in the header. + +![Address bar and {% data variables.product.prodname_ghe_managed %} header in a browser](/assets/images/help/docs/header-ghae.png) diff --git a/translations/zh-CN/content/get-started/learning-about-github/githubs-products.md b/translations/zh-CN/content/get-started/learning-about-github/githubs-products.md index c5927d487d..a45107bd4c 100644 --- a/translations/zh-CN/content/get-started/learning-about-github/githubs-products.md +++ b/translations/zh-CN/content/get-started/learning-about-github/githubs-products.md @@ -24,6 +24,8 @@ topics: You can see pricing and a full list of features for each product at <{% data variables.product.pricing_url %}>. {% data reusables.products.product-roadmap %} +When you read {% data variables.product.prodname_docs %}, make sure to select the version that reflects your product. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." + ## {% data variables.product.prodname_free_user %} for user accounts With {% data variables.product.prodname_free_team %} for user accounts, you can work with unlimited collaborators on unlimited public repositories with a full feature set, and on unlimited private repositories with a limited feature set. diff --git a/translations/zh-CN/content/get-started/learning-about-github/index.md b/translations/zh-CN/content/get-started/learning-about-github/index.md index 32d67d6de5..5861d232ae 100644 --- a/translations/zh-CN/content/get-started/learning-about-github/index.md +++ b/translations/zh-CN/content/get-started/learning-about-github/index.md @@ -17,10 +17,11 @@ topics: - Security children: - /githubs-products + - /about-versions-of-github-docs - /github-language-support - - /about-github-advanced-security - /types-of-github-accounts - /access-permissions-on-github + - /about-github-advanced-security - /faq-about-changes-to-githubs-plans --- diff --git a/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-ae.md b/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-ae.md index 242d417fe9..013ac1a1af 100644 --- a/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-ae.md +++ b/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-ae.md @@ -16,13 +16,13 @@ You will first need to purchase {% data variables.product.product_name %}. For m {% data reusables.github-ae.initialize-enterprise %} ### 2. Initializing {% data variables.product.product_name %} -After {% data variables.product.company_short %} creates the owner account for {% data variables.product.product_location %} on {% data variables.product.product_name %}, you will receive an email to sign in and complete the initialization. During initialization, you, as the enterprise owner, will name {% data variables.product.product_location %}, configure SAML SSO, create policies for all organizations in {% data variables.product.product_location %}, and configure a support contact for your enterprise members. 更多信息请参阅“[初始化 {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)。” +After {% data variables.product.company_short %} creates the owner account for {% data variables.product.product_location %} on {% data variables.product.product_name %}, you will receive an email to sign in and complete the initialization. During initialization, you, as the enterprise owner, will name {% data variables.product.product_location %}, configure SAML SSO, create policies for all organizations in {% data variables.product.product_location %}, and configure a support contact for your enterprise members. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)." -### 3. 限制网络流量 -You can configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. 更多信息请参阅“[限制到企业的网络流量](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)”。 +### 3. Restricting network traffic +You can configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)." ### 4. Managing identity and access for {% data variables.product.product_location %} -You can centrally manage access to {% data variables.product.product_location %} on {% data variables.product.product_name %} from an identity provider (IdP) using SAML single sign-on (SSO) for user authentication and System for Cross-domain Identity Management (SCIM) for user provisioning. Once you configure provisioning, you can assign or unassign users to the application from the IdP, creating or disabling user accounts in the enterprise. 更多信息请参阅“[关于企业的身份和访问权限管理](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)”。 +You can centrally manage access to {% data variables.product.product_location %} on {% data variables.product.product_name %} from an identity provider (IdP) using SAML single sign-on (SSO) for user authentication and System for Cross-domain Identity Management (SCIM) for user provisioning. Once you configure provisioning, you can assign or unassign users to the application from the IdP, creating or disabling user accounts in the enterprise. For more information, see "[About identity and access management for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)." ### 5. Managing billing for {% data variables.product.product_location %} Owners of the subscription for {% data variables.product.product_location %} on {% data variables.product.product_name %} can view billing details for {% data variables.product.product_name %} in the Azure portal. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." @@ -33,13 +33,13 @@ As an enterprise owner for {% data variables.product.product_name %}, you can ma ### 1. Managing members of {% data variables.product.product_location %} {% data reusables.getting-started.managing-enterprise-members %} -### 2. 创建组织 +### 2. Creating organizations {% data reusables.getting-started.creating-organizations %} ### 3. Adding members to organizations {% data reusables.getting-started.adding-members-to-organizations %} -### 4. 创建团队 +### 4. Creating teams {% data reusables.getting-started.creating-teams %} ### 5. Setting organization and repository permission levels @@ -73,8 +73,11 @@ For more information on enabling and configuring {% data variables.product.prodn ## Part 5: Using {% data variables.product.prodname_dotcom %}'s learning and support resources Your enterprise members can learn more about Git and {% data variables.product.prodname_dotcom %} with our learning resources, and you can get the support you need with {% data variables.product.prodname_dotcom %} Enterprise Support. -### 1. Learning with {% data variables.product.prodname_learning %} +### 1. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %} +You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_managed %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." + +### 2. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab-enterprise %} -### 2. Working with {% data variables.product.prodname_dotcom %} Enterprise Support +### 3. Working with {% data variables.product.prodname_dotcom %} Enterprise Support {% data reusables.getting-started.contact-support-enterprise %} diff --git a/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md b/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md index d8227e1740..9598e02d65 100644 --- a/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md +++ b/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md @@ -199,14 +199,18 @@ Members of your organization or enterprise can use tools from the {% data variab ## Part 7: Participating in {% data variables.product.prodname_dotcom %}'s community Members of your organization or enterprise can use GitHub's learning and support resources to get the help they need. You can also support the open source community. -### 1. Learning with {% data variables.product.prodname_learning %} + +### 1. Reading about {% data variables.product.prodname_ghe_cloud %} on {% data variables.product.prodname_docs %} +You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." + +### 2. Learning with {% data variables.product.prodname_learning %} Members of your organization or enterprise can learn new skills by completing fun, realistic projects in your very own GitHub repository with [{% data variables.product.prodname_learning %}](https://lab.github.com/). Each course is a hands-on lesson created by the GitHub community and taught by the friendly Learning Lab bot. For more information, see "[Git and {% data variables.product.prodname_dotcom %} learning resources](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)." -### 2. Supporting the open source community +### 3. Supporting the open source community {% data reusables.getting-started.sponsors %} -### 3. Contacting {% data variables.contact.github_support %} +### 4. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} {% data variables.product.prodname_ghe_cloud %} allows you to submit priority support requests with a target eight-hour response time. For more information, see "[{% data variables.product.prodname_ghe_cloud %} support](/github/working-with-github-support/github-enterprise-cloud-support)." diff --git a/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-enterprise-server.md b/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-enterprise-server.md index d990deaa7d..4637e3b623 100644 --- a/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-enterprise-server.md +++ b/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-enterprise-server.md @@ -1,5 +1,5 @@ --- -title: 开始使用 GitHub Enterprise Server +title: Getting started with GitHub Enterprise Server intro: 'Get started with setting up and managing {% data variables.product.product_location %}.' versions: ghes: '*' @@ -16,31 +16,31 @@ This guide will walk you through setting up, configuring and managing {% data va For an overview of how {% data variables.product.product_name %} works, see "[System overview](/admin/overview/system-overview)." -## 第 1 部分：安装 {% data variables.product.product_name %} -To get started with {% data variables.product.product_name %}, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing. +## Part 1: Installing {% data variables.product.product_name %} +To get started with {% data variables.product.product_name %}, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing. ### 1. Creating your enterprise account -Before you install {% data variables.product.product_name %}, you can create an enterprise account on {% data variables.product.prodname_dotcom_the_website %} by contacting [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). An enterprise account on {% data variables.product.prodname_dotcom_the_website %} is useful for billing and for shared features with {% data variables.product.prodname_dotcom_the_website %} via {% data variables.product.prodname_github_connect %}. 更多信息请参阅“[关于企业帐户](/admin/overview/about-enterprise-accounts)”。 -### 2. 安装 {% data variables.product.product_name %} -To get started with {% data variables.product.product_name %}, you will need to install the appliance on a virtualization platform of your choice. 更多信息请参阅“[设置 {% data variables.product.prodname_ghe_server %} 实例](/admin/installation/setting-up-a-github-enterprise-server-instance)”。 +Before you install {% data variables.product.product_name %}, you can create an enterprise account on {% data variables.product.prodname_dotcom_the_website %} by contacting [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). An enterprise account on {% data variables.product.prodname_dotcom_the_website %} is useful for billing and for shared features with {% data variables.product.prodname_dotcom_the_website %} via {% data variables.product.prodname_github_connect %}. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." +### 2. Installing {% data variables.product.product_name %} +To get started with {% data variables.product.product_name %}, you will need to install the appliance on a virtualization platform of your choice. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/admin/installation/setting-up-a-github-enterprise-server-instance)." ### 3. Using the Management Console You will use the Management Console to walk through the initial setup process when first launching {% data variables.product.product_location %}. You can also use the Management Console to manage instance settings such as the license, domain, authentication, and TLS. For more information, see "[Accessing the management console](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)." -### 4. 配置 {% data variables.product.product_location %} +### 4. Configuring {% data variables.product.product_location %} In addition to the Management Console, you can use the site admin dashboard and the administrative shell (SSH) to manage {% data variables.product.product_location %}. For example, you can configure applications and rate limits, view reports, use command-line utilities. For more information, see "[Configuring your enterprise](/admin/configuration/configuring-your-enterprise)." -You can use the default network settings used by {% data variables.product.product_name %} via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. 您还可以配置代理服务器或防火墙规则。 For more information, see "[Configuring network settings](/admin/configuration/configuring-network-settings)." +You can use the default network settings used by {% data variables.product.product_name %} via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. You can also configure a proxy server or firewall rules. For more information, see "[Configuring network settings](/admin/configuration/configuring-network-settings)." -### 5. 配置高可用性 +### 5. Configuring high availability You can configure {% data variables.product.product_location %} for high availability to minimize the impact of hardware failures and network outages. For more information, see "[Configuring high availability](/admin/enterprise-management/configuring-high-availability)." -### 6. 设置暂存实例 -You can set up a staging instance to test modifications, plan for disaster recovery, and try out updates before applying them to {% data variables.product.product_location %}. 更多信息请参阅“[设置暂存实例](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)”。 +### 6. Setting up a staging instance +You can set up a staging instance to test modifications, plan for disaster recovery, and try out updates before applying them to {% data variables.product.product_location %}. For more information, see "[Setting up a staging instance](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)." ### 7. Designating backups and disaster recovery -To protect your production data, you can configure automated backups of {% data variables.product.product_location %} with {% data variables.product.prodname_enterprise_backup_utilities %}. 更多信息请参阅“[在设备上配置备份](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance)”。 +To protect your production data, you can configure automated backups of {% data variables.product.product_location %} with {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see "[Configuring backups on your appliance](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance)." -### 8. 管理企业的帐单 +### 8. Managing billing for your enterprise Billing for all the organizations and {% data variables.product.product_name %} instances connected to your enterprise account is aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom %}.com services. Enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." ## Part 2: Organizing and managing your team @@ -49,13 +49,13 @@ As an enterprise owner or administrator, you can manage settings on user, reposi ### 1. Managing members of {% data variables.product.product_location %} {% data reusables.getting-started.managing-enterprise-members %} -### 2. 创建组织 +### 2. Creating organizations {% data reusables.getting-started.creating-organizations %} ### 3. Adding members to organizations {% data reusables.getting-started.adding-members-to-organizations %} -### 4. 创建团队 +### 4. Creating teams {% data reusables.getting-started.creating-teams %} ### 5. Setting organization and repository permission levels @@ -88,7 +88,7 @@ You can upgrade your {% data variables.product.product_name %} license to includ You can customize and automate work in organizations in your enterprise with {% data variables.product.prodname_dotcom %} and {% data variables.product.prodname_oauth_apps %}, {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, {% data variables.product.prodname_actions %}, {% data variables.product.prodname_registry %} , and {% data variables.product.prodname_pages %}. ### 1. Building {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} -You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, such as {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, for use in organizations in your enterprise to complement and extend your workflows. 更多信息请参阅“[关于应用程序](/developers/apps/getting-started-with-apps/about-apps)”。 +You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, such as {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, for use in organizations in your enterprise to complement and extend your workflows. For more information, see "[About apps](/developers/apps/getting-started-with-apps/about-apps)." ### 2. Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API {% data reusables.getting-started.api %} @@ -98,7 +98,7 @@ You can build integrations with the {% ifversion fpt or ghec %}{% data variables For more information on enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.product_name %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)." -### 4. Publishing and managing {% data variables.product.prodname_registry %} +### 4. Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} For more information on enabling and configuring {% data variables.product.prodname_registry %} for {% data variables.product.product_location %}, see "[Getting started with {% data variables.product.prodname_registry %} for your enterprise](/admin/packages/getting-started-with-github-packages-for-your-enterprise)." @@ -110,11 +110,17 @@ For more information on enabling and configuring {% data variables.product.prodn ## Part 5: Connecting with other {% data variables.product.prodname_dotcom %} resources You can use {% data variables.product.prodname_github_connect %} to share resources. -If you are the owner of both a {% data variables.product.product_name %} instance and a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account, you can enable {% data variables.product.prodname_github_connect %}. {% data variables.product.prodname_github_connect %} allows you to share specific workflows and features between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}, such as unified search and contributions. 更多信息请参阅“[将 {% data variables.product.prodname_ghe_server %} 连接到 {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud)”。 +If you are the owner of both a {% data variables.product.product_name %} instance and a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account, you can enable {% data variables.product.prodname_github_connect %}. {% data variables.product.prodname_github_connect %} allows you to share specific workflows and features between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}, such as unified search and contributions. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud)." ## Part 6: Using {% data variables.product.prodname_dotcom %}'s learning and support resources Your enterprise members can learn more about Git and {% data variables.product.prodname_dotcom %} with our learning resources, and you can get the support you need when setting up and managing {% data variables.product.product_location %} with {% data variables.product.prodname_dotcom %} Enterprise Support. -### 1. Learning with {% data variables.product.prodname_learning %} + +### 1. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %} + +You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_server %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." + +### 2. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab-enterprise %} -### 2. Working with {% data variables.product.prodname_dotcom %} Enterprise Support + +### 3. Working with {% data variables.product.prodname_dotcom %} Enterprise Support {% data reusables.getting-started.contact-support-enterprise %} diff --git a/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-team.md b/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-team.md index 08589922d5..27e6ee5e6a 100644 --- a/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-team.md +++ b/translations/zh-CN/content/get-started/onboarding/getting-started-with-github-team.md @@ -10,16 +10,16 @@ This guide will walk you through setting up, configuring and managing your {% da ## Part 1: Configuring your account on {% data variables.product.product_location %} As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a user account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing. -### 1. 关于组织 -组织是共享帐户，其中业务和开源项目可一次协助处理多个项目。 所有者和管理员可通过复杂的安全和管理功能管理成员对组织数据和项目的访问。 For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)." +### 1. About organizations +Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)." ### 2. Creating an organization and signing up for {% data variables.product.prodname_team %} -Before creating an organization, you will need to create a user account or log in to your existing account on {% data variables.product.product_location %}. 更多信息请参阅“[注册新 {% data variables.product.prodname_dotcom %} 帐户](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)”。 +Before creating an organization, you will need to create a user account or log in to your existing account on {% data variables.product.product_location %}. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)." -Once your user account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. 更多信息请参阅“[从头开始创建新组织](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)”。 +Once your user account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." ### 3. Managing billing for an organization -You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. 更多信息请参阅“[在不同帐户的设置之间切换](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)”。 +You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. For more information, see "[Switching between settings for your different accounts](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)." Your organization's billing settings page allows you to manage settings like your payment method, billing cycle and billing email, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and GitHub Actions minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)." @@ -72,7 +72,7 @@ You can help to make your organization more secure by recommending or requiring ### 3. Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -### 4. Publishing and managing {% data variables.product.prodname_registry %} +### 4. Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} ## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community @@ -83,14 +83,17 @@ You can help to make your organization more secure by recommending or requiring ### 2. Interacting with the {% data variables.product.prodname_gcf %} {% data reusables.support.ask-and-answer-forum %} -### 3. Learning with {% data variables.product.prodname_learning %} +### 3. Reading about {% data variables.product.prodname_team %} on {% data variables.product.prodname_docs %} +You can read documentation that reflects the features available with {% data variables.product.prodname_team %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." + +### 4. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab %} -### 4. Supporting the open source community +### 5. Supporting the open source community {% data reusables.getting-started.sponsors %} -### 5. 联系 {% data variables.contact.github_support %} +### 6. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} -## 延伸阅读 +## Further reading - "[Getting started with your GitHub account](/get-started/onboarding/getting-started-with-your-github-account)" diff --git a/translations/zh-CN/content/get-started/onboarding/getting-started-with-your-github-account.md b/translations/zh-CN/content/get-started/onboarding/getting-started-with-your-github-account.md index 3dbb2d454f..245a75c61f 100644 --- a/translations/zh-CN/content/get-started/onboarding/getting-started-with-your-github-account.md +++ b/translations/zh-CN/content/get-started/onboarding/getting-started-with-your-github-account.md @@ -23,18 +23,18 @@ The first steps in starting with {% data variables.product.product_name %} are t {% ifversion fpt or ghec %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif %} Every person who uses {% data variables.product.product_name %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. {% ifversion fpt or ghec %} -### 1. 创建帐户 +### 1. Creating an account To sign up for an account on {% data variables.product.product_location %}, navigate to https://github.com/ and follow the prompts. -To keep your {% data variables.product.prodname_dotcom %} account secure you should use a strong and unique password. 更多信息请参阅“[创建强式密码](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-strong-password)”。 +To keep your {% data variables.product.prodname_dotcom %} account secure you should use a strong and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-strong-password)." ### 2. Choosing your {% data variables.product.prodname_dotcom %} product You can choose {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_pro %} to get access to different features for your personal account. You can upgrade at any time if you are unsure at first which product you want. For more information on all of {% data variables.product.prodname_dotcom %}'s plans, see "[{% data variables.product.prodname_dotcom %}'s products](/get-started/learning-about-github/githubs-products)." -### 3. 验证电子邮件地址 -To ensure you can use all the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. 更多信息请参阅“[验证电子邮件地址](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)”。 +### 3. Verifying your email address +To ensure you can use all the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." {% endif %} {% ifversion ghes %} @@ -49,37 +49,37 @@ You will receive an email notification once your enterprise owner for {% data va {% ifversion fpt or ghes or ghec %} ### {% ifversion fpt or ghec %}4.{% else %}2.{% endif %} Configuring two-factor authentication -双重身份验证（或 2FA）是登录网站或应用时使用的额外保护层。 We strongly urge you to configure 2FA for the safety of your account. 更多信息请参阅“[关于双重身份验证](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)”。 +Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." {% endif %} ### {% ifversion fpt or ghec %}5.{% elsif ghes %}3.{% else %}2.{% endif %} Viewing your {% data variables.product.prodname_dotcom %} profile and contribution graph Your {% data variables.product.prodname_dotcom %} profile tells people the story of your work through the repositories and gists you've pinned, the organization memberships you've chosen to publicize, the contributions you've made, and the projects you've created. For more information, see "[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and "[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." ## Part 2: Using {% data variables.product.product_name %}'s tools and processes -To best use {% data variables.product.product_name %}, you'll need to set up Git. Git 负责在您计算机上本地发生的、与 {% data variables.product.prodname_dotcom %} 有关的所有内容。 To effectively collaborate on {% data variables.product.product_name %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. +To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.product_name %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. ### 1. Learning Git {% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository to {% data variables.product.product_name %} for other people to view, fetch, and update using Git. For more information about Git, see the "[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see "[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)." -### 2. 设置 Git -If you plan to use Git locally on your computer, whether through the command line, an IDE or text editor, you will need to install and set up Git. 更多信息请参阅“[设置 Git](/get-started/quickstart/set-up-git)”。 +### 2. Setting up Git +If you plan to use Git locally on your computer, whether through the command line, an IDE or text editor, you will need to install and set up Git. For more information, see "[Set up Git](/get-started/quickstart/set-up-git)." -If you prefer to use a visual interface, you can download and use {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} comes packaged with Git, so there is no need to install Git separately. 更多信息请参阅“[开始使用 {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)”。 +If you prefer to use a visual interface, you can download and use {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} comes packaged with Git, so there is no need to install Git separately. For more information, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." -Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. 更多信息请参阅“[关于远程仓库](/get-started/getting-started-with-git/about-remote-repositories)”。 +Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/get-started/getting-started-with-git/about-remote-repositories)." ### 3. Choosing how to interact with {% data variables.product.product_name %} Everyone has their own unique workflow for interacting with {% data variables.product.prodname_dotcom %}; the interfaces and methods you use depend on your preference and what works best for your needs. For more information about how to authenticate to {% data variables.product.product_name %} with each of these methods, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github)." -| **方法** | **描述** | **Use cases** | -| ------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests. | This method is useful if you want a visual interface and need to do quick, simple changes that don't require working locally. | -| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} 可扩展并简化您的 {% data variables.product.prodname_dotcom_the_website %} 工作流程，它使用可视界面，而不是在命令行上使用命令文本。 For more information on getting started with {% data variables.product.prodname_desktop %}, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | -| IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | -| Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)."

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)." | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | -| {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)." | The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | +| **Method** | **Description** | **Use cases** | +| ------------- | ------------- | ------------- | +| Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes that don't require working locally. | +| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | +| IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | +| Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)."

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)." | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | +| {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)." | The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | ### 4. Writing on {% data variables.product.product_name %} -To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown for formatting, which combines an easy-to-read, easy-to-write syntax with some custom functionality. 更多信息请参阅“[关于 {% data variables.product.prodname_dotcom %} 上的书写和格式化](/github/writing-on-github/about-writing-and-formatting-on-github)”。 +To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown for formatting, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)." You can learn {% data variables.product.prodname_dotcom %} Flavored Markdown with the "[Communicating using Markdown](https://lab.github.com/githubtraining/communicating-using-markdown)" course on {% data variables.product.prodname_learning %}. @@ -96,49 +96,49 @@ Any number of people can work together in repositories across {% data variables. ### 1. Working with repositories -#### 创建仓库 -仓库就像项目的文件夹。 You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. 更多信息请参阅“[关于仓库](/github/creating-cloning-and-archiving-repositories/about-repositories)”。 +#### Creating a repository +A repository is like a folder for your project. You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)." -When you create a new repository, you should initialize the repository with a README file to let people know about your project. 更多信息请参阅“[创建新仓库](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)”。 +When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)." -#### 克隆仓库 -You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. 克隆仓库将提取 {% data variables.product.prodname_dotcom %} 在当时拥有的所有仓库数据的完整副本，包括项目每个文件和文件夹的所有版本。 更多信息请参阅“[克隆仓库](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)”。 +#### Cloning a repository +You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. Cloning a repository pulls down a full copy of all the repository data that {% data variables.product.prodname_dotcom %} has at that point in time, including all versions of every file and folder for the project. For more information, see "[Cloning a repository](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)." -#### 复刻仓库 -A fork is a copy of a repository that you manage, where any changes you make will not affect the original repository unless you submit a pull request to the project owner. 复刻最常见的用法是对其他人的项目提出更改或将其他人的项目用作自己创意的起点。 更多信息请参阅“[使用复刻](/github/collaborating-with-pull-requests/working-with-forks)”。 -### 2. 导入项目 +#### Forking a repository +A fork is a copy of a repository that you manage, where any changes you make will not affect the original repository unless you submit a pull request to the project owner. Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)." +### 2. Importing your projects If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.prodname_dotcom %} Importer, the command line, or external migration tools. For more information, see "[Importing source code to {% data variables.product.prodname_dotcom %}](/github/importing-your-projects-to-github/importing-source-code-to-github)." ### 3. Managing collaborators and permissions -您可以使用仓库议题、拉取请求及项目板与其他人协作处理您的项目。 You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. 更多信息请参阅“[邀请协作者参加个人仓库](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)”。 +You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)." -You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. 更多信息请参阅“[用户帐户仓库的权限级别](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)”。 +You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)." -### 4. 管理仓库设置 -As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. 更多信息请参阅“[管理仓库设置](/github/administering-a-repository/managing-repository-settings)”。 +### 4. Managing repository settings +As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see "[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." -### 5. 设置项目的健康贡献 +### 5. Setting up your project for healthy contributions {% ifversion fpt or ghec %} To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see "[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides. -By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. 更多信息请参阅“[设置健康参与的项目](/communities/setting-up-your-project-for-healthy-contributions)”。 +By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} {% ifversion ghes or ghae %} -By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. 更多信息请参阅“[设置健康参与的项目](/communities/setting-up-your-project-for-healthy-contributions)”。 +By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} ### 6. Using GitHub Issues and project boards You can use GitHub Issues to organize your work with issues and pull requests and manage your workflow with project boards. For more information, see "[About issues](/issues/tracking-your-work-with-issues/about-issues)" and "[About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." ### 7. Managing notifications -Notifications provide updates about the activity on {% data variables.product.prodname_dotcom %} you've subscribed to or participated in. 如果您的某项对话不再感兴趣，您可以取消订阅、取消关注或自定义以后接收的通知类型。 更多信息请参阅“[关于通知](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)”。 +Notifications provide updates about the activity on {% data variables.product.prodname_dotcom %} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)." -### 8. 使用 {% data variables.product.prodname_pages %} -You can use {% data variables.product.prodname_pages %} to create and host a website directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. 更多信息请参阅“[关于 {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)”。 +### 8. Working with {% data variables.product.prodname_pages %} +You can use {% data variables.product.prodname_pages %} to create and host a website directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." {% ifversion fpt or ghec %} -### 9. 使用 {% data variables.product.prodname_discussions %} -You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. 更多信息请参阅“[关于讨论](/discussions/collaborating-with-your-community-using-discussions/about-discussions)”。 +### 9. Using {% data variables.product.prodname_discussions %} +You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." {% endif %} ## Part 4: Customizing and automating your work on {% data variables.product.product_name %} @@ -154,20 +154,20 @@ You can enable {% data variables.product.prodname_discussions %} for your reposi ### {% ifversion fpt or ghec %}3.{% else %}2.{% endif %} Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -### {% ifversion fpt or ghec %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} +### {% ifversion fpt or ghec %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} ## Part 5: Building securely on {% data variables.product.product_name %} {% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." -### 1. 保护您的仓库 -As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed. +### 1. Securing your repository +As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed. For more information on steps you can take to secure your repositories, see "[Securing your repository](/code-security/getting-started/securing-your-repository)." {% ifversion fpt or ghec %} ### 2. Managing your dependencies -A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies. +A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies. For more information, see "[Securing your software supply chain](/code-security/supply-chain-security)." {% endif %} @@ -182,18 +182,22 @@ For more information, see "[Securing your software supply chain](/code-security/ ### 2. Interacting with {% data variables.product.prodname_gcf %} {% data reusables.support.ask-and-answer-forum %} -### 3. Learning with {% data variables.product.prodname_learning %} +### 3. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %} + +{% data reusables.docs.you-can-read-docs-for-your-product %} + +### 4. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab %} {% ifversion fpt or ghec %} -### 4. Supporting the open source community +### 5. Supporting the open source community {% data reusables.getting-started.sponsors %} -### 5. 联系 {% data variables.contact.github_support %} +### 6. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} {% ifversion fpt %} -## 延伸阅读 -- "[开始使用 {% data variables.product.prodname_team %}](/get-started/onboarding/getting-started-with-github-team)" +## Further reading +- "[Getting started with {% data variables.product.prodname_team %}](/get-started/onboarding/getting-started-with-github-team)" {% endif %} {% endif %} diff --git a/translations/zh-CN/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md b/translations/zh-CN/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md index 0a60c0a9d2..f5c9633c79 100644 --- a/translations/zh-CN/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md +++ b/translations/zh-CN/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md @@ -56,6 +56,8 @@ Before you can try {% data variables.product.prodname_ghe_cloud %}, you must be After setting up your trial, you can explore {% data variables.product.prodname_ghe_cloud %} by following the [Enterprise Onboarding Guide](https://resources.github.com/enterprise-onboarding/). +{% data reusables.docs.you-can-read-docs-for-your-product %} + {% data reusables.products.product-roadmap %} ## Finishing your trial diff --git a/translations/zh-CN/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md b/translations/zh-CN/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md index 6b47866c00..1328f54580 100644 --- a/translations/zh-CN/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md +++ b/translations/zh-CN/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md @@ -41,6 +41,7 @@ To get the most out of your trial, follow these steps: - [Quick start guide to {% data variables.product.prodname_dotcom %}](https://resources.github.com/webcasts/Quick-start-guide-to-GitHub/) webcast - [Understanding the {% data variables.product.prodname_dotcom %} flow](https://guides.github.com/introduction/flow/) in {% data variables.product.prodname_dotcom %} Guides - [Hello World](https://guides.github.com/activities/hello-world/) in {% data variables.product.prodname_dotcom %} Guides + - "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)" 3. To configure your instance to meet your organization's needs, see "[Configuring your enterprise](/enterprise-server@latest/admin/configuration/configuring-your-enterprise)." 4. To integrate {% data variables.product.prodname_ghe_server %} with your identity provider, see "[Using SAML](/enterprise-server@latest/admin/user-management/using-saml)" and "[Using LDAP](/enterprise-server@latest/admin/authentication/using-ldap)." 5. Invite an unlimited number of people to join your trial. diff --git a/translations/zh-CN/content/issues/index.md b/translations/zh-CN/content/issues/index.md index 97d3379825..7b78e0992a 100644 --- a/translations/zh-CN/content/issues/index.md +++ b/translations/zh-CN/content/issues/index.md @@ -1,7 +1,7 @@ --- title: GitHub Issues shortTitle: GitHub Issues -intro: '了解如何使用 {% data variables.product.prodname_github_issues %} 来规划和跟踪您的工作。' +intro: 'Learn how you can use {% data variables.product.prodname_github_issues %} to plan and track your work.' introLinks: overview: /issues/tracking-your-work-with-issues/creating-issues/about-issues quickstart: /issues/tracking-your-work-with-issues/quickstart @@ -44,9 +44,9 @@ redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests - /github/managing-your-work-on-github/managing-your-work-with-issues - /github/managing-your-work-on-github - - /categories/100/articles/ - - /categories/managing-projects/ - - /categories/managing-projects-on-github/ + - /categories/100/articles + - /categories/managing-projects + - /categories/managing-projects-on-github - /categories/managing-your-work-on-github - /about-issues - /creating-an-issue diff --git a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md index 0799b2d11b..833004a4f8 100644 --- a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md +++ b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md @@ -1,9 +1,9 @@ --- -title: 关于项目板 -intro: '{% data variables.product.product_name %} 上的项目板帮助您组织工作和排列工作的优先级。 您可以为特定功能工作、全面的路线图甚至发布检查列表创建项目板。 通过项目板可以灵活地创建适合需求的自定义工作流程。' +title: About project boards +intro: 'Project boards on {% data variables.product.product_name %} help you organize and prioritize your work. You can create project boards for specific feature work, comprehensive roadmaps, or even release checklists. With project boards, you have the flexibility to create customized workflows that suit your needs.' redirect_from: - /github/managing-your-work-on-github/managing-project-boards/about-project-boards - - /articles/about-projects/ + - /articles/about-projects - /articles/about-project-boards - /github/managing-your-work-on-github/about-project-boards versions: @@ -17,58 +17,58 @@ topics: {% data reusables.projects.project_boards_old %} -项目板包括议题、拉取请求和注释，在选择的列中分类为卡片。 您可以拖放或使用键盘快捷键对列中的卡片重新排序，在不同列之间移动卡片，以及更改列的顺序。 +Project boards are made up of issues, pull requests, and notes that are categorized as cards in columns of your choosing. You can drag and drop or use keyboard shortcuts to reorder cards within a column, move cards from column to column, and change the order of columns. -项目板卡片包含议题和拉取请求的相关数据，如标签、受理人、状态和打开者。 {% data reusables.project-management.edit-in-project %} +Project board cards contain relevant metadata for issues and pull requests, like labels, assignees, the status, and who opened it. {% data reusables.project-management.edit-in-project %} -您可以在列中创建注释以用作任务提醒，引用 {% data variables.product.product_location %} 上任何仓库中的议题和拉取请求，或者添加与项目板相关的信息。 您可以在注释中添加链接，创建另一个项目的参考卡。 如果注释不足以满足您的需求，您可以将其转换为议题。 有关将项目板注释转换为议题的更多信息，请参阅“[添加注释到项目板](/articles/adding-notes-to-a-project-board)”。 +You can create notes within columns to serve as task reminders, references to issues and pull requests from any repository on {% data variables.product.product_location %}, or to add information related to the project board. You can create a reference card for another project board by adding a link to a note. If the note isn't sufficient for your needs, you can convert it to an issue. For more information on converting project board notes to issues, see "[Adding notes to a project board](/articles/adding-notes-to-a-project-board)." -项目板的类型： +Types of project boards: -- **用户拥有的项目板**可以包含任何个人仓库中的议题和拉取请求。 -- **组织范围的项目板**可以包含属于组织的任何仓库中的议题和拉取请求。 {% data reusables.project-management.link-repos-to-project-board %}更多信息请参阅“[将仓库链接到项目板](/articles/linking-a-repository-to-a-project-board)”。 -- **仓库项目板**范围是单一仓库中的议题和拉取请求。 它们也可包含引用其他仓库中议题和拉取请求的注释。 +- **User-owned project boards** can contain issues and pull requests from any personal repository. +- **Organization-wide project boards** can contain issues and pull requests from any repository that belongs to an organization. {% data reusables.project-management.link-repos-to-project-board %} For more information, see "[Linking a repository to a project board](/articles/linking-a-repository-to-a-project-board)." +- **Repository project boards** are scoped to issues and pull requests within a single repository. They can also include notes that reference issues and pull requests in other repositories. -## 创建和查看项目板 +## Creating and viewing project boards -要为组织创建项目板，您必须是组织成员。 组织所有者以及具有项目板管理员权限的人员可以自定义对项目板的访问权限。 +To create a project board for your organization, you must be an organization member. Organization owners and people with project board admin permissions can customize access to the project board. -如果组织拥有的项目板包含您没有查看权限的仓库中的议题和拉取请求，该卡片将被重新指定。 更多信息请参阅“[组织的项目板权限](/articles/project-board-permissions-for-an-organization)”。 +If an organization-owned project board includes issues or pull requests from a repository that you don't have permission to view, the card will be redacted. For more information, see "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization)." -活动视图显示项目板的最近历史记录，例如某人创建的卡或在列之间移动的卡。 要访问活动视图，请单击 **Menu（菜单）**并向下滚动。 +The activity view shows the project board's recent history, such as cards someone created or moved between columns. To access the activity view, click **Menu** and scroll down. -要查找项目板上的特定卡或查看卡的子集，可以过滤项目板卡。 更多信息请参阅“[过滤项目板卡](/articles/filtering-cards-on-a-project-board)”。 +To find specific cards on a project board or view a subset of the cards, you can filter project board cards. For more information, see "[Filtering cards on a project board](/articles/filtering-cards-on-a-project-board)." -为简化工作流程并从项目板移除已完成的任务，您可以对板卡存档。 更多信息请参阅“[对项目板卡存档](/articles/archiving-cards-on-a-project-board)”。 +To simplify your workflow and keep completed tasks off your project board, you can archive cards. For more information, see "[Archiving cards on a project board](/articles/archiving-cards-on-a-project-board)." -如果您已完成所有项目板任务或不再需要使用项目板，可以关闭项目板。 更多信息请参阅“[关闭项目板](/articles/closing-a-project-board)”。 +If you've completed all of your project board tasks or no longer need to use your project board, you can close the project board. For more information, see "[Closing a project board](/articles/closing-a-project-board)." -如果要以不同的方式跟踪您的工作，您也可以[在仓库中禁用项目板](/articles/disabling-project-boards-in-a-repository)或[在组织中禁用项目板](/articles/disabling-project-boards-in-your-organization)。 +You can also [disable project boards in a repository](/articles/disabling-project-boards-in-a-repository) or [disable project boards in your organization](/articles/disabling-project-boards-in-your-organization), if you prefer to track your work in a different way. {% data reusables.project-management.project-board-import-with-api %} -## 项目板模板 +## Templates for project boards -您可以使用模板快速设置新的项目板。 在使用模板创建项目板时，新板将包含列以及具有项目板使用提示的卡。 您也可以选择已配置自动化的模板。 +You can use templates to quickly set up a new project board. When you use a template to create a project board, your new board will include columns as well as cards with tips for using project boards. You can also choose a template with automation already configured. -| 模板 | 描述 | -| --------- | --------------------------------------------------------------------- | -| 基本看板 | 使用 To do（待处理）、In progress（进行中）和 Done（已完成）列跟踪您的任务 | -| 自动化看板 | 卡自动在 To do（待处理）、In progress（进行中）和 Done（已完成）列之间移动 | -| 带审查的自动化看板 | 板卡自动在 To do（待处理）、In progress（进行中）和 Done（已完成）列之间移动，并且包含拉取请求审查状态的附加触发条件 | -| 漏洞查验 | 通过 To do（待处理）、In progress（进行中）和 Done（已完成）列查验漏洞并排列优先级 | +| Template | Description | +| --- | --- | +| Basic kanban | Track your tasks with To do, In progress, and Done columns | +| Automated kanban | Cards automatically move between To do, In progress, and Done columns | +| Automated kanban with review | Cards automatically move between To do, In progress, and Done columns, with additional triggers for pull request review status | +| Bug triage | Triage and prioritize bugs with To do, High priority, Low priority, and Closed columns | -有关项目板自动化的更多信息，请参阅“[关于项目板的自动化](/articles/about-automation-for-project-boards)”。 +For more information on automation for project boards, see "[About automation for project boards](/articles/about-automation-for-project-boards)." -![带看板模板的项目板](/assets/images/help/projects/project-board-basic-kanban-template.png) +![Project board with basic kanban template](/assets/images/help/projects/project-board-basic-kanban-template.png) {% data reusables.project-management.copy-project-boards %} -## 延伸阅读 +## Further reading -- "[创建项目板](/articles/creating-a-project-board)" -- "[编辑项目板](/articles/editing-a-project-board)"{% ifversion fpt or ghec %} -- "[复制项目板](/articles/copying-a-project-board)"{% endif %} -- "[添加议题和拉取请求到项目板](/articles/adding-issues-and-pull-requests-to-a-project-board)" -- "[组织的项目板权限](/articles/project-board-permissions-for-an-organization)" -- "[键盘快捷键](/articles/keyboard-shortcuts/#project-boards)" +- "[Creating a project board](/articles/creating-a-project-board)" +- "[Editing a project board](/articles/editing-a-project-board)"{% ifversion fpt or ghec %} +- "[Copying a project board](/articles/copying-a-project-board)"{% endif %} +- "[Adding issues and pull requests to a project board](/articles/adding-issues-and-pull-requests-to-a-project-board)" +- "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization)" +- "[Keyboard shortcuts](/articles/keyboard-shortcuts/#project-boards)" diff --git a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md index 19269a32ff..868b241f59 100644 --- a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md +++ b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md @@ -1,9 +1,9 @@ --- -title: 关闭项目板 -intro: 如果您已完成项目板中所有任务或不再需要使用项目板，可以关闭项目板。 +title: Closing a project board +intro: 'If you''ve completed all the tasks in a project board or no longer need to use a project board, you can close the project board.' redirect_from: - /github/managing-your-work-on-github/managing-project-boards/closing-a-project-board - - /articles/closing-a-project/ + - /articles/closing-a-project - /articles/closing-a-project-board - /github/managing-your-work-on-github/closing-a-project-board versions: @@ -14,21 +14,22 @@ versions: topics: - Pull requests --- - {% data reusables.projects.project_boards_old %} -关闭项目板时，默认情况下任何已配置的工作流程自动化都会暂停。 +When you close a project board, any configured workflow automation will pause by default. -如果重新打开项目板，您可以选择*同步*自动化，以便根据为项目板配置的自动化设置来更新板上卡的位置。 更多信息请参阅“[重新打开已关闭的项目板](/articles/reopening-a-closed-project-board)”或“[关于项目板自动化](/articles/about-automation-for-project-boards)”。 +If you reopen a project board, you have the option to *sync* automation, which updates the position of the cards on the board according to the automation settings configured for the board. For more information, see "[Reopening a closed project board](/articles/reopening-a-closed-project-board)" or "[About automation for project boards](/articles/about-automation-for-project-boards)." -1. 导航到仓库或组织中或由用户帐户拥有的项目板列表。 -2. 在项目列表中，在要关闭的项目板旁边单击 {% octicon "chevron-down" aria-label="The chevron icon" %}。 ![项目板名称右边的 V 形图标](/assets/images/help/projects/project-list-action-chevron.png) -3. 单击 **Close（关闭）**。 ![关闭项目板下拉菜单中的项](/assets/images/help/projects/close-project.png) +1. Navigate to list of project boards in your repository or organization, or owned by your user account. +2. In the projects list, next to the project board you want to close, click {% octicon "chevron-down" aria-label="The chevron icon" %}. +![Chevron icon to the right of the project board's name](/assets/images/help/projects/project-list-action-chevron.png) +3. Click **Close**. +![Close item in the project board's drop-down menu](/assets/images/help/projects/close-project.png) -## 延伸阅读 +## Further reading -- "[关于项目板](/articles/about-project-boards)" -- “[删除项目板](/articles/deleting-a-project-board)” -- “[在仓库中禁用项目板](/articles/disabling-project-boards-in-a-repository)” -- “[在组织中禁用项目板](/articles/disabling-project-boards-in-your-organization)” -- "[组织的项目板权限](/articles/project-board-permissions-for-an-organization)" +- "[About project boards](/articles/about-project-boards)" +- "[Deleting a project board](/articles/deleting-a-project-board)" +- "[Disabling project boards in a repository](/articles/disabling-project-boards-in-a-repository)" +- "[Disabling project boards in your organization](/articles/disabling-project-boards-in-your-organization)" +- "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization)" diff --git a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md index 3084bb8b9d..712cb6f12d 100644 --- a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md +++ b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md @@ -1,9 +1,9 @@ --- -title: 创建项目板 -intro: 项目板可用于创建满足您需求的自定义工作流程，例如对特定功能工作、全面路线图甚至发布检查清单进行跟踪和排列优先级。 +title: Creating a project board +intro: 'Project boards can be used to create customized workflows to suit your needs, like tracking and prioritizing specific feature work, comprehensive roadmaps, or even release checklists.' redirect_from: - /github/managing-your-work-on-github/managing-project-boards/creating-a-project-board - - /articles/creating-a-project/ + - /articles/creating-a-project - /articles/creating-a-project-board - /github/managing-your-work-on-github/creating-a-project-board versions: @@ -18,25 +18,25 @@ topics: - Project management type: how_to --- - {% data reusables.projects.project_boards_old %} {% data reusables.project-management.use-automated-template %} {% data reusables.project-management.copy-project-boards %} -{% data reusables.project-management.link-repos-to-project-board %}更多信息请参阅“[将仓库链接到项目板](/articles/linking-a-repository-to-a-project-board)”。 +{% data reusables.project-management.link-repos-to-project-board %} For more information, see "[Linking a repository to a project board](/articles/linking-a-repository-to-a-project-board)." -创建项目板后，您可以向其添加议题、拉取请求和备注。 更多信息请参阅“[向项目板添加议题和拉取请求](/articles/adding-issues-and-pull-requests-to-a-project-board)”和“[向项目板添加备注](/articles/adding-notes-to-a-project-board)”。 +Once you've created your project board, you can add issues, pull requests, and notes to it. For more information, see "[Adding issues and pull requests to a project board](/articles/adding-issues-and-pull-requests-to-a-project-board)" and "[Adding notes to a project board](/articles/adding-notes-to-a-project-board)." -还可以配置工作流程自动化，使项目板与议题和拉取请求的状态保持同步。 更多信息请参阅“[关于项目板的自动化](/articles/about-automation-for-project-boards)”。 +You can also configure workflow automations to keep your project board in sync with the status of issues and pull requests. For more information, see "[About automation for project boards](/articles/about-automation-for-project-boards)." {% data reusables.project-management.project-board-import-with-api %} -## 创建用户拥有的项目板 +## Creating a user-owned project board {% data reusables.profile.access_profile %} -2. 在个人资料页面顶部的主导航栏中，单击 {% octicon "project" aria-label="The project board icon" %} **Projects（项目）**。 ![项目选项卡](/assets/images/help/projects/user-projects-tab.png) +2. On the top of your profile page, in the main navigation, click {% octicon "project" aria-label="The project board icon" %} **Projects**. +![Project tab](/assets/images/help/projects/user-projects-tab.png) {% data reusables.project-management.click-new-project %} {% data reusables.project-management.create-project-name-description %} {% data reusables.project-management.choose-template %} @@ -52,7 +52,7 @@ type: how_to {% data reusables.project-management.edit-project-columns %} -## 创建组织范围的项目板 +## Creating an organization-wide project board {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} @@ -72,10 +72,11 @@ type: how_to {% data reusables.project-management.edit-project-columns %} -## 创建仓库项目板 +## Creating a repository project board {% data reusables.repositories.navigate-to-repo %} -2. 在仓库名称下，单击 {% octicon "project" aria-label="The project board icon" %} **Projects（项目）**。 ![项目选项卡](/assets/images/help/projects/repo-tabs-projects.png) +2. Under your repository name, click {% octicon "project" aria-label="The project board icon" %} **Projects**. +![Project tab](/assets/images/help/projects/repo-tabs-projects.png) {% data reusables.project-management.click-new-project %} {% data reusables.project-management.create-project-name-description %} {% data reusables.project-management.choose-template %} @@ -89,10 +90,10 @@ type: how_to {% data reusables.project-management.edit-project-columns %} -## 延伸阅读 +## Further reading -- "[关于项目板](/articles/about-project-boards)" -- "[编辑项目板](/articles/editing-a-project-board)"{% ifversion fpt or ghec %} -- "[复制项目板](/articles/copying-a-project-board)"{% endif %} -- "[关闭项目板](/articles/closing-a-project-board)" -- “[关于项目板的自动化](/articles/about-automation-for-project-boards)” +- "[About projects boards](/articles/about-project-boards)" +- "[Editing a project board](/articles/editing-a-project-board)"{% ifversion fpt or ghec %} +- "[Copying a project board](/articles/copying-a-project-board)"{% endif %} +- "[Closing a project board](/articles/closing-a-project-board)" +- "[About automation for project boards](/articles/about-automation-for-project-boards)" diff --git a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md index 0965f8018e..1c13437734 100644 --- a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md +++ b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md @@ -1,9 +1,9 @@ --- -title: 删除项目板 -intro: 如果您不再需要访问现有项目板的内容，可将其删除。 +title: Deleting a project board +intro: You can delete an existing project board if you no longer need access to its contents. redirect_from: - /github/managing-your-work-on-github/managing-project-boards/deleting-a-project-board - - /articles/deleting-a-project/ + - /articles/deleting-a-project - /articles/deleting-a-project-board - /github/managing-your-work-on-github/deleting-a-project-board versions: @@ -14,23 +14,23 @@ versions: topics: - Pull requests --- - {% data reusables.projects.project_boards_old %} {% tip %} -**提示**：如果您希望保留对已完成或不需要项目板的访问权限，而不是去对其内容的访问权限，可以[关闭项目板](/articles/closing-a-project-board)而非将其删除。 +**Tip**: If you'd like to retain access to a completed or unneeded project board without losing access to its contents, you can [close the project board](/articles/closing-a-project-board) instead of deleting it. {% endtip %} -1. 导航到要删除的项目板。 +1. Navigate to the project board you want to delete. {% data reusables.project-management.click-menu %} {% data reusables.project-management.click-edit-sidebar-menu-project-board %} -4. 单击 **Delete project（删除项目）**。 ![删除项目按钮](/assets/images/help/projects/delete-project-button.png) -5. 如需确认要删除项目板，请单击 **OK（确定）**。 +4. Click **Delete project**. +![Delete project button](/assets/images/help/projects/delete-project-button.png) +5. To confirm that you want to delete the project board, click **OK**. -## 延伸阅读 +## Further reading -- "[关闭项目板](/articles/closing-a-project-board)" -- “[在仓库中禁用项目板](/articles/disabling-project-boards-in-a-repository)” -- “[在组织中禁用项目板](/articles/disabling-project-boards-in-your-organization)” +- "[Closing a project board](/articles/closing-a-project-board)" +- "[Disabling project boards in a repository](/articles/disabling-project-boards-in-a-repository)" +- "[Disabling project boards in your organization](/articles/disabling-project-boards-in-your-organization)" diff --git a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md index 7f84d899da..e80b1eec6e 100644 --- a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md +++ b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md @@ -1,10 +1,10 @@ --- -title: 编辑项目板 -intro: 您可以编辑现有项目板的标题和说明。 +title: Editing a project board +intro: You can edit the title and description of an existing project board. redirect_from: - /github/managing-your-work-on-github/managing-project-boards/editing-a-project-board - - /articles/editing-a-project/ - - /articles/editing-and-deleting-a-project/ + - /articles/editing-a-project + - /articles/editing-and-deleting-a-project - /articles/editing-a-project-board - /github/managing-your-work-on-github/editing-a-project-board versions: @@ -15,22 +15,22 @@ versions: topics: - Pull requests --- - {% data reusables.projects.project_boards_old %} {% tip %} -**提示：**有关添加、删除或编辑项目板中列的详细信息，请参阅 “[创建项目板](/articles/creating-a-project-board)”。 +**Tip:** For details on adding, removing, or editing columns in your project board, see "[Creating a project board](/articles/creating-a-project-board)." {% endtip %} -1. 导航到要编辑的项目板。 +1. Navigate to the project board you want to edit. {% data reusables.project-management.click-menu %} -{% data reusables.project-management.click-edit-sidebar-menu-project-board %} -4. 根据需要修改项目板名称和说明，然后单击 **Save project（保存项目）**。 ![带有项目板名称和说明的字段，以及保存项目按钮](/assets/images/help/projects/edit-project-board-save-button.png) +{% data reusables.project-management.click-edit-sidebar-menu-project-board %} +4. Modify the project board name and description as needed, then click **Save project**. +![Fields with the project board name and description, and Save project button](/assets/images/help/projects/edit-project-board-save-button.png) -## 延伸阅读 +## Further reading -- "[关于项目板](/articles/about-project-boards)" -- "[添加议题和拉取请求到项目板](/articles/adding-issues-and-pull-requests-to-a-project-board)" -- “[删除项目板](/articles/deleting-a-project-board)” +- "[About project boards](/articles/about-project-boards)" +- "[Adding issues and pull requests to a project board](/articles/adding-issues-and-pull-requests-to-a-project-board)" +- "[Deleting a project board](/articles/deleting-a-project-board)" diff --git a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md index 62368aac78..6c67376231 100644 --- a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md +++ b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md @@ -1,9 +1,9 @@ --- -title: 添加议题和拉取请求到项目板 -intro: 您可以通过卡片的形式将议题和拉取请求添加到项目板，并且分类到各列中。 +title: Adding issues and pull requests to a project board +intro: You can add issues and pull requests to a project board in the form of cards and triage them into columns. redirect_from: - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board - - /articles/adding-issues-and-pull-requests-to-a-project/ + - /articles/adding-issues-and-pull-requests-to-a-project - /articles/adding-issues-and-pull-requests-to-a-project-board - /github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board versions: @@ -13,61 +13,67 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: 将议题和 PR 添加到板中 +shortTitle: Add issues & PRs to board --- - {% data reusables.projects.project_boards_old %} -您可通过以下方式将议题或拉取请求卡添加到项目板： -- 从侧栏的 **Triage（分类）**部分拖动卡片。 -- 在卡片中输入议题或拉取请求 URL。 -- 在项目板搜索侧栏中搜索议题或拉取请求。 +You can add issue or pull request cards to your project board by: +- Dragging cards from the **Triage** section in the sidebar. +- Typing the issue or pull request URL in a card. +- Searching for issues or pull requests in the project board search sidebar. -每个项目列中最多可以输入 2,500 张卡片。 如果一列已经达到最大卡片数，则无法将卡片移入该列。 +You can put a maximum of 2,500 cards into each project column. If a column has reached the maximum number of cards, no cards can be moved into that column. -![通过鼠标可将议题卡从分类侧栏移至项目板列](/assets/images/help/projects/add-card-from-sidebar.gif) +![Cursor moves issue card from triaging sidebar to project board column](/assets/images/help/projects/add-card-from-sidebar.gif) {% note %} -**注：**您可以添加注释到项目板以用作任务提醒，引用 {% data variables.product.product_name %} 上任何仓库中的议题和拉取请求，或者添加与项目板相关的信息。 更多信息请参阅“[添加注释到项目板](/articles/adding-notes-to-a-project-board)”。 +**Note:** You can also add notes to your project board to serve as task reminders, references to issues and pull requests from any repository on {% data variables.product.product_name %}, or to add related information to your project board. For more information, see "[Adding notes to a project board](/articles/adding-notes-to-a-project-board)." {% endnote %} {% data reusables.project-management.edit-in-project %} -{% data reusables.project-management.link-repos-to-project-board %} 在搜索要添加到项目板的议题和拉取请求时，搜索会自动将范围限于您链接的仓库。 您可以删除这些限定符以搜索所有组织仓库。 更多信息请参阅“[链接仓库到项目板](/articles/linking-a-repository-to-a-project-board)”。 +{% data reusables.project-management.link-repos-to-project-board %} When you search for issues and pull requests to add to your project board, the search automatically scopes to your linked repositories. You can remove these qualifiers to search within all organization repositories. For more information, see "[Linking a repository to a project board](/articles/linking-a-repository-to-a-project-board)." -## 添加议题和拉取请求到项目板 +## Adding issues and pull requests to a project board -1. 导航到您要在其中添加议题和拉取请求的项目板。 -2. 在项目板中，单击 {% octicon "plus" aria-label="The plus icon" %} **Add cards（添加卡）**。 ![添加卡按钮](/assets/images/help/projects/add-cards-button.png) -3. 使用搜索限定符搜索要添加到项目板的议题和拉取请求。 有关您可以使用的搜索限定符的更多信息，请参阅“[搜索议题](/articles/searching-issues)”。 ![搜索议题和拉取请求](/assets/images/help/issues/issues_search_bar.png) +1. Navigate to the project board where you want to add issues and pull requests. +2. In your project board, click {% octicon "plus" aria-label="The plus icon" %} **Add cards**. +![Add cards button](/assets/images/help/projects/add-cards-button.png) +3. Search for issues and pull requests to add to your project board using search qualifiers. For more information on search qualifiers you can use, see "[Searching issues](/articles/searching-issues)." + ![Search issues and pull requests](/assets/images/help/issues/issues_search_bar.png) {% tip %} - **提示：** - - 您也可以通过在卡中输入 URL 来添加议题或拉取请求。 - - 如果您在使用特定功能，可以将标签贴到该功能的每个相关议题或拉取请求，然后通过搜索标签名称轻松地将卡片添加到项目板。 更多信息请参阅“[应用标签到议题和拉取请求](/articles/applying-labels-to-issues-and-pull-requests)”。 + **Tips:** + - You can also add an issue or pull request by typing the URL in a card. + - If you're working on a specific feature, you can apply a label to each related issue or pull request for that feature, and then easily add cards to your project board by searching for the label name. For more information, see "[Apply labels to issues and pull requests](/articles/applying-labels-to-issues-and-pull-requests)." {% endtip %} -4. 从过滤的议题和拉取请求列表，将要添加到项目板的卡片拖放到正确的列中。 也可以使用键盘快捷键移动卡片。 {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} +4. From the filtered list of issues and pull requests, drag the card you'd like to add to your project board and drop it in the correct column. Alternatively, you can move cards using keyboard shortcuts. {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} {% tip %} - **提示：**可以通过拖放或键盘快捷键对卡片重新排序以及在列之间移动它们。 {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} + **Tip:** You can drag and drop or use keyboard shortcuts to reorder cards and move them between columns. {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} {% endtip %} -## 从侧栏添加议题和拉取请求到项目板 +## Adding issues and pull requests to a project board from the sidebar -1. 在议题或拉取请求右侧单击 **Projects（项目）{% octicon "gear" aria-label="The Gear icon" %}**。 ![侧栏中的项目板按钮](/assets/images/help/projects/sidebar-project.png) -2. 单击要添加到其中的项目板对应的 **Recent（最近）**、**Repository（仓库）**、**User（用户）**或 **Organization（组织）**选项卡。 ![最近、仓库和组织选项卡](/assets/images/help/projects/sidebar-project-tabs.png) -3. 在 **Filter projects（过滤项目）**字段中输入项目的名称。 ![项目板搜索框](/assets/images/help/projects/sidebar-search-project.png) -4. 选择要添加议题或拉取请求的一个或多个项目板。 ![选择的项目板](/assets/images/help/projects/sidebar-select-project.png) -5. 单击 {% octicon "triangle-down" aria-label="The down triangle icon" %}，然后单击您希望议题或拉取请求所在的列。 该卡将移到您选择的项目板列的底部。 ![将卡移至列菜单](/assets/images/help/projects/sidebar-select-project-board-column-menu.png) +1. On the right side of an issue or pull request, click **Projects {% octicon "gear" aria-label="The Gear icon" %}**. + ![Project board button in sidebar](/assets/images/help/projects/sidebar-project.png) +2. Click the **Recent**, **Repository**,**User**, or **Organization** tab for the project board you would like to add to. + ![Recent, Repository and Organization tabs](/assets/images/help/projects/sidebar-project-tabs.png) +3. Type the name of the project in **Filter projects** field. + ![Project board search box](/assets/images/help/projects/sidebar-search-project.png) +4. Select one or more project boards where you want to add the issue or pull request. + ![Selected project board](/assets/images/help/projects/sidebar-select-project.png) +5. Click {% octicon "triangle-down" aria-label="The down triangle icon" %}, then click the column where you want your issue or pull request. The card will move to the bottom of the project board column you select. + ![Move card to column menu](/assets/images/help/projects/sidebar-select-project-board-column-menu.png) -## 延伸阅读 +## Further reading -- "[关于项目板](/articles/about-project-boards)" -- "[编辑项目板](/articles/editing-a-project-board)" -- "[过滤项目板上的卡](/articles/filtering-cards-on-a-project-board)" +- "[About project boards](/articles/about-project-boards)" +- "[Editing a project board](/articles/editing-a-project-board)" +- "[Filtering cards on a project board](/articles/filtering-cards-on-a-project-board)" diff --git a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md index 3f285e4b64..2cf815d675 100644 --- a/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md +++ b/translations/zh-CN/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md @@ -1,9 +1,9 @@ --- -title: 添加注释到项目板 -intro: 您可以添加注释到项目板以用作任务提醒，或者添加与项目板相关的信息。 +title: Adding notes to a project board +intro: You can add notes to a project board to serve as task reminders or to add information related to the project board. redirect_from: - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards/adding-notes-to-a-project-board - - /articles/adding-notes-to-a-project/ + - /articles/adding-notes-to-a-project - /articles/adding-notes-to-a-project-board - /github/managing-your-work-on-github/adding-notes-to-a-project-board versions: @@ -13,66 +13,72 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: 添加备注到板 +shortTitle: Add notes to board --- - {% data reusables.projects.project_boards_old %} {% tip %} -**提示：** -- 您可以使用 Markdown 语法格式化注释。 例如，可以使用标题、链接、任务列表或表情符号。 更多信息请参阅“[基本撰写和格式语法](/articles/basic-writing-and-formatting-syntax)”。 -- 可以通过拖放或键盘快捷键对注释重新排序以及在列之间移动它们。 {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} -- 项目板必须至少有一列才可添加注释。 更多信息请参阅“[创建项目板](/articles/creating-a-project-board)”。 +**Tips:** +- You can format your note using Markdown syntax. For example, you can use headings, links, task lists, or emoji. For more information, see "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)." +- You can drag and drop or use keyboard shortcuts to reorder notes and move them between columns. {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} +- Your project board must have at least one column before you can add notes. For more information, see "[Creating a project board](/articles/creating-a-project-board)." {% endtip %} -在注释中添加议题、拉取请求或另一个项目板的 URL 时，在文本下面的摘要卡中会看到预览。 +When you add a URL for an issue, pull request, or another project board to a note, you'll see a preview in a summary card below your text. -![显示议题和另一个项目板预览的项目板卡](/assets/images/help/projects/note-with-summary-card.png) +![Project board cards showing a preview of an issue and another project board](/assets/images/help/projects/note-with-summary-card.png) -## 添加注释到项目板 +## Adding notes to a project board -1. 导航到您要在其中添加注释的项目板。 -2. 在要添加注释的列中，单击 {% octicon "plus" aria-label="The plus icon" %}。 ![列标题中的加号](/assets/images/help/projects/add-note-button.png) -3. 输入您的注释，然后单击 **Add（添加）**。 ![用于输入注释的字段和添加卡按钮](/assets/images/help/projects/create-and-add-note-button.png) +1. Navigate to the project board where you want to add notes. +2. In the column you want to add a note to, click {% octicon "plus" aria-label="The plus icon" %}. +![Plus icon in the column header](/assets/images/help/projects/add-note-button.png) +3. Type your note, then click **Add**. +![Field for typing a note and Add card button](/assets/images/help/projects/create-and-add-note-button.png) {% tip %} - **提示：**您可以在注释中输入议题或拉取请求在卡中的 URL 以引用它们。 + **Tip:** You can reference an issue or pull request in your note by typing its URL in the card. {% endtip %} -## 将注释转换为议题 +## Converting a note to an issue -如果您创建了注释但发现它不足以表达您的需求，可以将其转换为议题。 +If you've created a note and find that it isn't sufficient for your needs, you can convert it to an issue. -在将注释转换为议题时，会使用注释中的内容自动创建议题。 注释的第一行将成为议题的标题，其他内容将添加到议题说明中。 +When you convert a note to an issue, the issue is automatically created using the content from the note. The first line of the note will be the issue title and any additional content from the note will be added to the issue description. {% tip %} -**提示：**您可以添加注释正文的内容以 @提及某人、链接到其他议题或拉取请求，以及添加表情符号。 这些 {% data variables.product.prodname_dotcom %} Flavored Markdown 功能在项目板注释中不受支持，但在注释转换为议题之后，它们会正确显示。 有关使用这些功能的更多信息，请参阅“[关于在 {% data variables.product.prodname_dotcom %} 上编写和设置格式](/articles/about-writing-and-formatting-on-github)”。 +**Tip:** You can add content in the body of your note to @mention someone, link to another issue or pull request, and add emoji. These {% data variables.product.prodname_dotcom %} Flavored Markdown features aren't supported within project board notes, but once your note is converted to an issue, they'll appear correctly. For more information on using these features, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/about-writing-and-formatting-on-github)." {% endtip %} -1. 导航到您要转换为议题的注释。 +1. Navigate to the note that you want to convert to an issue. {% data reusables.project-management.project-note-more-options %} -3. 单击 **Convert to issue（转换为议题）**。 ![转换为议题按钮](/assets/images/help/projects/convert-to-issue.png) -4. 如果卡在全组织项目板上，请从下拉菜单中选择要添加议题到其中的仓库。 ![列出可在其中创建议题的仓库的下拉菜单](/assets/images/help/projects/convert-note-choose-repository.png) -5. 可以选择编辑预填的议题标题，并输入议题正文。 ![议题标题和正文字段](/assets/images/help/projects/convert-note-issue-title-body.png) -6. 单击 **Convert to issue（转换为议题）**。 -7. 该注释会自动转换为议题。 在项目板中，新议题卡与之前注释的位置一样。 +3. Click **Convert to issue**. + ![Convert to issue button](/assets/images/help/projects/convert-to-issue.png) +4. If the card is on an organization-wide project board, in the drop-down menu, choose the repository you want to add the issue to. + ![Drop-down menu listing repositories where you can create the issue](/assets/images/help/projects/convert-note-choose-repository.png) +5. Optionally, edit the pre-filled issue title, and type an issue body. + ![Fields for issue title and body](/assets/images/help/projects/convert-note-issue-title-body.png) +6. Click **Convert to issue**. +7. The note is automatically converted to an issue. In the project board, the new issue card will be in the same location as the previous note. -## 编辑和删除注释 +## Editing and removing a note -1. 导航到您要编辑或删除的注释。 +1. Navigate to the note that you want to edit or remove. {% data reusables.project-management.project-note-more-options %} -3. 要编辑注释的内容，请单击 **Edit note（编辑注释）**。 ![编辑注释按钮](/assets/images/help/projects/edit-note.png) -4. 要删除注释的内容，请单击 **Delete note（删除注释）**。 ![删除注释按钮](/assets/images/help/projects/delete-note.png) +3. To edit the contents of the note, click **Edit note**. + ![Edit note button](/assets/images/help/projects/edit-note.png) +4. To delete the contents of the notes, click **Delete note**. + ![Delete note button](/assets/images/help/projects/delete-note.png) -## 延伸阅读 +## Further reading -- "[关于项目板](/articles/about-project-boards)" -- "[创建项目板](/articles/creating-a-project-board)" -- "[编辑项目板](/articles/editing-a-project-board)" -- "[添加议题和拉取请求到项目板](/articles/adding-issues-and-pull-requests-to-a-project-board)" +- "[About project boards](/articles/about-project-boards)" +- "[Creating a project board](/articles/creating-a-project-board)" +- "[Editing a project board](/articles/editing-a-project-board)" +- "[Adding issues and pull requests to a project board](/articles/adding-issues-and-pull-requests-to-a-project-board)" diff --git a/translations/zh-CN/content/issues/tracking-your-work-with-issues/about-issues.md b/translations/zh-CN/content/issues/tracking-your-work-with-issues/about-issues.md index bc15d63240..ebd5ac6cf6 100644 --- a/translations/zh-CN/content/issues/tracking-your-work-with-issues/about-issues.md +++ b/translations/zh-CN/content/issues/tracking-your-work-with-issues/about-issues.md @@ -1,10 +1,10 @@ --- -title: 关于议题 -intro: '使用 {% data variables.product.prodname_github_issues %} 追踪在 {% data variables.product.company_short %} 上的想法、反馈、任务或缺陷。' +title: About issues +intro: 'Use {% data variables.product.prodname_github_issues %} to track ideas, feedback, tasks, or bugs for work on {% data variables.product.company_short %}.' redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/about-issues - - /articles/creating-issues/ - - /articles/about-issues/ + - /articles/creating-issues + - /articles/about-issues - /github/managing-your-work-on-github/about-issues - /issues/tracking-your-work-with-issues/creating-issues/about-issues versions: @@ -17,39 +17,38 @@ topics: - Issues - Project management --- +## Integrated with GitHub -## 集成 GitHub +Issues let you track your work on {% data variables.product.company_short %}, where development happens. When you mention an issue in another issue or pull request, the issue's timeline reflects the cross-reference so that you can keep track of related work. To indicate that work is in progress, you can link an issue to a pull request. When the pull request merges, the linked issue automatically closes. -议题让您可以在进行开发的 {% data variables.product.company_short %} 上跟踪您的工作。 当您在议题中提到另一个议题或拉取请求时，该议题的时间表会反映交叉参考，以便你能够跟踪相关的工作。 要表示工作正在进行中，您可以将议题链接到拉取请求。 当拉取请求合并时，链接的议题会自动关闭。 +## Quickly create issues -## 快速创建议题 +Issues can be created in a variety of ways, so you can choose the most convenient method for your workflow. For example, you can create an issue from a repository,{% ifversion fpt or ghec %} an item in a task list,{% endif %} a note in a project, a comment in an issue or pull request, a specific line of code, or a URL query. You can also create an issue from your platform of choice: through the web UI, {% data variables.product.prodname_desktop %}, {% data variables.product.prodname_cli %}, GraphQL and REST APIs, or {% data variables.product.prodname_mobile %}. For more information, see "[Creating an issue](/issues/tracking-your-work-with-issues/creating-issues/creating-an-issue)." -议题可以通过多种方式创建，因此您可以为工作流程选择最方便的方法。 例如，您可以从仓库创建议题、{% ifversion fpt or ghec %} 任务列表中的项目、{% endif %} 项目中的注释、议题或拉取请求中的评论、特定代码行或 URL 查询。 您也可以从选择的平台创建议题：通过 Web 界面、{% data variables.product.prodname_desktop %}、{% data variables.product.prodname_cli %}、GraphQL 和 REST API 或 {% data variables.product.prodname_mobile %}。 更多信息请参阅“[创建议题](/issues/tracking-your-work-with-issues/creating-issues/creating-an-issue)”。 +## Track work -## 跟踪工作 +You can organize and prioritize issues with projects. {% ifversion fpt or ghec %}To track issues as part of a larger issue, you can use task lists.{% endif %} To categorize related issues, you can use labels and milestones. -您可以通过项目组织议题并排定优先级。 {% ifversion fpt or ghec %}要跟踪作为较大议题一部分的议题，您可以使用任务列表。{% endif %} 要对相关议题进行分类，您可以使用标签和里程碑。 +For more information about projects, see {% ifversion fpt or ghec %}"[About projects (beta)](/issues/trying-out-the-new-projects-experience/about-projects)" and {% endif %}"[Organizing your work with project boards](/issues/organizing-your-work-with-project-boards)." {% ifversion fpt or ghec %}For more information about task lists, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)." {% endif %}For more information about labels and milestones, see "[Using labels and milestones to track work](/issues/using-labels-and-milestones-to-track-work)." -有关项目的更多信息，请参阅 {% ifversion fpt or ghec %}“[关于项目（测试版）](/issues/trying-out-the-new-projects-experience/about-projects)”和{% endif %}“[组织对项目板的使用](/issues/organizing-your-work-with-project-boards)”。 {% ifversion fpt or ghec %}有关任务列表的更多信息，请参阅“[关于任务列表](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)”。 {% endif %}有关标签和里程碑的更多信息，请参阅“[使用标签和里程碑跟踪工作](/issues/using-labels-and-milestones-to-track-work)”。 +## Stay up to date -## 保持更新 +To stay updated on the most recent comments in an issue, you can subscribe to an issue to receive notifications about the latest comments. To quickly find links to recently updated issues you're subscribed to, visit your dashboard. For more information, see {% ifversion fpt or ghes or ghae or ghec %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}" and "[About your personal dashboard](/articles/about-your-personal-dashboard)." -为保持更新议题中的最新评论，您可以订阅议题以接收关于最新评论的通知。 要快速查找指向您订阅的最新议题的链接，请访问仪表板。 更多信息请参阅 {% ifversion fpt or ghes or ghae or ghec %}“[关于通知](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}”[关于通知](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}”和“[关于个人仪表板](/articles/about-your-personal-dashboard)”。 +## Community management -## 社区管理 +To help contributors open meaningful issues that provide the information that you need, you can use {% ifversion fpt or ghec %}issue forms and {% endif %}issue templates. For more information, see "[Using templates to encourage useful issues and pull requests](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)." -为了帮助贡献者打开有意义的议题，提供您需要的信息，您可以使用 {% ifversion fpt or ghec %}议题表单和 {% endif %}议题模板。 更多信息请参阅“[使用模板鼓励有用的议题和拉取请求](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)”。 +{% ifversion fpt or ghec %}To maintain a healthy community, you can report comments that violate {% data variables.product.prodname_dotcom %}'s [Community Guidelines](/free-pro-team@latest/github/site-policy/github-community-guidelines). For more information, see "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)."{% endif %} -{% ifversion fpt or ghec %}为了维护健康的社区，您可以报告违反{% data variables.product.prodname_dotcom %}[社区指导方针](/free-pro-team@latest/github/site-policy/github-community-guidelines)的评论。 更多信息请参阅“[报告滥用或垃圾邮件](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)”。{% endif %} +## Efficient communication -## 高效沟通 +You can @mention collaborators who have access to your repository in an issue to draw their attention to a comment. To link related issues in the same repository, you can type `#` followed by part of the issue title and then clicking the issue that you want to link. To communicate responsibility, you can assign issues. If you find yourself frequently typing the same comment, you can use saved replies. +{% ifversion fpt or ghec %} For more information, see "[Basic writing and formatting syntax](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)" and "[Assigning issues and pull requests to other GitHub users](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)." -您可以在议题中@提及能访问您的仓库的协作者，以提请他们注意评论。 要将相关议题链接到同一仓库，您可以键入 `#`，后接议题标题的一部分，然后点击要链接的议题。 为了沟通责任，您可以分配议题。 如果您发现自己经常输入相同的评论，可以使用已保存的回复。 -{% ifversion fpt or ghec %} 更多信息请参阅“[基本编写和格式语法](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)”和“[将议题和拉取请求分配到其他 GitHub 用户](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)”。 +## Comparing issues and discussions -## 比较议题和讨论 +Some conversations are more suitable for {% data variables.product.prodname_discussions %}. {% data reusables.discussions.you-can-use-discussions %} For guidance on when to use an issue or a discussion, see "[Communicating on GitHub](/github/getting-started-with-github/quickstart/communicating-on-github)." -Some conversations are more suitable for {% data variables.product.prodname_discussions %}. {% data reusables.discussions.you-can-use-discussions %} 有关何时使用议题或讨论的指导，请参阅“[在 GitHub 上沟通](/github/getting-started-with-github/quickstart/communicating-on-github)”。 - -当某个议题中的对话更适合讨论时，您可以将议题转换为讨论。 +When a conversation in an issue is better suited for a discussion, you can convert the issue to a discussion. {% endif %} diff --git a/translations/zh-CN/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md b/translations/zh-CN/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md index 9e5e938ef2..8eca5faf19 100644 --- a/translations/zh-CN/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md +++ b/translations/zh-CN/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md @@ -1,10 +1,10 @@ --- -title: 将拉取请求链接到议题 -intro: 您可以将拉取请求链接到议题，以显示修复正在进行中，并在拉取请求被合并时自动关闭该议题。 +title: Linking a pull request to an issue +intro: You can link a pull request to an issue to show that a fix is in progress and to automatically close the issue when the pull request is merged. redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/linking-a-pull-request-to-an-issue - - /articles/closing-issues-via-commit-message/ - - /articles/closing-issues-via-commit-messages/ + - /articles/closing-issues-via-commit-message + - /articles/closing-issues-via-commit-messages - /articles/closing-issues-using-keywords - /github/managing-your-work-on-github/closing-issues-using-keywords - /github/managing-your-work-on-github/linking-a-pull-request-to-an-issue @@ -16,26 +16,25 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: 将 PR 链接到议题 +shortTitle: Link PR to issue --- - {% note %} -**注：**当拉取请求指向仓库的*默认*分支时，将解析拉取请求说明中的特殊关键字。 但是，如果拉取请求的基础是*任何其他分支*，则将忽略这些关键字，不创建任何链接，并且合并拉取请求对议题没有影响。 **如果要使用关键字将拉取请求链接到议题，则拉取请求必须在默认分支上。** +**Note:** The special keywords in a pull request description are interpreted when the pull request targets the repository's *default* branch. However, if the PR's base is *any other branch*, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. **If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.** {% endnote %} -## 关于链接的议题和拉取请求 +## About linked issues and pull requests -您可以{% ifversion fpt or ghes or ghae or ghec %}手动或{% endif %}使用拉取请求说明中支持的关键词将议题链接到拉取请求。 +You can link an issue to a pull request {% ifversion fpt or ghes or ghae or ghec %}manually or {% endif %}using a supported keyword in the pull request description. -当您将拉取请求链接到拉取请求指向的议题，如果有人正在操作该议题，协作者可以看到。 +When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue. -将链接的拉取请求合并到仓库的默认分支时，其链接的议题将自动关闭。 有关默认分支的更多信息，请参阅“[更改默认分支](/github/administering-a-repository/changing-the-default-branch)”。 +When you merge a linked pull request into the default branch of a repository, its linked issue is automatically closed. For more information about the default branch, see "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)." -## 使用关键词将拉取请求链接到议题 +## Linking a pull request to an issue using a keyword -您可以在拉取请求说明或提交消息中使用支持的关键字将拉取请求链接到议题（请注意，拉取请求必须在默认分支上）。 +You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message (please note that the pull request must be on the default branch). * close * closes @@ -43,39 +42,41 @@ shortTitle: 将 PR 链接到议题 * fix * fixes * fixed -* 解决 +* resolve * resolves * resolved If you use a keyword to reference a pull request comment in another pull request, the pull requests will be linked. Merging the referencing pull request will also close the referenced pull request. -关闭关键词的语法取决于议题是否与拉取请求在同一仓库中。 +The syntax for closing keywords depends on whether the issue is in the same repository as the pull request. -| 链接的议题 | 语法 | 示例 | -| -------- | --------------------------------------------- | -------------------------------------------------------------- | -| 同一仓库中的议题 | *KEYWORD* #*ISSUE-NUMBER* | `Closes #10` | -| 不同仓库中的议题 | *KEYWORD* *OWNER*/*REPOSITORY*#*ISSUE-NUMBER* | `Fixes octo-org/octo-repo#100` | -| 多个议题 | 对每个议题使用完整语法 | `Resolves #10, resolves #123, resolves octo-org/octo-repo#100` | +Linked issue | Syntax | Example +--------------- | ------ | ------ +Issue in the same repository | *KEYWORD* #*ISSUE-NUMBER* | `Closes #10` +Issue in a different repository | *KEYWORD* *OWNER*/*REPOSITORY*#*ISSUE-NUMBER* | `Fixes octo-org/octo-repo#100` +Multiple issues | Use full syntax for each issue | `Resolves #10, resolves #123, resolves octo-org/octo-repo#100` -{% ifversion fpt or ghes or ghae or ghec %}只有手动链接的拉取请求才能手动取消链接。 要取消链接您使用关键词链接的议题，必须编辑拉取请求说明以删除该关键词。{% endif %} +{% ifversion fpt or ghes or ghae or ghec %}Only manually linked pull requests can be manually unlinked. To unlink an issue that you linked using a keyword, you must edit the pull request description to remove the keyword.{% endif %} -您也可以在提交消息中使用关闭关键词。 议题将在提交合并到默认分支时关闭，但包含提交的拉取请求不会列为链接的拉取请求。 +You can also use closing keywords in a commit message. The issue will be closed when you merge the commit into the default branch, but the pull request that contains the commit will not be listed as a linked pull request. {% ifversion fpt or ghes or ghae or ghec %} -## 手动将拉取请求链接到议题 +## Manually linking a pull request to an issue -对仓库有写入权限的任何人都可以手动将拉取请求链接到议题。 +Anyone with write permissions to a repository can manually link a pull request to an issue. -您可以手动链接最多 10 个议题到每个拉取请求。 议题和拉取请求必须位于同一仓库中。 +You can manually link up to ten issues to each pull request. The issue and pull request must be in the same repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-pr %} -3. 在拉取请求列表中，单击要链接到议题的拉取请求。 -4. 在右侧边栏中，单击 **Linked issues（链接的议题）**。 ![右侧边栏中链接的议题](/assets/images/help/pull_requests/linked-issues.png) -5. 单击要链接到拉取请求的议题。 ![下拉以链接议题](/assets/images/help/pull_requests/link-issue-drop-down.png) +3. In the list of pull requests, click the pull request that you'd like to link to an issue. +4. In the right sidebar, click **Linked issues**. + ![Linked issues in the right sidebar](/assets/images/help/pull_requests/linked-issues.png) +5. Click the issue you want to link to the pull request. + ![Drop down to link issue](/assets/images/help/pull_requests/link-issue-drop-down.png) {% endif %} -## 延伸阅读 +## Further reading -- "[自动链接的引用和 URL](/articles/autolinked-references-and-urls/#issues-and-pull-requests)" +- "[Autolinked references and URLs](/articles/autolinked-references-and-urls/#issues-and-pull-requests)" diff --git a/translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md b/translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md index 0584a84844..c008e01a7b 100644 --- a/translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md +++ b/translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md @@ -1,9 +1,9 @@ --- -title: 创建和编辑议题及拉取请求的里程碑 -intro: 您可以创建里程碑来跟踪仓库中议题或拉取请求组的进度。 +title: Creating and editing milestones for issues and pull requests +intro: You can create a milestone to track progress on groups of issues or pull requests in a repository. redirect_from: - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones/creating-and-editing-milestones-for-issues-and-pull-requests - - /articles/creating-milestones-for-issues-and-pull-requests/ + - /articles/creating-milestones-for-issues-and-pull-requests - /articles/creating-and-editing-milestones-for-issues-and-pull-requests - /github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests versions: @@ -15,30 +15,32 @@ topics: - Pull requests - Issues - Project management -shortTitle: 创建和编辑里程碑 +shortTitle: Create & edit milestones type: how_to --- +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-issue-pr %} +{% data reusables.project-management.milestones %} +4. Choose one of these options: + - To create a new milestone, click **New Milestone**. + ![New milestone button](/assets/images/help/repository/new-milestone.png) + - To edit a milestone, next to the milestone you want to edit, click **Edit**. + ![Edit milestone option](/assets/images/help/repository/edit-milestone.png) +5. Type the milestone's title, description, or other changes, and click **Create milestone** or **Save changes**. Milestones will render Markdown syntax. For more information about Markdown syntax, see "[Basic writing and formatting syntax](/github/writing-on-github/basic-writing-and-formatting-syntax)." + +## Deleting milestones + +When you delete milestones, issues and pull requests are not affected. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issue-pr %} {% data reusables.project-management.milestones %} -4. 选择以下选项之一： - - 要创建新里程碑，请单击 **New Milestone（新建里程碑）**。 ![新建里程碑按钮](/assets/images/help/repository/new-milestone.png) - - 要编辑里程碑，请在要编辑的里程碑旁边，单击 **Edit（编辑）**。 ![编辑里程碑选项](/assets/images/help/repository/edit-milestone.png) -5. 键入里程碑的标题、说明或其他更改，然后单击 **Create milestone（创建里程碑）**或 **Save changes（保存更改）**。 里程碑将呈现 Markdown 语法。 有关 Markdown 语法的更多信息，请参阅“[基本撰写和格式语法](/github/writing-on-github/basic-writing-and-formatting-syntax)”。 +4. Next to the milestone you want to delete, click **Delete**. +![Delete milestone option](/assets/images/help/repository/delete-milestone.png) -## 删除里程碑 +## Further reading -删除里程碑时，议题和提取请求不会受到影响。 - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -{% data reusables.project-management.milestones %} -4. 在要删除的里程碑旁边，单击 **Delete（删除）**。 ![删除里程碑选项](/assets/images/help/repository/delete-milestone.png) - -## 延伸阅读 - -- "[关于里程碑](/articles/about-milestones)" -- "[将里程碑与议题及拉取请求关联](/articles/associating-milestones-with-issues-and-pull-requests)" -- "[查看里程碑的进度](/articles/viewing-your-milestone-s-progress)" -- "[按里程碑过滤议题和拉取请求](/articles/filtering-issues-and-pull-requests-by-milestone)" +- "[About milestones](/articles/about-milestones)" +- "[Associating milestones with issues and pull requests](/articles/associating-milestones-with-issues-and-pull-requests)" +- "[Viewing your milestone's progress](/articles/viewing-your-milestone-s-progress)" +- "[Filtering issues and pull requests by milestone](/articles/filtering-issues-and-pull-requests-by-milestone)" diff --git a/translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md b/translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md index a0a087614c..f5f9e3b136 100644 --- a/translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md +++ b/translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md @@ -12,7 +12,7 @@ redirect_from: - /articles/creating-and-editing-labels-for-issues-and-pull-requests - /articles/creating-a-label - /github/managing-your-work-on-github/creating-a-label - - /articles/customizing-issue-labels/ + - /articles/customizing-issue-labels - /articles/applying-labels-to-issues-and-pull-requests - /github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests - /articles/editing-a-label diff --git a/translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md b/translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md index dd40cb5a26..80fb7f8cb7 100644 --- a/translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -2,12 +2,12 @@ title: About GitHub Pages intro: 'You can use {% data variables.product.prodname_pages %} to host a website about yourself, your organization, or your project directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.' redirect_from: - - /articles/what-are-github-pages/ - - /articles/what-is-github-pages/ - - /articles/user-organization-and-project-pages/ - - /articles/using-a-static-site-generator-other-than-jekyll/ - - /articles/mime-types-on-github-pages/ - - /articles/should-i-rename-usernamegithubcom-repositories-to-usernamegithubio/ + - /articles/what-are-github-pages + - /articles/what-is-github-pages + - /articles/user-organization-and-project-pages + - /articles/using-a-static-site-generator-other-than-jekyll + - /articles/mime-types-on-github-pages + - /articles/should-i-rename-usernamegithubcom-repositories-to-usernamegithubio - /articles/about-github-pages - /github/working-with-github-pages/about-github-pages product: '{% data reusables.gated-features.pages %}' diff --git a/translations/zh-CN/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md b/translations/zh-CN/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md index 2efcd10cfe..6f568026a7 100644 --- a/translations/zh-CN/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md +++ b/translations/zh-CN/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md @@ -1,9 +1,9 @@ --- -title: 使用主题选择器将主题添加到 GitHub Pages 站点 -intro: '您可以将主题添加到 {% data variables.product.prodname_pages %} 站点，以自定义站点的外观。' +title: Adding a theme to your GitHub Pages site with the theme chooser +intro: 'You can add a theme to your {% data variables.product.prodname_pages %} site to customize your site’s look and feel.' redirect_from: - - /articles/creating-a-github-pages-site-with-the-jekyll-theme-chooser/ - - /articles/adding-a-jekyll-theme-to-your-github-pages-site-with-the-jekyll-theme-chooser/ + - /articles/creating-a-github-pages-site-with-the-jekyll-theme-chooser + - /articles/adding-a-jekyll-theme-to-your-github-pages-site-with-the-jekyll-theme-chooser - /articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser - /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser product: '{% data reusables.gated-features.pages %}' @@ -12,37 +12,40 @@ versions: ghec: '*' topics: - Pages -shortTitle: 将主题添加到 Pages 站点 +shortTitle: Add theme to a Pages site --- -拥有仓库管理员权限的人可以使用主题选择器向 {% data variables.product.prodname_pages %} 站点添加主题。 +People with admin permissions for a repository can use the theme chooser to add a theme to a {% data variables.product.prodname_pages %} site. -## 关于主题选择器 +## About the theme chooser -主题选择器可用于向仓库添加 Jekyll 主题。 有关 Jekyll 的更多信息，请参阅“[关于 {% data variables.product.prodname_pages %} 和 Jekyll](/articles/about-github-pages-and-jekyll)”。 +The theme chooser adds a Jekyll theme to your repository. For more information about Jekyll, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll)." -主题选择器如何工作取决于您的资源库是公共的还是私有的。 - - 如果已为仓库启用 {% data variables.product.prodname_pages %}，主题选择器会将主题添加到当前发布源。 - - 如果您的仓库是公共的，并且已对仓库禁用 {% data variables.product.prodname_pages %}，则使用主题选择器将启用 {% data variables.product.prodname_pages %} 并将默认分支配置为发布源。 - - 如果您的仓库是公共的，并且已对仓库禁用 {% data variables.product.prodname_pages %}，则必须先通过配置发布源来启用 {% data variables.product.prodname_pages %}，然后才可使用主题选择器。 +How the theme chooser works depends on whether your repository is public or private. + - If {% data variables.product.prodname_pages %} is already enabled for your repository, the theme chooser will add your theme to the current publishing source. + - If your repository is public and {% data variables.product.prodname_pages %} is disabled for your repository, using the theme chooser will enable {% data variables.product.prodname_pages %} and configure the default branch as your publishing source. + - If your repository is private and {% data variables.product.prodname_pages %} is disabled for your repository, you must enable {% data variables.product.prodname_pages %} by configuring a publishing source before you can use the theme chooser. -有关发布源的更多信息，请参阅“[关于 {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)”。 +For more information about publishing sources, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)." -如果以前曾手动向仓库添加 Jekyll 主题，则这些文件在使用主题选择器后也可能应用。 为避免冲突，请先删除所有手动添加的主题文件夹和文件，然后再使用主题选择器。 更多信息请参阅“[使用 Jekyll 添加主题到 {% data variables.product.prodname_pages %} 站点](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)”。 +If you manually added a Jekyll theme to your repository in the past, those files may be applied even after you use the theme chooser. To avoid conflicts, remove all manually added theme folders and files before using the theme chooser. For more information, see "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)." -## 使用主题选择器添加主题 +## Adding a theme with the theme chooser {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -3. 在“{% data variables.product.prodname_pages %}”下，单击 **Choose a theme（选择主题）**或 **Change theme（更改主题）**。 ![选择主题按钮](/assets/images/help/pages/choose-a-theme.png) -4. 在页面顶部单击所需的主题，然后单击 **Select theme（选择主题）**。 ![主题选项和选择主题按钮](/assets/images/help/pages/select-theme.png) -5. 系统可能会提示您编辑站点的 *README.md* 文件。 - - 要稍后编辑该文件，请单击 **Cancel（取消）**。 ![编辑文件时取消链接](/assets/images/help/pages/cancel-edit.png) - - 要现在编辑文件，请参阅“[编辑文件](/repositories/working-with-files/managing-files/editing-files)”。 +3. Under "{% data variables.product.prodname_pages %}," click **Choose a theme** or **Change theme**. + ![Choose a theme button](/assets/images/help/pages/choose-a-theme.png) +4. On the top of the page, click the theme you want, then click **Select theme**. + ![Theme options and Select theme button](/assets/images/help/pages/select-theme.png) +5. You may be prompted to edit your site's *README.md* file. + - To edit the file later, click **Cancel**. + ![Cancel link when editing a file](/assets/images/help/pages/cancel-edit.png) + - To edit the file now, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." -您选择的主题将自动应用到仓库中的 Markdown 文件。 要将主题应用到仓库中的 HTML 文件，您需要添加 YAML 前页，以指定每个文件的布局。 更多信息请参阅 Jekyll 网站上的“[前页](https://jekyllrb.com/docs/front-matter/)”。 +Your chosen theme will automatically apply to markdown files in your repository. To apply your theme to HTML files in your repository, you need to add YAML front matter that specifies a layout to each file. For more information, see "[Front Matter](https://jekyllrb.com/docs/front-matter/)" on the Jekyll site. -## 延伸阅读 +## Further reading -- Jekyll 网站上的[主题](https://jekyllrb.com/docs/themes/) +- [Themes](https://jekyllrb.com/docs/themes/) on the Jekyll site diff --git a/translations/zh-CN/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md b/translations/zh-CN/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md index b50ccfe706..5e931e4862 100644 --- a/translations/zh-CN/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md +++ b/translations/zh-CN/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md @@ -1,8 +1,8 @@ --- -title: 配置 GitHub Pages 站点的发布源 -intro: '如果您使用 {% data variables.product.prodname_pages %} 站点的默认发布源，您的站点将自动发布。 You can also choose to publish your site from a different branch or folder.' +title: Configuring a publishing source for your GitHub Pages site +intro: 'If you use the default publishing source for your {% data variables.product.prodname_pages %} site, your site will publish automatically. You can also choose to publish your site from a different branch or folder.' redirect_from: - - /articles/configuring-a-publishing-source-for-github-pages/ + - /articles/configuring-a-publishing-source-for-github-pages - /articles/configuring-a-publishing-source-for-your-github-pages-site - /github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site product: '{% data reusables.gated-features.pages %}' @@ -14,24 +14,41 @@ versions: ghec: '*' topics: - Pages -shortTitle: 配置发布源 +shortTitle: Configure publishing source --- -有关发布源的更多信息，请参阅“[关于 {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)”。 +For more information about publishing sources, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)." -## 选择发布源 +## Choosing a publishing source Before you configure a publishing source, make sure the branch you want to use as your publishing source already exists in your repository. {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -3. 在“{% data variables.product.prodname_pages %}”下，使用 **None（无）**或 **Branch（分支）**下拉菜单选择发布源。 ![用于选择发布源的下拉菜单](/assets/images/help/pages/publishing-source-drop-down.png) -4. （可选）使用下拉菜单选择发布源的文件夹。 ![用于选择发布源文件夹的下拉菜单](/assets/images/help/pages/publishing-source-folder-drop-down.png) -5. 单击 **Save（保存）**。 ![用于保存对发布源设置的更改的按钮](/assets/images/help/pages/publishing-source-save.png) +3. Under "{% data variables.product.prodname_pages %}", use the **None** or **Branch** drop-down menu and select a publishing source. + ![Drop-down menu to select a publishing source](/assets/images/help/pages/publishing-source-drop-down.png) +4. Optionally, use the drop-down menu to select a folder for your publishing source. + ![Drop-down menu to select a folder for publishing source](/assets/images/help/pages/publishing-source-folder-drop-down.png) +5. Click **Save**. + ![Button to save changes to publishing source settings](/assets/images/help/pages/publishing-source-save.png) -## {% data variables.product.prodname_pages %} 站点发布问题疑难排解 +## Troubleshooting publishing problems with your {% data variables.product.prodname_pages %} site {% data reusables.pages.admin-must-push %} -If you choose the `docs` folder on any branch as your publishing source, then later remove the `/docs` folder from that branch in your repository, your site won't build and you'll get a page build error message for a missing `/docs` folder. 更多信息请参阅“[关于 {% data variables.product.prodname_pages %} 站点的 Jekyll 构建错误疑难排解](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites#missing-docs-folder)”。 +If you choose the `docs` folder on any branch as your publishing source, then later remove the `/docs` folder from that branch in your repository, your site won't build and you'll get a page build error message for a missing `/docs` folder. For more information, see "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites#missing-docs-folder)." + +{% ifversion fpt %} + +Your {% data variables.product.prodname_pages %} site will always be deployed with a {% data variables.product.prodname_actions %} workflow run, even if you've configured your {% data variables.product.prodname_pages %} site to be built using a different CI tool. Most external CI workflows "deploy" to GitHub Pages by committing the build output to the `gh-pages` branch of the repository, and typically include a `.nojekyll` file. When this happens, the {% data variables.product.prodname_actions %} worfklow will detect the state that the branch does not need a build step, and will execute only the steps necessary to deploy the site to {% data variables.product.prodname_pages %} servers. + +To find potential errors with either the build or deployment, you can check the workflow run for your {% data variables.product.prodname_pages %} site by reviewing your repository's workflow runs. For more information, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." For more information about how to re-run the workflow in case of an error, see "[Re-running workflows and jobs](/actions/managing-workflow-runs/re-running-workflows-and-jobs)." + +{% note %} + +{% data reusables.pages.pages-builds-with-github-actions-public-beta %} + +{% endnote %} + +{% endif %} diff --git a/translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md b/translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md index a686cc91c0..e2a6857bc7 100644 --- a/translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md +++ b/translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md @@ -1,8 +1,8 @@ --- -title: 为 GitHub Pages 站点创建自定义 404 页面 -intro: 您可以自定义在人们尝试访问您站点上不存在的页面时显示的 404 错误页面。 +title: Creating a custom 404 page for your GitHub Pages site +intro: You can display a custom 404 error page when people try to access nonexistent pages on your site. redirect_from: - - /articles/custom-404-pages/ + - /articles/custom-404-pages - /articles/creating-a-custom-404-page-for-your-github-pages-site - /github/working-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site product: '{% data reusables.gated-features.pages %}' @@ -13,25 +13,26 @@ versions: ghec: '*' topics: - Pages -shortTitle: 创建自定义 404 页面 +shortTitle: Create custom 404 page --- {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.navigate-publishing-source %} {% data reusables.files.add-file %} -3. 在文件名字段中，键入 `404.html` 或 `404.md`。 ![文件名字段](/assets/images/help/pages/404-file-name.png) -4. 如果将文件命名为 `404.md`，请将以下 YAML 前页添加到文件的开头： +3. In the file name field, type `404.html` or `404.md`. + ![File name field](/assets/images/help/pages/404-file-name.png) +4. If you named your file `404.md`, add the following YAML front matter to the beginning of the file: ```yaml --- permalink: /404.html --- ``` -5. 在 YAML 前页（如果存在）下方添加要在 404 页面上显示的内容。 +5. Below the YAML front matter, if present, add the content you want to display on your 404 page. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %} -## 延伸阅读 +## Further reading -- Jekyll 文档中的[前页](http://jekyllrb.com/docs/frontmatter) +- [Front matter](http://jekyllrb.com/docs/frontmatter) in the Jekyll documentation diff --git a/translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md b/translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md index bb645faa2a..fd7bb21e9a 100644 --- a/translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md +++ b/translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md @@ -1,11 +1,11 @@ --- -title: 创建 GitHub Pages 站点 -intro: '您可以在新仓库或现有仓库中创建 {% data variables.product.prodname_pages %} 站点。' +title: Creating a GitHub Pages site +intro: 'You can create a {% data variables.product.prodname_pages %} site in a new or existing repository.' redirect_from: - - /articles/creating-pages-manually/ - - /articles/creating-project-pages-manually/ - - /articles/creating-project-pages-from-the-command-line/ - - /articles/creating-project-pages-using-the-command-line/ + - /articles/creating-pages-manually + - /articles/creating-project-pages-manually + - /articles/creating-project-pages-from-the-command-line + - /articles/creating-project-pages-using-the-command-line - /articles/creating-a-github-pages-site - /github/working-with-github-pages/creating-a-github-pages-site product: '{% data reusables.gated-features.pages %}' @@ -16,12 +16,12 @@ versions: ghec: '*' topics: - Pages -shortTitle: 创建 GitHub Pages 站点 +shortTitle: Create a GitHub Pages site --- {% data reusables.pages.org-owners-can-restrict-pages-creation %} -## 为站点创建仓库 +## Creating a repository for your site {% data reusables.pages.new-or-existing-repo %} @@ -32,7 +32,7 @@ shortTitle: 创建 GitHub Pages 站点 {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %} -## 创建站点 +## Creating your site {% data reusables.pages.must-have-repo-first %} @@ -40,8 +40,8 @@ shortTitle: 创建 GitHub Pages 站点 {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.decide-publishing-source %} -3. 如果所选发布源已存在，请导航到发布源。 如果所选发布源不存在，则创建发布源。 -4. 在发布源的根目录中，创建一个名为 `index.md`、包含要在网站主页上显示的内容的文件。 +3. If your chosen publishing source already exists, navigate to the publishing source. If your chosen publishing source doesn't exist, create the publishing source. +4. In the root of the publishing source, create a new file called `index.md` that contains the content you want to display on the main page of your site. {% tip %} @@ -53,19 +53,20 @@ shortTitle: 创建 GitHub Pages 站点 {% data reusables.pages.sidebar-pages %}{% ifversion fpt or ghec %} {% data reusables.pages.choose-visibility %}{% endif %} {% data reusables.pages.visit-site %} +{% data reusables.pages.check-workflow-run %} {% data reusables.pages.admin-must-push %} -## 后续步骤 +## Next steps -您可以通过创建更多新文件向网站添加更多页面。 每个文件都将在网站上与发布源相同的目录结构中。 例如，如果项目网站的发布源是 `gh-pages` 分支，并且您在 `gh-pages` 分支上创建了名为 `/about/contact-us.md` 的新文件，该文件将在 {% ifversion fpt or ghec %}`https://.github.io//{% else %}`http(s):///pages///{% endif %}about/contact-us.html` 下。 +You can add more pages to your site by creating more new files. Each file will be available on your site in the same directory structure as your publishing source. For example, if the publishing source for your project site is the `gh-pages` branch, and you create a new file called `/about/contact-us.md` on the `gh-pages` branch, the file will be available at {% ifversion fpt or ghec %}`https://.github.io//{% else %}`http(s):///pages///{% endif %}about/contact-us.html`. -您还可以添加主题以自定义网站的外观。 更多信息请参阅{% ifversion fpt or ghec %}“[使用主题选择器添加主题到 {% data variables.product.prodname_pages %} 站点](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser){% else %}”[使用 Jekyll 添加主题到 {% data variables.product.prodname_pages %} 站点](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll){% endif %}”。 +You can also add a theme to customize your site’s look and feel. For more information, see {% ifversion fpt or ghec %}"[Adding a theme to your {% data variables.product.prodname_pages %} site with the theme chooser](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser){% else %}"[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll){% endif %}." -要更多地自定义您的站点，您可以使用 Jekyl - 内置 {% data variables.product.prodname_pages %} 支持的静态站点生成器。 更多信息请参阅“[关于 {% data variables.product.prodname_pages %} 和 Jekyll](/articles/about-github-pages-and-jekyll)”。 +To customize your site even more, you can use Jekyll, a static site generator with built-in support for {% data variables.product.prodname_pages %}. For more information, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll)." -## 延伸阅读 +## Further reading -- "[排查 {% data variables.product.prodname_pages %} 站点的 Jekyll 构建错误](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)" -- “[在仓库内创建和删除分支](/articles/creating-and-deleting-branches-within-your-repository)” -- "[创建新文件](/articles/creating-new-files)" +- "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)" +- "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository)" +- "[Creating new files](/articles/creating-new-files)" diff --git a/translations/zh-CN/content/pages/getting-started-with-github-pages/index.md b/translations/zh-CN/content/pages/getting-started-with-github-pages/index.md index 9a86fdcd81..b391a4458c 100644 --- a/translations/zh-CN/content/pages/getting-started-with-github-pages/index.md +++ b/translations/zh-CN/content/pages/getting-started-with-github-pages/index.md @@ -1,9 +1,9 @@ --- -title: GitHub Pages 使用入门 -intro: '您可以为自己、您的组织或项目设置一个基本 {% data variables.product.prodname_pages %} 站点。' +title: Getting started with GitHub Pages +intro: 'You can set up a basic {% data variables.product.prodname_pages %} site for yourself, your organization, or your project.' redirect_from: - /categories/github-pages-basics - - /articles/additional-customizations-for-github-pages/ + - /articles/additional-customizations-for-github-pages - /articles/getting-started-with-github-pages - /github/working-with-github-pages/getting-started-with-github-pages product: '{% data reusables.gated-features.pages %}' @@ -24,6 +24,6 @@ children: - /securing-your-github-pages-site-with-https - /using-submodules-with-github-pages - /unpublishing-a-github-pages-site -shortTitle: 入门 +shortTitle: Get started --- diff --git a/translations/zh-CN/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md b/translations/zh-CN/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md index a406dc1708..bcc60251c3 100644 --- a/translations/zh-CN/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md +++ b/translations/zh-CN/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md @@ -1,11 +1,11 @@ --- -title: 取消发布 GitHub Pages 站点 -intro: '您可以取消发布 {% data variables.product.prodname_pages %} 站点，使该站点不再可用。' +title: Unpublishing a GitHub Pages site +intro: 'You can unpublish your {% data variables.product.prodname_pages %} site so that the site is no longer available.' redirect_from: - - /articles/how-do-i-unpublish-a-project-page/ - - /articles/unpublishing-a-project-page/ - - /articles/unpublishing-a-project-pages-site/ - - /articles/unpublishing-a-user-pages-site/ + - /articles/how-do-i-unpublish-a-project-page + - /articles/unpublishing-a-project-page + - /articles/unpublishing-a-project-pages-site + - /articles/unpublishing-a-user-pages-site - /articles/unpublishing-a-github-pages-site - /github/working-with-github-pages/unpublishing-a-github-pages-site product: '{% data reusables.gated-features.pages %}' @@ -17,21 +17,22 @@ versions: ghec: '*' topics: - Pages -shortTitle: 取消发布 Pages 站点 +shortTitle: Unpublish Pages site --- -## 取消发布项目站点 +## Unpublishing a project site {% data reusables.repositories.navigate-to-repo %} -2. 如果仓库中存在 `gh-pages` 分支，请删除 `gh-pages` 分支。 更多信息请参阅“[创建和删除仓库中的分支](/articles/creating-and-deleting-branches-within-your-repository#deleting-a-branch)”。 -3. 如果 `gh-pages` 分支是您的发布源，{% ifversion fpt or ghec %}跳到步骤 6{% else %}您的站点现已取消发布，您可以跳过其余步骤{% endif %}。 +2. If a `gh-pages` branch exists in the repository, delete the `gh-pages` branch. For more information, see "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository#deleting-a-branch)." +3. If the `gh-pages` branch was your publishing source, {% ifversion fpt or ghec %}skip to step 6{% else %}your site is now unpublished and you can skip the remaining steps{% endif %}. {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -5. 在“{% data variables.product.prodname_pages %}”下，使用 **Source（源）**下拉菜单并选择 **None（无）**。 ![用于选择发布源的下拉菜单](/assets/images/help/pages/publishing-source-drop-down.png) +5. Under "{% data variables.product.prodname_pages %}", use the **Source** drop-down menu and select **None.** + ![Drop down menu to select a publishing source](/assets/images/help/pages/publishing-source-drop-down.png) {% data reusables.pages.update_your_dns_settings %} -## 取消发布用户或组织站点 +## Unpublishing a user or organization site {% data reusables.repositories.navigate-to-repo %} -2. 删除用作发布源的分支，或删除整个仓库。 更多信息请参阅“[在仓库中创建和删除分支](/articles/creating-and-deleting-branches-within-your-repository#deleting-a-branch)”和“[删除仓库](/articles/deleting-a-repository)”。 +2. Delete the branch that you're using as a publishing source, or delete the entire repository. For more information, see "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository#deleting-a-branch)" and "[Deleting a repository](/articles/deleting-a-repository)." {% data reusables.pages.update_your_dns_settings %} diff --git a/translations/zh-CN/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md b/translations/zh-CN/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md index 726de5a3d8..a29e68ab61 100644 --- a/translations/zh-CN/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md +++ b/translations/zh-CN/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md @@ -1,8 +1,8 @@ --- -title: 将子模块用于 GitHub Pages -intro: '您可以将子模块用于 {% data variables.product.prodname_pages %} 以在站点代码中包含其他项目。' +title: Using submodules with GitHub Pages +intro: 'You can use submodules with {% data variables.product.prodname_pages %} to include other projects in your site''s code.' redirect_from: - - /articles/using-submodules-with-pages/ + - /articles/using-submodules-with-pages - /articles/using-submodules-with-github-pages - /github/working-with-github-pages/using-submodules-with-github-pages product: '{% data reusables.gated-features.pages %}' @@ -11,16 +11,16 @@ versions: ghec: '*' topics: - Pages -shortTitle: 将子模块与 Pages 一起使用 +shortTitle: Use submodules with Pages --- -如果 {% data variables.product.prodname_pages %} 站点的仓库包含子模块，则在构建站点时会自动拉取其内容。 +If the repository for your {% data variables.product.prodname_pages %} site contains submodules, their contents will automatically be pulled in when your site is built. -只能使用指向公共仓库的子模块，因为 {% data variables.product.prodname_pages %} 服务器无法访问私有仓库。 +You can only use submodules that point to public repositories, because the {% data variables.product.prodname_pages %} server cannot access private repositories. -对子模块（包括嵌套子模块）使用 `https://` 只读 URL。 您可以在 _.gitmodules_ 文件中进行此更改。 +Use the `https://` read-only URL for your submodules, including nested submodules. You can make this change in your _.gitmodules_ file. -## 延伸阅读 +## Further reading -- _Pro Git_ 手册中的“[Git 工具 - 子模块](https://git-scm.com/book/en/Git-Tools-Submodules)”。 -- "[排查 {% data variables.product.prodname_pages %} 站点的 Jekyll 构建错误](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)" +- "[Git Tools - Submodules](https://git-scm.com/book/en/Git-Tools-Submodules)" from the _Pro Git_ book +- "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)" diff --git a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index abc7580954..8df4d200f5 100644 --- a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -1,21 +1,21 @@ --- -title: 关于 GitHub Pages 和 Jekyll -intro: 'Jekyll 是一个静态站点生成器，内置 {% data variables.product.prodname_pages %} 支持。' +title: About GitHub Pages and Jekyll +intro: 'Jekyll is a static site generator with built-in support for {% data variables.product.prodname_pages %}.' redirect_from: - /articles/about-jekyll-themes-on-github - /articles/configuring-jekyll - /articles/configuring-jekyll-plugins - /articles/using-syntax-highlighting-on-github-pages - /articles/files-that-start-with-an-underscore-are-missing - - /articles/sitemaps-for-github-pages/ - - /articles/search-engine-optimization-for-github-pages/ - - /articles/repository-metadata-on-github-pages/ - - /articles/atom-rss-feeds-for-github-pages/ - - /articles/redirects-on-github-pages/ - - /articles/emoji-on-github-pages/ - - /articles/mentions-on-github-pages/ - - /articles/using-jekyll-plugins-with-github-pages/ - - /articles/adding-jekyll-plugins-to-a-github-pages-site/ + - /articles/sitemaps-for-github-pages + - /articles/search-engine-optimization-for-github-pages + - /articles/repository-metadata-on-github-pages + - /articles/atom-rss-feeds-for-github-pages + - /articles/redirects-on-github-pages + - /articles/emoji-on-github-pages + - /articles/mentions-on-github-pages + - /articles/using-jekyll-plugins-with-github-pages + - /articles/adding-jekyll-plugins-to-a-github-pages-site - /articles/about-github-pages-and-jekyll - /github/working-with-github-pages/about-github-pages-and-jekyll product: '{% data reusables.gated-features.pages %}' @@ -29,19 +29,19 @@ topics: shortTitle: GitHub Pages & Jekyll --- -## 关于 Jekyll +## About Jekyll -Jekyll 是一个静态站点生成器，内置 {% data variables.product.prodname_pages %} 支持和简化的构建过程。 Jekyll 使用 Markdown 和 HTML 文件，并根据您选择的布局创建完整静态网站。 Jekyll 支持 Markdown 和 Lick，这是一种可在网站上加载动态内容的模板语言。 更多信息请参阅 [Jekyll](https://jekyllrb.com/)。 +Jekyll is a static site generator with built-in support for {% data variables.product.prodname_pages %} and a simplified build process. Jekyll takes Markdown and HTML files and creates a complete static website based on your choice of layouts. Jekyll supports Markdown and Liquid, a templating language that loads dynamic content on your site. For more information, see [Jekyll](https://jekyllrb.com/). -Windows 并未正式支持 Jekyll。 更多信息请参阅 Jekyll 文档中的“[Windows 上的 Jekyll](http://jekyllrb.com/docs/windows/#installation)”。 +Jekyll is not officially supported for Windows. For more information, see "[Jekyll on Windows](http://jekyllrb.com/docs/windows/#installation)" in the Jekyll documentation. -我们建议将 Jekyll 用于 {% data variables.product.prodname_pages %}。 如果您喜欢，可以使用其他静态站点生成器或者在本地或其他服务器上自定义构建过程。 更多信息请参阅“[关于 {% data variables.product.prodname_pages %}](/articles/about-github-pages#static-site-generators)”。 +We recommend using Jekyll with {% data variables.product.prodname_pages %}. If you prefer, you can use other static site generators or customize your own build process locally or on another server. For more information, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#static-site-generators)." -## 在 {% data variables.product.prodname_pages %} 网站中配置 Jekyll +## Configuring Jekyll in your {% data variables.product.prodname_pages %} site -您可以通过编辑 *_config.yml* 文件来配置大多数 Jekyll 设置，例如网站的主题和插件。 更多信息请参阅 Jekyll 文档中的“[配置](https://jekyllrb.com/docs/configuration/)”。 +You can configure most Jekyll settings, such as your site's theme and plugins, by editing your *_config.yml* file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. -对于 {% data variables.product.prodname_pages %} 站点，有些配置设置不能更改。 +Some configuration settings cannot be changed for {% data variables.product.prodname_pages %} sites. ```yaml lsi: false @@ -56,36 +56,36 @@ kramdown: syntax_highlighter: rouge ``` -默认情况下，Jekyll 不会构建以下文件或文件夹： -- 位于文件夹 `/node_modules` 或 `/vendor` 中 -- 开头为 `_`、`.` 或 `#` -- 结尾为 `~` -- 被配置文件中的 `exclude` 设置排除 +By default, Jekyll doesn't build files or folders that: +- are located in a folder called `/node_modules` or `/vendor` +- start with `_`, `.`, or `#` +- end with `~` +- are excluded by the `exclude` setting in your configuration file -如果您想要 Jekyll 处理其中任何文件，可以使用配置文件中的 `includes` 设置。 +If you want Jekyll to process any of these files, you can use the `include` setting in your configuration file. -## 前页附属资料 +## Front matter {% data reusables.pages.about-front-matter %} -您可以添加 `site.github` 到帖子或页面，以将任何仓库引用元数据添加到您的网站。 更多信息请参阅 Jekyll 元数据文档中的“[使用`site.github`](https://jekyll.github.io/github-metadata/site.github/)”。 +You can add `site.github` to a post or page to add any repository references metadata to your site. For more information, see "[Using `site.github`](https://jekyll.github.io/github-metadata/site.github/)" in the Jekyll Metadata documentation. -## 主题 +## Themes -{% data reusables.pages.add-jekyll-theme %} 更多信息请参阅 Jekyll 文档中的“[主题](https://jekyllrb.com/docs/themes/)”。 +{% data reusables.pages.add-jekyll-theme %} For more information, see "[Themes](https://jekyllrb.com/docs/themes/)" in the Jekyll documentation. {% ifversion fpt or ghec %} -您可以在 {% data variables.product.prodname_dotcom %} 上添加支持的主题到站点。 更多信息请参阅 {% data variables.product.prodname_pages %} 站点上“[支持的主题](https://pages.github.com/themes/)"和"[使用主题选择器添加主题到 {% data variables.product.prodname_pages %} 站点](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser)”。 +You can add a supported theme to your site on {% data variables.product.prodname_dotcom %}. For more information, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and "[Adding a theme to your {% data variables.product.prodname_pages %} site with the theme chooser](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser)." -要使用 {% data variables.product.prodname_dotcom %} 上托管的任何其他开源 Jekyll 主题，您可以手动添加主题。{% else %} 您可以手动添加主题到站点。{% endif %} 更多信息请参阅{% ifversion fpt or ghec %} [{% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) 上托管的主题和 {% else %}{% data variables.product.prodname_pages %} 站点上 "[支持的主题](https://pages.github.com/themes/)"和{% endif %}“[使用 Jekyll 添加主题到 {% data variables.product.prodname_pages %} 站点](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)”。 +To use any other open source Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, you can add the theme manually.{% else %} You can add a theme to your site manually.{% endif %} For more information, see{% ifversion fpt or ghec %} [themes hosted on {% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) and{% else %} "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and{% endif %} "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)." -您可以通过编辑主题文件来覆盖任何主题的默认值。 更多信息请参阅您的主题文档和 Jekyll 文档中的“[覆盖主题默认值](https://jekyllrb.com/docs/themes/#overriding-theme-defaults)“。 +You can override any of your theme's defaults by editing the theme's files. For more information, see your theme's documentation and "[Overriding your theme's defaults](https://jekyllrb.com/docs/themes/#overriding-theme-defaults)" in the Jekyll documentation. -## 插件 +## Plugins -您可以下载或创建 Jekyll 插件，以便为您的网站扩展 Jekyll 的功能。 例如， [jemoji](https://github.com/jekyll/jemoji) 插件允许您在站点的任何页面上使用 {% data variables.product.prodname_dotcom %} 风格的表情符号，就像在 {% data variables.product.prodname_dotcom %} 上使用一样。 更多信息请参阅 Jekyll 文档中的“[插件](https://jekyllrb.com/docs/plugins/)”。 +You can download or create Jekyll plugins to extend the functionality of Jekyll for your site. For example, the [jemoji](https://github.com/jekyll/jemoji) plugin lets you use {% data variables.product.prodname_dotcom %}-flavored emoji in any page on your site the same way you would on {% data variables.product.prodname_dotcom %}. For more information, see "[Plugins](https://jekyllrb.com/docs/plugins/)" in the Jekyll documentation. -{% data variables.product.prodname_pages %} 使用默认启用且不能禁用的插件： +{% data variables.product.prodname_pages %} uses plugins that are enabled by default and cannot be disabled: - [`jekyll-coffeescript`](https://github.com/jekyll/jekyll-coffeescript) - [`jekyll-default-layout`](https://github.com/benbalter/jekyll-default-layout) - [`jekyll-gist`](https://github.com/jekyll/jekyll-gist) @@ -96,25 +96,25 @@ kramdown: - [`jekyll-titles-from-headings`](https://github.com/benbalter/jekyll-titles-from-headings) - [`jekyll-relative-links`](https://github.com/benbalter/jekyll-relative-links) -您可以通过在 *_config.yml* 文件中添加插件的 gem 到 `plugins` 设置来启用额外的插件。 更多信息请参阅 Jekyll 文档中的“[配置](https://jekyllrb.com/docs/configuration/)”。 +You can enable additional plugins by adding the plugin's gem to the `plugins` setting in your *_config.yml* file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. -有关支持的插件列表，请参阅 {% data variables.product.prodname_pages %} 网站上的“[依赖项版本](https://pages.github.com/versions/)”。 有关特定插件的使用信息，请参阅插件的文档。 +For a list of supported plugins, see "[Dependency versions](https://pages.github.com/versions/)" on the {% data variables.product.prodname_pages %} site. For usage information for a specific plugin, see the plugin's documentation. {% tip %} -**提示：** 您可以保持更新 {% data variables.product.prodname_pages %} gem，确保使用所有插件的最新版本。 更多信息请参阅 {% data variables.product.prodname_pages %} 网站上的“[使用 Jekyll 本地测试 GitHub Pages 站点](/articles/testing-your-github-pages-site-locally-with-jekyll#updating-the-github-pages-gem)”和“[依赖项版本](https://pages.github.com/versions/)”。 +**Tip:** You can make sure you're using the latest version of all plugins by keeping the {% data variables.product.prodname_pages %} gem updated. For more information, see "[Testing your GitHub Pages site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll#updating-the-github-pages-gem)" and "[Dependency versions](https://pages.github.com/versions/)" on the {% data variables.product.prodname_pages %} site. {% endtip %} -{% data variables.product.prodname_pages %} 无法使用不支持的插件构建网站。 如果想使用不支持的插件，请在本地生成网站，然后将网站的静态文件推送到 {% data variables.product.product_name %}。 +{% data variables.product.prodname_pages %} cannot build sites using unsupported plugins. If you want to use unsupported plugins, generate your site locally and then push your site's static files to {% data variables.product.product_name %}. -## 语法突显 +## Syntax highlighting -为了使网站更容易读取，代码片段在 {% data variables.product.prodname_pages %} 上突显，就像在 {% data variables.product.product_name %} 上突显一样。 有关在 {% data variables.product.product_name %} 上突显语法的更多信息，请参阅“[创建和突显代码块](/articles/creating-and-highlighting-code-blocks)”。 +To make your site easier to read, code snippets are highlighted on {% data variables.product.prodname_pages %} sites the same way they're highlighted on {% data variables.product.product_name %}. For more information about syntax highlighting on {% data variables.product.product_name %}, see "[Creating and highlighting code blocks](/articles/creating-and-highlighting-code-blocks)." -默认情况下，网站上的代码块将被 Jekyll 突出显示。 Jekyll 使用 [Rouge](https://github.com/jneen/rouge) 突显工具，它兼容于 [Pygments](http://pygments.org/)。 如果在 *_config.yml* 文件中指定 Pygments，将改用 Rouge。 Jekyll 不能使用任何其他语法突显工具，如果您在 *_config.yml* 文件中指定其他语法突显工具，将会收到页面构建警告。 更多信息请参阅“[关于 {% data variables.product.prodname_pages %} 站点的 Jekyll 构建错误](/articles/about-jekyll-build-errors-for-github-pages-sites)”。 +By default, code blocks on your site will be highlighted by Jekyll. Jekyll uses the [Rouge](https://github.com/jneen/rouge) highlighter, which is compatible with [Pygments](http://pygments.org/). If you specify Pygments in your *_config.yml* file, Rouge will be used instead. Jekyll cannot use any other syntax highlighter, and you'll get a page build warning if you specify another syntax highlighter in your *_config.yml* file. For more information, see "[About Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/about-jekyll-build-errors-for-github-pages-sites)." -如果想使用其他突显工具，如 `highlight.js`，则必须更新项目的 *_config.yml* 文件来禁用 Jekyll 的语法突显。 +If you want to use another highlighter, such as `highlight.js`, you must disable Jekyll's syntax highlighting by updating your project's *_config.yml* file. ```yaml kramdown: @@ -122,12 +122,12 @@ kramdown: disable : true ``` -如果您的主题不含用于语法突显的 CSS，可以生成 {% data variables.product.prodname_dotcom %} 的语法突显 CSS 并将其添加到项目的 `style.css` 文件。 +If your theme doesn't include CSS for syntax highlighting, you can generate {% data variables.product.prodname_dotcom %}'s syntax highlighting CSS and add it to your project's `style.css` file. ```shell $ rougify style github > style.css ``` -## 本地构建网站 +## Building your site locally {% data reusables.pages.test-locally %} diff --git a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 4b37a72160..c5b53d6108 100644 --- a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -36,15 +36,34 @@ If Jekyll does attempt to build your site and encounters an error, you will rece For more information about troubleshooting build errors, see "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)." -## Viewing Jekyll build error messages +{% ifversion fpt %} +## Viewing Jekyll build error messages with {% data variables.product.prodname_actions %} + +By default, your {% data variables.product.prodname_pages %} site is built and deployed with a {% data variables.product.prodname_actions %} workflow run unless you've configured your {% data variables.product.prodname_pages %} site to use a different CI tool. To find potential build errors, you can check the workflow run for your {% data variables.product.prodname_pages %} site by reviewing your repository's workflow runs. For more information, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." For more information about how to re-run the workflow in case of an error, see "[Re-running workflows and jobs](/actions/managing-workflow-runs/re-running-workflows-and-jobs)." +{% note %} + +{% data reusables.pages.pages-builds-with-github-actions-public-beta %} + +{% endnote %} +{% endif %} + +## Viewing your repository's build failures on {% data variables.product.product_name %} + +You can see build failures (but not build warnings) for your site on {% data variables.product.product_name %} in the **Settings** tab of your site's repository. + +## Viewing Jekyll build error messages locally We recommend testing your site locally, which allows you to see build error messages on the command line, and addressing any build failures before pushing changes to {% data variables.product.product_name %}. For more information, see "[Testing your {% data variables.product.prodname_pages %} site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)." +## Viewing Jekyll build error messages in your pull request + When you create a pull request to update your publishing source on {% data variables.product.product_name %}, you can see build error messages on the **Checks** tab of the pull request. For more information, see "[About status checks](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." +## Viewing Jekyll build errors by email + When you push changes to your publishing source on {% data variables.product.product_name %}, {% data variables.product.prodname_pages %} will attempt to build your site. If the build fails, you'll receive an email at your primary email address. You'll also receive emails for build warnings. {% data reusables.pages.build-failure-email-server %} -You can see build failures (but not build warnings) for your site on {% data variables.product.product_name %} in the **Settings** tab of your site's repository. +## Viewing Jekyll build error messages in your pull request with a third-party CI service You can configure a third-party service, such as [Travis CI](https://travis-ci.org/), to display error messages after each commit. diff --git a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md index c06bf5ffce..43c4262281 100644 --- a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md +++ b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md @@ -1,6 +1,6 @@ --- -title: 使用 Jekyll 创建 GitHub Pages 站点 -intro: '您可以使用 Jekyll 在新仓库或现有仓库中创建 {% data variables.product.prodname_pages %} 站点。' +title: Creating a GitHub Pages site with Jekyll +intro: 'You can use Jekyll to create a {% data variables.product.prodname_pages %} site in a new or existing repository.' product: '{% data reusables.gated-features.pages %}' redirect_from: - /articles/creating-a-github-pages-site-with-jekyll @@ -13,20 +13,20 @@ versions: ghec: '*' topics: - Pages -shortTitle: 使用 Jekyll 创建站点 +shortTitle: Create site with Jekyll --- {% data reusables.pages.org-owners-can-restrict-pages-creation %} -## 基本要求 +## Prerequisites -必须安装 Jekyll 和 Git 后才可使用 Jekyll 创建 {% data variables.product.prodname_pages %} 站点。 更多信息请参阅 Jekyll 文档中的[安装](https://jekyllrb.com/docs/installation/)和“[设置 Git](/articles/set-up-git)”。 +Before you can use Jekyll to create a {% data variables.product.prodname_pages %} site, you must install Jekyll and Git. For more information, see [Installation](https://jekyllrb.com/docs/installation/) in the Jekyll documentation and "[Set up Git](/articles/set-up-git)." {% data reusables.pages.recommend-bundler %} {% data reusables.pages.jekyll-install-troubleshooting %} -## 为站点创建仓库 +## Creating a repository for your site {% data reusables.pages.new-or-existing-repo %} @@ -35,72 +35,72 @@ shortTitle: 使用 Jekyll 创建站点 {% data reusables.pages.create-repo-name %} {% data reusables.repositories.choose-repo-visibility %} -## 创建站点 +## Creating your site {% data reusables.pages.must-have-repo-first %} {% data reusables.pages.private_pages_are_public_warning %} {% data reusables.command_line.open_the_multi_os_terminal %} -1. 如果您还没有本地版仓库，请导航到您想要存储站点源文件的位置，将 _PARENT-FOLDER_ 替换为要包含仓库文件夹的文件夹。 +1. If you don't already have a local copy of your repository, navigate to the location where you want to store your site's source files, replacing _PARENT-FOLDER_ with the folder you want to contain the folder for your repository. ```shell $ cd PARENT-FOLDER ``` -1. 如果尚未初始化本地 Git 仓库，请将 _REPOSITORY-NAME_ 替换为仓库名称。 +1. If you haven't already, initialize a local Git repository, replacing _REPOSITORY-NAME_ with the name of your repository. ```shell $ git init REPOSITORY-NAME > Initialized empty Git repository in /Users/octocat/my-site/.git/ # Creates a new folder on your computer, initialized as a Git repository ``` - 4. 将目录更改为仓库。 + 4. Change directories to the repository. ```shell $ cd REPOSITORY-NAME # Changes the working directory ``` {% data reusables.pages.decide-publishing-source %} {% data reusables.pages.navigate-publishing-source %} - 例如，如果选择从默认分支上的 `docs` 文件夹发布站点，则创建并切换目录到 `docs` 文件夹。 + For example, if you chose to publish your site from the `docs` folder on the default branch, create and change directories to the `docs` folder. ```shell $ mkdir docs # Creates a new folder called docs $ cd docs ``` - 如果选择从 `gh-pages` 分支发布站点，则创建并检出 `gh-pages` 分支。 + If you chose to publish your site from the `gh-pages` branch, create and checkout the `gh-pages` branch. ```shell $ git checkout --orphan gh-pages # Creates a new branch, with no history or contents, called gh-pages and switches to the gh-pages branch ``` -1. 要创建新 Jekyll 站点，请使用 `jekyll new` 命令： +1. To create a new Jekyll site, use the `jekyll new` command: ```shell $ jekyll new --skip-bundle . # Creates a Jekyll site in the current directory ``` -1. 打开 Jekyll 创建的 Gemfile 文件。 -1. 将 "#" 添加到以 `gem "jekyll "` 开头的行首，以注释此行。 -1. 编辑以 `# gem "github-pages"` 开头的行来添加 `github-pages` gem。 将此行更改为： +1. Open the Gemfile that Jekyll created. +1. Add "#" to the beginning of the line that starts with `gem "jekyll"` to comment out this line. +1. Add the `github-pages` gem by editing the line starting with `# gem "github-pages"`. Change this line to: ```shell gem "github-pages", "~> GITHUB-PAGES-VERSION", group: :jekyll_plugins ``` - 将 _GITHUB-PAGES-VERSION_ 替换为 `github-pages` gem 的最新支持版本。 您可以在这里找到这个版本：“[依赖项版本](https://pages.github.com/versions/)”。 + Replace _GITHUB-PAGES-VERSION_ with the latest supported version of the `github-pages` gem. You can find this version here: "[Dependency versions](https://pages.github.com/versions/)." - 正确版本 Jekyll 将安装为 `github-pages` gem 的依赖项。 -1. 保存并关闭 Gemfile。 -1. 从命令行运行 `bundle install`。 -1. （可选）对 `_config.yml` 文件进行任何必要的编辑。 当仓库托管在子目录时相对路径需要此设置。 更多信息请参阅“[将子文件夹拆分到新仓库](/github/getting-started-with-github/using-git/splitting-a-subfolder-out-into-a-new-repository)”。 + The correct version Jekyll will be installed as a dependency of the `github-pages` gem. +1. Save and close the Gemfile. +1. From the command line, run `bundle install`. +1. Optionally, make any necessary edits to the `_config.yml` file. This is required for relative paths when the repository is hosted in a subdirectory. For more information, see "[Splitting a subfolder out into a new repository](/github/getting-started-with-github/using-git/splitting-a-subfolder-out-into-a-new-repository)." ```yml domain: my-site.github.io # if you want to force HTTPS, specify the domain without the http at the start, e.g. example.com url: https://my-site.github.io # the base hostname and protocol for your site, e.g. http://example.com baseurl: /REPOSITORY-NAME/ # place folder name if the site is served in a subfolder ``` -1. （可选）在本地测试您的站点。 更多信息请参阅“[使用 Jekyll 在本地测试 {% data variables.product.prodname_pages %} 站点](/articles/testing-your-github-pages-site-locally-with-jekyll)”。 -1. 添加并提交您的工作。 +1. Optionally, test your site locally. For more information, see "[Testing your {% data variables.product.prodname_pages %} site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)." +1. Add and commit your work. ```shell git add . git commit -m 'Initial GitHub pages site with Jekyll' ``` -1. 将您在 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 上的仓库添加为远程，使用企业的主机名替换 {% ifversion ghes or ghae %}_HOSTNAME_，{% endif %} _USER_ 替换为拥有该仓库的帐户{% ifversion ghes or ghae %}，{% endif %}并且 _REPOSITORY_ 替换为仓库名称。 +1. Add your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} as a remote, replacing {% ifversion ghes or ghae %}_HOSTNAME_ with your enterprise's hostname,{% endif %} _USER_ with the account that owns the repository{% ifversion ghes or ghae %},{% endif %} and _REPOSITORY_ with the name of the repository. ```shell {% ifversion fpt or ghec %} $ git remote add origin https://github.com/USER/REPOSITORY.git @@ -108,7 +108,7 @@ $ git remote add origin https://github.com/USER/REPOSITORY.git $ git remote add origin https://HOSTNAME/USER/REPOSITORY.git {% endif %} ``` -1. 将仓库推送到 {% data variables.product.product_name %}，_BRANCH_ 替换为您所操作的分支的名称。 +1. Push the repository to {% data variables.product.product_name %}, replacing _BRANCH_ with the name of the branch you're working on. ```shell $ git push -u origin BRANCH ``` @@ -119,11 +119,12 @@ $ git remote add origin https://HOSTNAME/USER/REPOSITORY Configuration file: /Users/octocat/my-site/_config.yml @@ -48,17 +48,17 @@ shortTitle: 使用 Jekyll 本地测试站点 > Server address: http://127.0.0.1:4000/ > Server running... press ctrl-c to stop. ``` -3. 要预览站点，请在 web 浏览器中导航到 `http://localhost:4000`。 +3. To preview your site, in your web browser, navigate to `http://localhost:4000`. -## 更新 {% data variables.product.prodname_pages %} gem +## Updating the {% data variables.product.prodname_pages %} gem -Jekyll 是一个活跃的开源项目，经常更新。 如果您计算机上的 `github-pages` gem 版本落后于 {% data variables.product.prodname_pages %} 服务器上的 `github-pages` gem 版本，则您的站点在本地构建时的外观与在 {% data variables.product.product_name %} 上发布时的外观可能不同。 为避免这种情况，请定期更新计算机上的 `github-pages` gem。 +Jekyll is an active open source project that is updated frequently. If the `github-pages` gem on your computer is out of date with the `github-pages` gem on the {% data variables.product.prodname_pages %} server, your site may look different when built locally than when published on {% data variables.product.product_name %}. To avoid this, regularly update the `github-pages` gem on your computer. {% data reusables.command_line.open_the_multi_os_terminal %} -2. 更新 `github-pages` gem。 - - 如果您安装了 Bundler，请运行 `bundle update github-pages`。 - - 如果未安装 Bundler，则运行 `gem update github-pages`. +2. Update the `github-pages` gem. + - If you installed Bundler, run `bundle update github-pages`. + - If you don't have Bundler installed, run `gem update github-pages`. -## 延伸阅读 +## Further reading -- Jekyll 文档中的 [{% data variables.product.prodname_pages %}](http://jekyllrb.com/docs/github-pages/) +- [{% data variables.product.prodname_pages %}](http://jekyllrb.com/docs/github-pages/) in the Jekyll documentation diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/index.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/index.md index 5977e1bbe4..c9264010b1 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/index.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/index.md @@ -1,8 +1,8 @@ --- -title: 解决合并冲突 -intro: 如果您的更改与基本分支存在合并冲突，必须解决该冲突后才可合并拉取请求的更改。 +title: Addressing merge conflicts +intro: 'If your changes have merge conflicts with the base branch, you must address the merge conflicts before you can merge your pull request''s changes.' redirect_from: - - /github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts/ + - /github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts - /articles/addressing-merge-conflicts - /github/collaborating-with-pull-requests/addressing-merge-conflicts versions: @@ -16,6 +16,5 @@ children: - /about-merge-conflicts - /resolving-a-merge-conflict-on-github - /resolving-a-merge-conflict-using-the-command-line -shortTitle: 地址合并冲突 +shortTitle: Address merge conflicts --- - diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md index a162e0ec96..7354246bea 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md @@ -1,9 +1,9 @@ --- -title: 使用命令行解决合并冲突 -intro: 您可以使用命令行和文本编辑器解决合并冲突。 +title: Resolving a merge conflict using the command line +intro: You can resolve merge conflicts using the command line and a text editor. redirect_from: - /github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line - - /articles/resolving-a-merge-conflict-from-the-command-line/ + - /articles/resolving-a-merge-conflict-from-the-command-line - /articles/resolving-a-merge-conflict-using-the-command-line - /github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line - /github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line @@ -14,29 +14,28 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: 解决 Git 中的合并冲突 +shortTitle: Resolve merge conflicts in Git --- - -当对文件的同一行进行竞争更改时，或者当一个人编辑文件而另一个人删除同一文件时，会发生合并冲突。 更多信息请参阅“[关于合并冲突](/articles/about-merge-conflicts/)”。 +Merge conflicts occur when competing changes are made to the same line of a file, or when one person edits a file and another person deletes the same file. For more information, see "[About merge conflicts](/articles/about-merge-conflicts/)." {% tip %} -**提示：**您可以使用冲突编辑器在 {% data variables.product.product_name %} 上解决作为拉取请求组成部分的各分支之间的竞争行更改合并冲突。 更多信息请参阅“[在 GitHub 上解决合并冲突](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)”。 +**Tip:** You can use the conflict editor on {% data variables.product.product_name %} to resolve competing line change merge conflicts between branches that are part of a pull request. For more information, see "[Resolving a merge conflict on GitHub](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)." {% endtip %} -## 竞争行更改合并冲突 +## Competing line change merge conflicts -要解决由竞争行更改导致的合并冲突，您必须从新提交的不同分支中选择要合并的更改。 +To resolve a merge conflict caused by competing line changes, you must choose which changes to incorporate from the different branches in a new commit. -例如，如果您和另一个人都在同一 Git 仓库不同分支的同一行中编辑了 _styleguide.md_ 文件，则在尝试合并这些分支时会发生合并冲突错误。 必须使用新提交解决这一合并冲突，然后才能合并这些分支。 +For example, if you and another person both edited the file _styleguide.md_ on the same lines in different branches of the same Git repository, you'll get a merge conflict error when you try to merge these branches. You must resolve this merge conflict with a new commit before you can merge these branches. {% data reusables.command_line.open_the_multi_os_terminal %} -2. 导航到有合并冲突的本地 Git 仓库中。 +2. Navigate into the local Git repository that has the merge conflict. ```shell cd REPOSITORY-NAME ``` -3. 生成受合并冲突影响的文件列表。 在此例中，文件 *styleguide.md* 存在合并冲突。 +3. Generate a list of the files affected by the merge conflict. In this example, the file *styleguide.md* has a merge conflict. ```shell $ git status > # On branch branch-b @@ -50,8 +49,8 @@ shortTitle: 解决 Git 中的合并冲突 > # > no changes added to commit (use "git add" and/or "git commit -a") ``` -4. 打开您首选的文本编辑器，例如 [Atom](https://atom.io/)，然后导航到有合并冲突的文件。 -5. 要在文件中查看合并冲突的开头，请在文件中搜索冲突标记 `<<<<<<<`。 当您在文本编辑器中打开文件时，您会在行 `<<<<<<< HEAD` 后看到头部或基础分支。 接下来，您将看到 `=======`，它将您的更改与其他分支中的更改分开，后跟 `>>>>>>> BRANCH-NAME`。 在本例中，一个人在基础或头部分支中编写“open an issue”，而另一个人在比较分支或 `branch-a` 中编写“ask your question in IRC”。 +4. Open your favorite text editor, such as [Atom](https://atom.io/), and navigate to the file that has merge conflicts. +5. To see the beginning of the merge conflict in your file, search the file for the conflict marker `<<<<<<<`. When you open the file in your text editor, you'll see the changes from the HEAD or base branch after the line `<<<<<<< HEAD`. Next, you'll see `=======`, which divides your changes from the changes in the other branch, followed by `>>>>>>> BRANCH-NAME`. In this example, one person wrote "open an issue" in the base or HEAD branch and another person wrote "ask your question in IRC" in the compare branch or `branch-a`. ``` If you have questions, please @@ -61,34 +60,34 @@ shortTitle: 解决 Git 中的合并冲突 ask your question in IRC. >>>>>>> branch-a ``` -{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %} 在本例中，两个更改均整合到最终合并： +{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %} In this example, both changes are incorporated into the final merge: ```shell If you have questions, please open an issue or ask in our IRC channel if it's more urgent. ``` -7. 添加或暂存您的更改。 +7. Add or stage your changes. ```shell $ git add . ``` -8. 提交您的更改及注释。 +8. Commit your changes with a comment. ```shell $ git commit -m "Resolved merge conflict by incorporating both suggestions." ``` -现在，您可以在命令行上合并分支，或在 {% data variables.product.product_name %} 上 [将更改推送到远程仓库](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)和在拉取请求中[合并更改](/articles/merging-a-pull-request/)。 +You can now merge the branches on the command line or [push your changes to your remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) on {% data variables.product.product_name %} and [merge your changes](/articles/merging-a-pull-request/) in a pull request. -## 删除的文件合并冲突 +## Removed file merge conflicts -要解决由对文件进行竞争更改而导致的合并冲突，对于一个人删除分支中的文件而另一个人编辑同一文件的情况，您必须选择是删除还是将删除的文件保留在新提交中。 +To resolve a merge conflict caused by competing changes to a file, where a person deletes a file in one branch and another person edits the same file, you must choose whether to delete or keep the removed file in a new commit. -例如，如果您编辑一个文件（如 *README.md*），而另一个人在同一 Git 仓库的另一个分支中删除同一文件，当您尝试合并这些分支时将发生合并冲突错误。 必须使用新提交解决这一合并冲突，然后才能合并这些分支。 +For example, if you edited a file, such as *README.md*, and another person removed the same file in another branch in the same Git repository, you'll get a merge conflict error when you try to merge these branches. You must resolve this merge conflict with a new commit before you can merge these branches. {% data reusables.command_line.open_the_multi_os_terminal %} -2. 导航到有合并冲突的本地 Git 仓库中。 +2. Navigate into the local Git repository that has the merge conflict. ```shell cd REPOSITORY-NAME ``` -2. 生成受合并冲突影响的文件列表。 在此例中，文件 *README.md* 存在合并冲突。 +2. Generate a list of the files affected by the merge conflict. In this example, the file *README.md* has a merge conflict. ```shell $ git status > # On branch main @@ -101,33 +100,32 @@ shortTitle: 解决 Git 中的合并冲突 > # Unmerged paths: > # (use "git add/rm ..." as appropriate to mark resolution) > # - > # deleted by us: README.md + > # deleted by us: README.md > # > # no changes added to commit (use "git add" and/or "git commit -a") ``` -3. 打开您首选的文本编辑器，例如 [Atom](https://atom.io/)，然后导航到有合并冲突的文件。 -6. 决定是否要保留删除的文件。 您可能想要在文本编辑器中查看对删除的文件所做的最新更改。 +3. Open your favorite text editor, such as [Atom](https://atom.io/), and navigate to the file that has merge conflicts. +6. Decide if you want keep the removed file. You may want to view the latest changes made to the removed file in your text editor. - 要将已删除的文件重新添加到仓库： + To add the removed file back to your repository: ```shell $ git add README.md ``` - 要从仓库中删除此文件： + To remove this file from your repository: ```shell $ git rm README.md > README.md: needs merge > rm 'README.md' ``` -7. 提交您的更改及注释。 +7. Commit your changes with a comment. ```shell $ git commit -m "Resolved merge conflict by keeping README.md file." > [branch-d 6f89e49] Merge branch 'branch-c' into branch-d - > [branch-d 6f89e49] Merge branch 'branch-c' into branch-d ``` -现在，您可以在命令行上合并分支，或在 {% data variables.product.product_name %} 上 [将更改推送到远程仓库](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)和在拉取请求中[合并更改](/articles/merging-a-pull-request/)。 +You can now merge the branches on the command line or [push your changes to your remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) on {% data variables.product.product_name %} and [merge your changes](/articles/merging-a-pull-request/) in a pull request. -## 延伸阅读 +## Further reading -- “[关于合并冲突](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)” -- “[本地检出拉取请求](/articles/checking-out-pull-requests-locally/)” +- "[About merge conflicts](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)" +- "[Checking out pull requests locally](/articles/checking-out-pull-requests-locally/)" diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md index 4ae4adab22..a578538671 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md @@ -1,9 +1,9 @@ --- -title: 关于状态检查 -intro: 状态检查用于获知您的提交是否符合为您参与的仓库设置的条件。 +title: About status checks +intro: Status checks let you know if your commits meet the conditions set for the repository you're contributing to. redirect_from: - /github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks - - /articles/about-statuses/ + - /articles/about-statuses - /articles/about-status-checks - /github/collaborating-with-issues-and-pull-requests/about-status-checks - /github/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks @@ -15,33 +15,32 @@ versions: topics: - Pull requests --- +Status checks are based on external processes, such as continuous integration builds, which run for each push you make to a repository. You can see the *pending*, *passing*, or *failing* state of status checks next to individual commits in your pull request. -状态检查基于针对您每次向仓库的推送而运行的外部流程，例如持续集成构建。 您可以在拉取请求的个别提交旁边看到状态检查的*待处理*、*通过*或*失败*状态。 +![List of commits and statuses](/assets/images/help/pull_requests/commit-list-statuses.png) -![提交和状态列表](/assets/images/help/pull_requests/commit-list-statuses.png) +Anyone with write permissions to a repository can set the state for any status check in the repository. -对仓库具有写入权限的任何人都可为仓库中的任何状态检查设置状态。 - -在仓库的分支页面或仓库的拉取请求列表中，可以查看仓库上次提交的整体状态。 +You can see the overall state of the last commit to a branch on your repository's branches page or in your repository's list of pull requests. {% data reusables.pull_requests.required-checks-must-pass-to-merge %} -## {% data variables.product.product_name %} 上的状态检查类型 +## Types of status checks on {% data variables.product.product_name %} -{% data variables.product.product_name %} 上的状态检查有两种类型： +There are two types of status checks on {% data variables.product.product_name %}: -- 检查 -- 状态 +- Checks +- Statuses _Checks_ are different from _statuses_ in that they provide line annotations, more detailed messaging, and are only available for use with {% data variables.product.prodname_github_apps %}. -组织所有者和能够推送到仓库的用户可使用 {% data variables.product.product_name %} 的 API 创建检查和状态。 更多信息请参阅“[检查](/rest/reference/checks)”和“[状态](/rest/reference/repos#statuses)”。 +Organization owners and users with push access to a repository can create checks and statuses with {% data variables.product.product_name %}'s API. For more information, see "[Checks](/rest/reference/checks)" and "[Statuses](/rest/reference/repos#statuses)." -## 检查 +## Checks -在仓库中设置_检查_时，拉取请求会有一个 **Checks（检查）**选项卡，从中可以查看状态检查的详细构建输出和重新运行失败的检查。 +When _checks_ are set up in a repository, pull requests have a **Checks** tab where you can view detailed build output from status checks and rerun failed checks. -![拉取请求中的状态检查](/assets/images/help/pull_requests/checks.png) +![Status checks within a pull request](/assets/images/help/pull_requests/checks.png) {% note %} @@ -49,28 +48,28 @@ _Checks_ are different from _statuses_ in that they provide line annotations, mo {% endnote %} -当提交中的特定行造成检查失败时，您会在拉取请求的 **Files（文件）**选项卡中相关代码旁边看到有关失败、警告或通知的详细信息。 +When a specific line in a commit causes a check to fail, you will see details about the failure, warning, or notice next to the relevant code in the **Files** tab of the pull request. -![状态检查详细信息](/assets/images/help/pull_requests/checks-detailed.png) +![Details of a status check](/assets/images/help/pull_requests/checks-detailed.png) -您可以使用 **Conversation（对话）**选项卡下的提交下拉菜单，浏览拉取请求中不同提交的检查摘要。 +You can navigate between the checks summaries for various commits in a pull request, using the commit drop-down menu under the **Conversation** tab. -![下拉菜单中不同提交的检查摘要](/assets/images/help/pull_requests/checks-summary-for-various-commits.png) +![Check summaries for different commits in a drop-down menu](/assets/images/help/pull_requests/checks-summary-for-various-commits.png) -### 跳过和申请个别提交的检查 +### Skipping and requesting checks for individual commits -当仓库设置为自动申请检查推送时，您可以选择跳过所推送的个别提交的检查。 当仓库_未_设置为自动申请检查推送时，您可以申请检查您推送的个别提交。 有关这些设置的更多信息，请参阅“[检查套件](/rest/reference/checks#update-repository-preferences-for-check-suites)”。 +When a repository is set to automatically request checks for pushes, you can choose to skip checks for an individual commit you push. When a repository is _not_ set to automatically request checks for pushes, you can request checks for an individual commit you push. For more information on these settings, see "[Check Suites](/rest/reference/checks#update-repository-preferences-for-check-suites)." -要跳过或申请检查提交，请在提交消息末添加以下尾行之一： +To skip or request checks for your commit, add one of the following trailer lines to the end of your commit message: -- 要_跳过检查_提交，请输入提交消息以及简短、有意义的更改描述。 提交说明后，在右引号之前，添加两个空行，后接 `skip-checks: true`： +- To _skip checks_ for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by `skip-checks: true`: ```shell $ git commit -m "Update README > > skip-checks: true" ``` -- 要_申请检查_提交，请输入提交消息以及简短、有意义的更改描述。 提交说明后，在右引号之前，添加两个空行，后接 `request-checks: true`： +- To _request_ checks for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by `request-checks: true`: ```shell $ git commit -m "Refactor usability tests > diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md index 49174a1857..cdec1046a8 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md @@ -1,9 +1,9 @@ --- -title: 关于拉取请求合并 +title: About pull request merges intro: 'You can [merge pull requests](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request) by retaining all the commits in a feature branch, squashing all commits into a single commit, or by rebasing individual commits from the `head` branch onto the `base` branch.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges - - /articles/about-pull-request-merge-squashing/ + - /articles/about-pull-request-merge-squashing - /articles/about-pull-request-merges - /github/collaborating-with-issues-and-pull-requests/about-pull-request-merges - /github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges @@ -15,47 +15,46 @@ versions: topics: - Pull requests --- - {% data reusables.pull_requests.default_merge_option %} -## 压缩与合并拉取请求提交 +## Squash and merge your pull request commits {% data reusables.pull_requests.squash_and_merge_summary %} -### 合并压缩合并的消息 +### Merge message for a squash merge -在压缩与合并时，{% data variables.product.prodname_dotcom %} 生成提交消息，您可以根据需要更改该消息。 消息默认值取决于拉取请求是包含多个提交还是只包含一个。 在计算提交总数时，我们不包括合并提交。 +When you squash and merge, {% data variables.product.prodname_dotcom %} generates a commit message which you can change if you want to. The message default depends on whether the pull request contains multiple commits or just one. We do not include merge commits when we count the total number of commits. -| 提交数 | 摘要 | 描述 | -| ---- | -------------------- | ------------------- | -| 一个提交 | 单个提交的提交消息标题，后接拉取请求编号 | 单个提交的提交消息正文 | -| 多个提交 | 拉取请求标题，后接拉取请求编号 | 按日期顺序列出所有被压缩提交的提交消息 | +Number of commits | Summary | Description | +----------------- | ------- | ----------- | +One commit | The title of the commit message for the single commit, followed by the pull request number | The body text of the commit message for the single commit +More than one commit | The pull request title, followed by the pull request number | A list of the commit messages for all of the squashed commits, in date order -### 压缩与合并长运行分支 +### Squashing and merging a long-running branch -如果计划在合并拉取请求后继续操作[头部分支](/github/getting-started-with-github/github-glossary#head-branch)，建议不要压缩与合并拉取请求。 +If you plan to continue work on the [head branch](/github/getting-started-with-github/github-glossary#head-branch) of a pull request after the pull request is merged, we recommend you don't squash and merge the pull request. -在创建拉取请求时，{% data variables.product.prodname_dotcom %} 会标识头部分支和[基础分支](/github/getting-started-with-github/github-glossary#base-branch)上的最新提交：共同的提交原型。 在压缩与合并拉取请求时，{% data variables.product.prodname_dotcom %} 会在基础分支上创建提交，其中包含自提交原型以来对头部分支所做的所有更改。 +When you create a pull request, {% data variables.product.prodname_dotcom %} identifies the most recent commit that is on both the head branch and the [base branch](/github/getting-started-with-github/github-glossary#base-branch): the common ancestor commit. When you squash and merge the pull request, {% data variables.product.prodname_dotcom %} creates a commit on the base branch that contains all of the changes you made on the head branch since the common ancestor commit. -由于此提交仅位于基础分支而不是头部分支上，因此两个分支的共同原型保持不变。 如果您继续使用头部分支，则在两个分支之间创建新的拉取请求，该拉取请求将包含自共同原型以来的所有提交，其中包括你在之前的拉取请求中压缩与合并的提交。 如果没有冲突，您可以安全地合并这些提交。 但是，此工作流会增大合并冲突的可能性。 如果您继续压缩与合并长运行头部分支的拉取请求，则必须反复解决相同的冲突。 +Because this commit is only on the base branch and not the head branch, the common ancestor of the two branches remains unchanged. If you continue to work on the head branch, then create a new pull request between the two branches, the pull request will include all of the commits since the common ancestor, including commits that you squashed and merged in the previous pull request. If there are no conflicts, you can safely merge these commits. However, this workflow makes merge conflicts more likely. If you continue to squash and merge pull requests for a long-running head branch, you will have to resolve the same conflicts repeatedly. -## 变基与合并拉取请求提交 +## Rebase and merge your pull request commits {% data reusables.pull_requests.rebase_and_merge_summary %} -在以下情况下，您无法在 {% data variables.product.product_location %} 上自动变基与合并： -- 拉取请求有合并冲突。 -- 将提交从基本分支变基为遇到冲突的头部分支。 -- 变基提交被视为“不安全”，例如变基可行、不会发生冲突但会产生与合并不同的结果时。 +You aren't able to automatically rebase and merge on {% data variables.product.product_location %} when: +- The pull request has merge conflicts. +- Rebasing the commits from the base branch into the head branch runs into conflicts. +- Rebasing the commits is considered "unsafe," such as when a rebase is possible without merge conflicts but would produce a different result than a merge would. -如果您仍然要变基提交，但不能在 {% data variables.product.product_location %} 上自动变基与合并，则您必须： -- 在命令行上以本地方式将主题分支（或头部分支）变基为基本分支 -- [解决命令行上的任何冲突](/articles/resolving-a-merge-conflict-using-the-command-line/)。 -- 强制推送变基的命令到拉取请求的主题分支（或远端头部分支）。 +If you still want to rebase the commits but can't rebase and merge automatically on {% data variables.product.product_location %} you must: +- Rebase the topic branch (or head branch) onto the base branch locally on the command line +- [Resolve any merge conflicts on the command line](/articles/resolving-a-merge-conflict-using-the-command-line/). +- Force-push the rebased commits to the pull request's topic branch (or remote head branch). -在仓库中具有写入权限的任何人然后可以使用 {% data variables.product.product_location %} 上的变基与合并按钮[合并更改](/articles/merging-a-pull-request/)。 +Anyone with write permissions in the repository, can then [merge the changes](/articles/merging-a-pull-request/) using the rebase and merge button on {% data variables.product.product_location %}. -## 延伸阅读 +## Further reading -- "[关于拉取请求](/articles/about-pull-requests/)" -- "[解决合并冲突](/github/collaborating-with-pull-requests/addressing-merge-conflicts)" +- "[About pull requests](/articles/about-pull-requests/)" +- "[Addressing merge conflicts](/github/collaborating-with-pull-requests/addressing-merge-conflicts)" diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/index.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/index.md index bd17036754..cf9dabb2ea 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/index.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/index.md @@ -1,8 +1,8 @@ --- -title: 合并拉取请求中的更改 -intro: '您可以通过拉取请求提议更改您在 {% data variables.product.product_name %} 上的工作。 了解如何创建、管理及合并拉取请求。' +title: Incorporating changes from a pull request +intro: 'You can propose changes to your work on {% data variables.product.product_name %} through pull requests. Learn how to create, manage, and merge pull requests.' redirect_from: - - /github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request/ + - /github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request - /articles/incorporating-changes-from-a-pull-request - /github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request versions: @@ -19,6 +19,5 @@ children: - /adding-a-pull-request-to-the-merge-queue - /closing-a-pull-request - /reverting-a-pull-request -shortTitle: 合并更改 +shortTitle: Incorporate changes --- - diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md index b14dec6166..60c225594f 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md @@ -3,7 +3,7 @@ title: About branches intro: 'Use a branch to isolate development work without affecting other branches in the repository. Each repository has one default branch, and can have multiple other branches. You can merge a branch into another branch using a pull request.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches - - /articles/working-with-protected-branches/ + - /articles/working-with-protected-branches - /articles/about-branches - /github/collaborating-with-issues-and-pull-requests/about-branches - /github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md index 04002cc4a8..a488f3afd5 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md @@ -3,7 +3,7 @@ title: About pull requests intro: 'Pull requests let you tell others about changes you''ve pushed to a branch in a repository on {% data variables.product.product_name %}. Once a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before your changes are merged into the base branch.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests - - /articles/using-pull-requests/ + - /articles/using-pull-requests - /articles/about-pull-requests - /github/collaborating-with-issues-and-pull-requests/about-pull-requests - /github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md index fafc35718d..aeff18cc0b 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md @@ -1,9 +1,9 @@ --- -title: 创建和删除仓库中的分支 -intro: '您可以直接在 {% data variables.product.product_name %} 上创建或删除分支。' +title: Creating and deleting branches within your repository +intro: 'You can create or delete branches directly on {% data variables.product.product_name %}.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository - - /articles/deleting-branches-in-a-pull-request/ + - /articles/deleting-branches-in-a-pull-request - /articles/creating-and-deleting-branches-within-your-repository - /github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository versions: @@ -13,38 +13,41 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: 创建和删除分支 +shortTitle: Create & delete branches --- - -## 创建分支 +## Creating a branch {% data reusables.repositories.navigate-to-repo %} -1. （可选）如果要从仓库的默认分支以外的分支创建新分支，请单击 {% octicon "git-branch" aria-label="The branch icon" %} **NUMBER 分支**，然后选择另一个分支： ![概述页面上的分支链接](/assets/images/help/branches/branches-link.png) -1. 单击分支选择器菜单。 ![分支选择器菜单](/assets/images/help/branch/branch-selection-dropdown.png) -1. 为新分支键入唯一名称，然后选择 **Create branch（创建分支）**。 ![分支创建文本框](/assets/images/help/branch/branch-creation-text-box.png) +1. Optionally, if you want to create your new branch from a branch other than the default branch for the repository, click {% octicon "git-branch" aria-label="The branch icon" %} **NUMBER branches** then choose another branch: + ![Branches link on overview page](/assets/images/help/branches/branches-link.png) +1. Click the branch selector menu. + ![branch selector menu](/assets/images/help/branch/branch-selection-dropdown.png) +1. Type a unique name for your new branch, then select **Create branch**. + ![branch creation text box](/assets/images/help/branch/branch-creation-text-box.png) -## 删除分支 +## Deleting a branch {% data reusables.pull_requests.automatically-delete-branches %} {% note %} -**注意：**如果要删除的分支是仓库的默认分支，则在删除该分支之前必须选择新的默认分支。 更多信息请参阅“[更改默认分支](/github/administering-a-repository/changing-the-default-branch)”。 +**Note:** If the branch you want to delete is the repository's default branch, you must choose a new default branch before deleting the branch. For more information, see "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)." {% endnote %} -如果要删除的分支与打开的拉取请求关联，则在删除该分支之前必须合并或关闭拉取请求。 更多信息请参阅“[合并拉取请求](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)”和“[关闭拉取请求](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request)”。 +If the branch you want to delete is associated with an open pull request, you must merge or close the pull request before deleting the branch. For more information, see "[Merging a pull request](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)" or "[Closing a pull request](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request)." {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-branches %} -1. 滚动到要删除的分支，然后单击 {% octicon "trash" aria-label="The trash icon to delete the branch" %}。 ![删除分支](/assets/images/help/branches/branches-delete.png) +1. Scroll to the branch that you want to delete, then click {% octicon "trash" aria-label="The trash icon to delete the branch" %}. + ![delete the branch](/assets/images/help/branches/branches-delete.png) {% data reusables.pull_requests.retargeted-on-branch-deletion %} -更多信息请参阅“[关于分支](/github/collaborating-with-issues-and-pull-requests/about-branches#working-with-branches)”。 +For more information, see "[About branches](/github/collaborating-with-issues-and-pull-requests/about-branches#working-with-branches)." -## 延伸阅读 +## Further reading - "[About branches](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)" -- “[查看仓库中的分支](/github/administering-a-repository/viewing-branches-in-your-repository)” -- "[删除和恢复拉取请求中的分支](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request)" +- "[Viewing branches in your repository](/github/administering-a-repository/viewing-branches-in-your-repository)" +- "[Deleting and restoring branches in a pull request](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request)" diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/index.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/index.md index 449d63716b..6a5e87fe5c 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/index.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/index.md @@ -1,8 +1,8 @@ --- -title: 发起提案，请求改进项目 -intro: 在添加更改到主题分支或复刻后，您可以打开拉取请求，要求协作者或仓库管理员审查您的更改，然后将其合并到项目中。 +title: Proposing changes to your work with pull requests +intro: 'After you add changes to a topic branch or fork, you can open a pull request to ask your collaborators or the repository administrator to review your changes before merging them into the project.' redirect_from: - - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/ + - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests - /articles/proposing-changes-to-your-work-with-pull-requests - /github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests versions: @@ -24,6 +24,5 @@ children: - /requesting-a-pull-request-review - /changing-the-base-branch-of-a-pull-request - /committing-changes-to-a-pull-request-branch-created-from-a-fork -shortTitle: 提议更改 +shortTitle: Propose changes --- - diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md index 43270c3389..81e0efb039 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md @@ -1,14 +1,14 @@ --- -title: 评论拉取请求 +title: Commenting on a pull request redirect_from: - /github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request - - /articles/adding-commit-comments/ - - /articles/commenting-on-the-diff-of-a-pull-request/ - - /articles/commenting-on-differences-between-files/ + - /articles/adding-commit-comments + - /articles/commenting-on-the-diff-of-a-pull-request + - /articles/commenting-on-differences-between-files - /articles/commenting-on-a-pull-request - /github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request - /github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request -intro: 在仓库中打开拉取请求后，协作者或团队成员可以评论两个指定分支之间的文件比较，或者对整个项目做出总体评论。 +intro: 'After you open a pull request in a repository, collaborators or team members can comment on the comparison of files between the two specified branches, or leave general comments on the project as a whole.' versions: fpt: '*' ghes: '*' @@ -16,51 +16,51 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: 对 PR 的评论 +shortTitle: Comment on a PR --- +## About pull request comments -## 关于拉取请求评论 +You can comment on a pull request's **Conversation** tab to leave general comments, questions, or props. You can also suggest changes that the author of the pull request can apply directly from your comment. -您可以在拉取请求的 **Conversation（对话）**选项卡上发表评论，以留下总评、疑问或提议。 您还可以提出拉取请求的作者可直接从您的注释中应用的更改。 +![Pull Request conversation](/assets/images/help/pull_requests/conversation.png) -![拉取请求对话](/assets/images/help/pull_requests/conversation.png) +You can also comment on specific sections of a file on a pull request's **Files changed** tab in the form of individual line comments or as part of a [pull request review](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews). Adding line comments is a great way to discuss questions about implementation or provide feedback to the author. -也可以采用单独行注释的形式或者作为[拉取请求审查](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)的一部分，在拉取请求的 **Files changed（已更改文件）**选项卡上对文件的特定部分做出评论。 添加行注释是讨论有关实现的问题或向作者提供反馈的好方法。 - -有关向拉取请求审查添加行注释的更多信息，请参阅“[审查拉取请求中提议的更改](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)”。 +For more information on adding line comments to a pull request review, see ["Reviewing proposed changes in a pull request."](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request) {% note %} -**注：**如果您通过电子邮件回复拉取请求，则您的评论将被添加到 **Conversation（对话）**选项卡上，不会成为拉取请求审查的一部分。 +**Note:** If you reply to a pull request via email, your comment will be added on the **Conversation** tab and will not be part of a pull request review. {% endnote %} -要回复现有行注释，您需要导航到 **Conversation（对话）**选项卡或 **Files changed（已更改文件）**选项卡上的评论，然后在其下方添加另一条行注释。 +To reply to an existing line comment, you'll need to navigate to the comment on either the **Conversation** tab or **Files changed** tab and add an additional line comment below it. {% tip %} -**提示：** -- 拉取请求评论支持与 {% data variables.product.product_name %} 上的一般评论相同的[格式](/categories/writing-on-github)，例如 @提及、表情符号和引用。 -- 您可以在 **Files changed（文件已更改）**选项卡中添加对拉取请求评论的反应。 +**Tips:** +- Pull request comments support the same [formatting](/categories/writing-on-github) as regular comments on {% data variables.product.product_name %}, such as @mentions, emoji, and references. +- You can add reactions to comments in pull requests in the **Files changed** tab. {% endtip %} -## 向拉取请求添加行注释 +## Adding line comments to a pull request {% data reusables.repositories.sidebar-pr %} -2. 1. 在拉取请求列表中，单击要留下行注释的拉取请求。 +2. In the list of pull requests, click the pull request where you'd like to leave line comments. {% data reusables.repositories.changed-files %} {% data reusables.repositories.start-line-comment %} {% data reusables.repositories.type-line-comment %} {% data reusables.repositories.suggest-changes %} -5. 完成后，单击 **Add single comment（添加单个评论）**。 ![内联评论窗口](/assets/images/help/commits/inline-comment.png) +5. When you're done, click **Add single comment**. + ![Inline comment window](/assets/images/help/commits/inline-comment.png) -任何关注拉取请求或仓库的人都会收到有关您评论的通知。 +Anyone watching the pull request or repository will receive a notification of your comment. {% data reusables.pull_requests.resolving-conversations %} -## 延伸阅读 +## Further reading -- "[在 GitHub 上编写](/github/writing-on-github)" -{% ifversion fpt or ghec %}-“[举报滥用或垃圾邮件](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)” +- "[Writing on GitHub](/github/writing-on-github)" +{% ifversion fpt or ghec %}- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" {% endif %} diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md index 8293898e6e..bd7a9b087f 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md @@ -1,9 +1,9 @@ --- -title: 过滤拉取请求中的文件 -intro: 要快速查看大型拉取请求中的更改，您可以过滤已更改的文件。 +title: Filtering files in a pull request +intro: 'To help you quickly review changes in a large pull request, you can filter changed files.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request - - /articles/filtering-files-in-a-pull-request-by-file-type/ + - /articles/filtering-files-in-a-pull-request-by-file-type - /articles/filtering-files-in-a-pull-request - /github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request - /github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request @@ -14,24 +14,25 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: 筛选文件 +shortTitle: Filter files --- - -您可以按文件扩展名类型（例如 `.html` 或 `.js`）、无扩展名、代码所有权或点文件过滤拉取请求中的文件。 +You can filter files in a pull request by file extension type, such as `.html` or `.js`, lack of an extension, code ownership, or dotfiles. {% tip %} -**提示：**为简化拉取请求差异视图，也可以从过滤器下拉菜单在拉取请求差异中临时隐藏删除的文件或您已经查看过的文件。 +**Tip:** To simplify your pull request diff view, you can also temporarily hide deleted files or files you have already viewed in the pull request diff from the file filter drop-down menu. {% endtip %} {% data reusables.repositories.sidebar-pr %} -2. 在拉取请求列表中，单击要过滤的拉取请求。 +2. In the list of pull requests, click the pull request you'd like to filter. {% data reusables.repositories.changed-files %} -4. 使用文件过滤器下拉菜单选择、取消选择或单击所需的过滤器。 ![拉取请求差异上方的文件过滤器选项](/assets/images/help/pull_requests/file-filter-option.png) -5. （可选）要清除过滤器选择，请在 **Files changed（已更改文件）**选项卡下，单击 **Clear（清除）**。 ![清除文件过滤器选择](/assets/images/help/pull_requests/clear-file-filter.png) +4. Use the File filter drop-down menu, and select, unselect, or click the desired filters. + ![File filter option above pull request diff](/assets/images/help/pull_requests/file-filter-option.png) +5. Optionally, to clear the filter selection, under the **Files changed** tab, click **Clear**. + ![Clear file filter selection](/assets/images/help/pull_requests/clear-file-filter.png) -## 延伸阅读 +## Further reading -- “[关于比较拉取请求中的分支](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)” -- “[在拉取请求中查找已更改的方法和函数](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request)” +- "[About comparing branches in a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)" +- "[Finding changed methods and functions in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request)" diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/index.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/index.md index c4747cc3f2..94e8467a8d 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/index.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/index.md @@ -1,11 +1,11 @@ --- -title: 审查拉取请求中的更改 +title: Reviewing changes in pull requests redirect_from: - - /github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests/ - - /articles/reviewing-and-discussing-changes-in-pull-requests/ + - /github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests + - /articles/reviewing-and-discussing-changes-in-pull-requests - /articles/reviewing-changes-in-pull-requests - /github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests -intro: 打开拉取请求后，您可以审查和讨论一组提议的更改。 +intro: 'After a pull request has been opened, you can review and discuss the set of proposed changes.' versions: fpt: '*' ghes: '*' @@ -25,6 +25,5 @@ children: - /approving-a-pull-request-with-required-reviews - /dismissing-a-pull-request-review - /checking-out-pull-requests-locally -shortTitle: 审查更改 +shortTitle: Review changes --- - diff --git a/translations/zh-CN/content/rest/guides/best-practices-for-integrators.md b/translations/zh-CN/content/rest/guides/best-practices-for-integrators.md index 6c910a2a48..7ad5e448ca 100644 --- a/translations/zh-CN/content/rest/guides/best-practices-for-integrators.md +++ b/translations/zh-CN/content/rest/guides/best-practices-for-integrators.md @@ -1,8 +1,8 @@ --- -title: 集成者最佳实践 -intro: '构建一个能够可靠地与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 进行交互并为您的用户提供最佳体验。' +title: Best practices for integrators +intro: 'Build an app that reliably interacts with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API and provides the best experience for your users.' redirect_from: - - /guides/best-practices-for-integrators/ + - /guides/best-practices-for-integrators - /v3/guides/best-practices-for-integrators versions: fpt: '*' @@ -11,63 +11,63 @@ versions: ghec: '*' topics: - API -shortTitle: 综合最佳实践 +shortTitle: Integrator best practices --- -有兴趣与 GitHub 平台集成吗？ [与您志趣相投的大有人在](https://github.com/integrations)。 本指南将帮助您构建能够为用户提供最佳体验*并*确保与 API 进行可靠交互的应用程序。 +Interested in integrating with the GitHub platform? [You're in good company](https://github.com/integrations). This guide will help you build an app that provides the best experience for your users *and* ensure that it's reliably interacting with the API. -## 确保安全接收从 GitHub 交付的有效负载 +## Secure payloads delivered from GitHub -确保安全接收[从 GitHub 发送的有效负载][event-types]非常重要。 虽然有效负载中不会传输个人信息，但泄露*任何*信息总是不好的。 有些信息可能比较敏感，包括提交者电子邮件地址或私有仓库的名称。 +It's very important that you secure [the payloads sent from GitHub][event-types]. Although no personal information (like passwords) is ever transmitted in a payload, leaking *any* information is not good. Some information that might be sensitive include committer email address or the names of private repositories. -您可以采取以下几个步骤来确保安全接收由 GitHub 交付的工作负载： +There are several steps you can take to secure receipt of payloads delivered by GitHub: -1. 确保您的接收服务器在 HTTPS 连接上。 默认情况下，GitHub 在交付有效负载时会验证 SSL 证书。{% ifversion fpt or ghec %} -1. 您可以将[我们在交付挂钩时使用的 IP 地址](/github/authenticating-to-github/about-githubs-ip-addresses)添加到服务器的允许列表中。 为确保始终检查 IP 地址是否正确，您可以[使用 `/meta` 端点](/rest/reference/meta#meta)查找我们使用的地址。{% endif %} -1. 提供[密钥令牌](/webhooks/securing/)以确保有效负载肯定来自 GitHub。 通过实施密钥令牌，您可以确保服务器接收的任何数据绝对来自 GitHub。 理想情况下，您应该为您服务的*每个用户*都提供一个不同的密钥令牌。 这样，即使某个令牌被泄露，也不至于影响其他用户。 +1. Ensure that your receiving server is on an HTTPS connection. By default, GitHub will verify SSL certificates when delivering payloads.{% ifversion fpt or ghec %} +1. You can add [the IP address we use when delivering hooks](/github/authenticating-to-github/about-githubs-ip-addresses) to your server's allow list. To ensure that you're always checking the right IP address, you can [use the `/meta` endpoint](/rest/reference/meta#meta) to find the address we use.{% endif %} +1. Provide [a secret token](/webhooks/securing/) to ensure payloads are definitely coming from GitHub. By enforcing a secret token, you're ensuring that any data received by your server is absolutely coming from GitHub. Ideally, you should provide a different secret token *per user* of your service. That way, if one token is compromised, no other user would be affected. -## 支持异步工作而非同步工作 +## Favor asynchronous work over synchronous -GitHub 要求在收到 web 挂钩有效负载后 {% ifversion fpt or ghec %}10{% else %}30{% endif %} 秒内做出集成响应。 如果您的服务需要更长的时间才能完成，则 GitHub 将终止连接，并且有效负载将丢失。 +GitHub expects that integrations respond within {% ifversion fpt or ghec %}10{% else %}30{% endif %} seconds of receiving the webhook payload. If your service takes longer than that to complete, then GitHub terminates the connection and the payload is lost. -由于无法预测您的服务完成速度，因此您应该在后台作业中执行所有“实际工作”。 [Resque](https://github.com/resque/resque/)（用于 Ruby）、[RQ](http://python-rq.org/)（用于 Python）或 [RabbitMQ](http://www.rabbitmq.com/)（用于 Java）是可以排队和处理后台作业的典型库。 +Since it's impossible to predict how fast your service will complete, you should do all of "the real work" in a background job. [Resque](https://github.com/resque/resque/) (for Ruby), [RQ](http://python-rq.org/) (for Python), or [RabbitMQ](http://www.rabbitmq.com/) (for Java) are examples of libraries that can handle queuing and processing of background jobs. -请注意，即使在后台作业中执行工作，GitHub 仍要求您的服务器能够在{% ifversion fpt or ghec %}十{% else %}三十{% endif %}秒内做出响应。 您的服务器需要通过发送某种响应来确认它收到了有效负载。 您的服务必须尽快对有效负载执行任何验证，以便您能够准确地报告您的服务器是否会继续处理请求。 +Note that even with a background job running, GitHub still expects your server to respond within {% ifversion fpt or ghec %}ten{% else %}thirty{% endif %} seconds. Your server needs to acknowledge that it received the payload by sending some sort of response. It's critical that your service performs any validations on a payload as soon as possible, so that you can accurately report whether your server will continue with the request or not. -## 响应 GitHub 时使用适当的 HTTP 状态代码 +## Use appropriate HTTP status codes when responding to GitHub -每个 web 挂钩都有自己的“最近交付”部分，其中列出了部署是否成功。 +Every webhook has its own "Recent Deliveries" section, which lists whether a deployment was successful or not. -![最近交付视图](/assets/images/webhooks_recent_deliveries.png) +![Recent Deliveries view](/assets/images/webhooks_recent_deliveries.png) -您应该使用适当的 HTTP 状态代码来通知用户。 您可以使用 `201` 或 `202` 等代码来确认收到了不会处理的有效负载（例如，非默认分支交付的有效负载）。 将 `500` 错误代码预留给灾难性故障。 +You should make use of proper HTTP status codes in order to inform users. You can use codes like `201` or `202` to acknowledge receipt of payload that won't be processed (for example, a payload delivered by a branch that's not the default). Reserve the `500` error code for catastrophic failures. -## 向用户提供尽可能多的信息 +## Provide as much information as possible to the user -用户可能会深入研究您发回 GitHub 的服务器响应。 请确保您的信息清晰明了。 +Users can dig into the server responses you send back to GitHub. Ensure that your messages are clear and informative. -![查看有效负载响应](/assets/images/payload_response_tab.png) +![Viewing a payload response](/assets/images/payload_response_tab.png) -## 遵循 API 发送给您的任何重定向 +## Follow any redirects that the API sends you -GitHub 在资源发生移动时会通过提供重定向状态代码来明确告诉您。 您应该遵循这些重定向。 每个重定向响应都使用要转到的新 URI 来设置 `Location` 标头。 如果您收到了重定向，最好更新代码以遵循新的 URI，以防您请求我们可能已删除的无效路径。 +GitHub is explicit in telling you when a resource has moved by providing a redirect status code. You should follow these redirections. Every redirect response sets the `Location` header with the new URI to go to. If you receive a redirect, it's best to update your code to follow the new URI, in case you're requesting a deprecated path that we might remove. -我们提供了 [HTTP 状态代码列表](/rest#http-redirects)，供您在设计应用程序时参考以便遵循重定向。 +We've provided [a list of HTTP status codes](/rest#http-redirects) to watch out for when designing your app to follow redirects. -## 不要手动解析 URL +## Don't manually parse URLs -通常，API 响应包含 URL 形式的数据。 例如，当请求仓库时，我们会发送一个名为 `clone_url` 的键，其中包含可用来克隆仓库的 URL。 +Often, API responses contain data in the form of URLs. For example, when requesting a repository, we'll send a key called `clone_url` with a URL you can use to clone the repository. -为了应用程序的稳定性，您不应该尝试解析此数据，或者尝试猜测并构造未来 URL 的格式。 否则，如果我们决定更改该 URL，您的应用程序可能会中断。 +For the stability of your app, you shouldn't try to parse this data or try to guess and construct the format of future URLs. Your app is liable to break if we decide to change the URL. -例如，在处理分页结果时， 往往很想构造 URL - 在末尾追加 `?page=`。 要抑制这种冲动。 [我们的分页指南](/guides/traversing-with-pagination)提供了一些关于可靠跟踪分页结果的安全提示。 +For example, when working with paginated results, it's often tempting to construct URLs that append `?page=` to the end. Avoid that temptation. [Our guide on pagination](/guides/traversing-with-pagination) offers some safe tips on dependably following paginated results. -## 在处理事件之前检查事件类型和操作 +## Check the event type and action before processing the event -有多种 [web 挂钩事件类型][event-types]，并且每个事件可以有多个操作。 随着 GitHub 功能集的增长，我们会不时添加新的事件类型或向现有事件类型添加新的操作。 请确保您的应用程序在进行任何 web 挂钩处理之前明确检查事件的类型和操作。 `X-GitHub-Event` 请求标头可用于了解收到了哪个事件，以便进行适当处理。 同样，有效负载具有顶层 `action` 键，可用于了解对相关对象采取了哪些操作。 +There are multiple [webhook event types][event-types], and each event can have multiple actions. As GitHub's feature set grows, we will occasionally add new event types or add new actions to existing event types. Ensure that your application explicitly checks the type and action of an event before doing any webhook processing. The `X-GitHub-Event` request header can be used to know which event has been received so that processing can be handled appropriately. Similarly, the payload has a top-level `action` key that can be used to know which action was taken on the relevant object. -例如，如果您已将 GitHub web 挂钩配置为“向我发送**所有内容**”，则在添加新的事件类型和操作时，您的应用程序就会开始接收它们。 因此，**不建议使用任何类型的 catch-all else 子句**。 以下面的代码为例： +For example, if you have configured a GitHub webhook to "Send me **everything**", your application will begin receiving new event types and actions as they are added. It is therefore **not recommended to use any sort of catch-all else clause**. Take the following code example: ```ruby # Not recommended: a catch-all else clause @@ -86,9 +86,9 @@ def receive end ``` -在此代码实例中，如果收到 `repository` 或 `issues` 事件，将会正确调用 `process_repository` 和 `process_issues` 方法。 但是，任何其他事件类型都会导致调用 `process_pull_requests`。 当添加新的事件类型时，这将导致不正确的行为 - 将以处理 `pull_request` 事件的方式来处理新的事件类型。 +In this code example, the `process_repository` and `process_issues` methods will be correctly called if a `repository` or `issues` event was received. However, any other event type would result in `process_pull_requests` being called. As new event types are added, this would result in incorrect behavior and new event types would be processed in the same way that a `pull_request` event would be processed. -因此，我们建议明确检查事件类型并采取相应行动。 在以下代码示例中，我们明确检查 `pull_request` 事件，而 `else` 子句仅记录我们已收到新事件类型： +Instead, we suggest explicitly checking event types and acting accordingly. In the following code example, we explicitly check for a `pull_request` event and the `else` clause simply logs that we've received a new event type: ```ruby # Recommended: explicitly check each event type @@ -109,9 +109,9 @@ def receive end ``` -由于每个事件也可以有多个操作，因此建议对操作进行类似的检查。 例如，[`IssuesEvent`](/webhooks/event-payloads/#issues) 可能有几个操作。 其中包括创建议题时的 `opened`、关闭议题时的 `closed`以及将议题分配给某人时的 `assigned`。 +Because each event can also have multiple actions, it's recommended that actions are checked similarly. For example, the [`IssuesEvent`](/webhooks/event-payloads/#issues) has several possible actions. These include `opened` when the issue is created, `closed` when the issue is closed, and `assigned` when the issue is assigned to someone. -与添加事件类型一样，我们可以向现有事件添加新操作。 因此，再次强调，在检查事件的操作时**不要使用任何类型的 catch-all else 子句**。 相反，我们建议像检查事件类型一样明确检查事件操作。 下面的示例非常吻合我们在上文中针对事件类型的建议： +As with adding event types, we may add new actions to existing events. It is therefore again **not recommended to use any sort of catch-all else clause** when checking an event's action. Instead, we suggest explicitly checking event actions as we did with the event type. An example of this looks very similar to what we suggested for event types above: ```ruby # Recommended: explicitly check each action @@ -129,40 +129,47 @@ def process_issue(payload) end ``` -在此示例中，在调用 `process_closed` 方法之前会先检查 `closed` 操作。 任何未识别的操作都会被记录以供将来参考。 +In this example the `closed` action is checked first before calling the `process_closed` method. Any unidentified actions are logged for future reference. {% ifversion fpt or ghec %} -## 处理速率限制 +## Dealing with rate limits -GitHub API [速率限制](/rest/overview/resources-in-the-rest-api#rate-limiting)旨在确保 API 快速供每个人使用。 +The GitHub API [rate limit](/rest/overview/resources-in-the-rest-api#rate-limiting) ensures that the API is fast and available for everyone. -如果您达到了速率限制，则应该停止发出请求，然后在允许的时候再试。 否则，可能会导致您的应用程序被禁用。 +If you hit a rate limit, it's expected that you back off from making requests and try again later when you're permitted to do so. Failure to do so may result in the banning of your app. -您可以随时[检查您的速率限制状态](/rest/reference/rate-limit)。 检查您的速率限制状态对您的速率限制不会产生任何影响。 +You can always [check your rate limit status](/rest/reference/rate-limit) at any time. Checking your rate limit incurs no cost against your rate limit. -## 处理二级费率限制 +## Dealing with secondary rate limits -[二级费率限制](/rest/overview/resources-in-the-rest-api#secondary-rate-limits)是我们确保 API 可用性的另一种方式。 为了避免达到此限制，应确保您的应用程序遵循以下准则。 +[Secondary rate limits](/rest/overview/resources-in-the-rest-api#secondary-rate-limits) are another way we ensure the API's availability. +To avoid hitting this limit, you should ensure your application follows the guidelines below. -* 发出经过身份验证的请求，或使用应用程序的客户端 ID 和密钥。 未经身份验证的请求会受到更严格的二级费率限制。 -* 依次为单个用户或客户端 ID 发出请求。 不要同时为单个用户或客户端 ID 发出多个请求。 -* 如果您要为单个用户或客户端 ID 发出大量的 `POST`、`PATCH`、`PUT` 或 `DELETE` 请求，则每两个请求之间至少应间隔一秒钟。 -* 当您受到限制时，请使用 `Retry-After` 响应标头来降低速率。 `Retry-After` 标头的值始终为整数，表示您在再次发出请求之前应等待的秒数。 例如，`Retry-After: 30` 表示您在发出更多请求之前应等待 30 秒。 -* 会触发通知的内容创建请求，例如议题、评论和拉取请求，可能会受到进一步限制，并且在响应中不包含 `Retry-After` 标头。 请以合理的速率创建此类内容，以避免受到进一步限制。 +* Make authenticated requests, or use your application's client ID and secret. Unauthenticated + requests are subject to more aggressive secondary rate limiting. +* Make requests for a single user or client ID serially. Do not make requests for a single user + or client ID concurrently. +* If you're making a large number of `POST`, `PATCH`, `PUT`, or `DELETE` requests for a single user + or client ID, wait at least one second between each request. +* When you have been limited, use the `Retry-After` response header to slow down. The value of the + `Retry-After` header will always be an integer, representing the number of seconds you should wait + before making requests again. For example, `Retry-After: 30` means you should wait 30 seconds + before sending more requests. +* Requests that create content which triggers notifications, such as issues, comments and pull requests, + may be further limited and will not include a `Retry-After` header in the response. Please create this + content at a reasonable pace to avoid further limiting. -我们保留根据需要更改这些准则以确保可用性的权利。 +We reserve the right to change these guidelines as needed to ensure availability. {% endif %} -## 处理 API 错误 +## Dealing with API errors -尽管您的代码从未引入漏洞，但您可能会发现在尝试访问 API 时遇到连续错误。 +Although your code would never introduce a bug, you may find that you've encountered successive errors when trying to access the API. -您应该确保与 API 正确交互，而不是忽略重复的 `4xx` 和 `5xx` 状态代码。 例如，如果某个端点请求一个字符串，而您向其传递一个数值，则您将会收到 `5xx` 验证错误，并且您的调用不会成功。 同样，试图访问未经授权或不存在的端点会导致 `4xx` 错误。 +Rather than ignore repeated `4xx` and `5xx` status codes, you should ensure that you're correctly interacting with the API. For example, if an endpoint requests a string and you're passing it a numeric value, you're going to receive a `5xx` validation error, and your call won't succeed. Similarly, attempting to access an unauthorized or nonexistent endpoint will result in a `4xx` error. -故意忽略重复的验证错误可能会导致您的应用程序因滥用而被暂停。 - -[event-types]: /webhooks/event-payloads +Intentionally ignoring repeated validation errors may result in the suspension of your app for abuse. [event-types]: /webhooks/event-payloads diff --git a/translations/zh-CN/content/rest/guides/building-a-ci-server.md b/translations/zh-CN/content/rest/guides/building-a-ci-server.md index 45af996f10..dbcec20196 100644 --- a/translations/zh-CN/content/rest/guides/building-a-ci-server.md +++ b/translations/zh-CN/content/rest/guides/building-a-ci-server.md @@ -1,8 +1,8 @@ --- -title: 构建 CI 服务器 -intro: 使用状态 API 构建您自己的 CI 系统。 +title: Building a CI server +intro: Build your own CI system using the Status API. redirect_from: - - /guides/building-a-ci-server/ + - /guides/building-a-ci-server - /v3/guides/building-a-ci-server versions: fpt: '*' @@ -15,22 +15,31 @@ topics: -[状态 API][status API] 负责将提交与测试服务绑定在一起，使您进行的每次推送都可以得到测试并表现在 {% data variables.product.product_name %} 拉取请求中。 +The [Status API][status API] is responsible for tying together commits with +a testing service, so that every push you make can be tested and represented +in a {% data variables.product.product_name %} pull request. -本指南将使用该 API 来演示您可以使用的设置。 在我们的场景中，我们将： +This guide will use that API to demonstrate a setup that you can use. +In our scenario, we will: -* 在拉取请求被打开时运行我们的 CI 套件（我们将 CI 状态设置为待处理）。 -* 在 CI 完成后，我们将相应地设置拉取请求的状态。 +* Run our CI suite when a Pull Request is opened (we'll set the CI status to pending). +* When the CI is finished, we'll set the Pull Request's status accordingly. -我们的 CI 系统和主机服务器将是我们想象中的虚拟物。 它们可能是 Travis、Jenkins 或其他完全不同的工具。 本指南的重点是设置和配置负责管理通信的服务器。 +Our CI system and host server will be figments of our imagination. They could be +Travis, Jenkins, or something else entirely. The crux of this guide will be setting up +and configuring the server managing the communication. -请务必[下载 ngrok][ngrok]（如果尚未下载），并了解如何[使用它][using ngrok]。 我们发现它在暴露本地连接方面是一款非常有用的工具。 +If you haven't already, be sure to [download ngrok][ngrok], and learn how +to [use it][using ngrok]. We find it to be a very useful tool for exposing local +connections. -注：您可以[从平台样本仓库][platform samples]下载此项目的完整源代码。 +Note: you can download the complete source code for this project +[from the platform-samples repo][platform samples]. -## 编写服务器 +## Writing your server -我们将编写一个快速的 Sinatra 应用程序，以证明我们的本地连接工作正常。 首先编写以下代码： +We'll write a quick Sinatra app to prove that our local connections are working. +Let's start with this: ``` ruby require 'sinatra' @@ -42,20 +51,29 @@ post '/event_handler' do end ``` -（如果您不熟悉 Sinatra 的工作方式，建议您阅读 [ Sinatra 指南][Sinatra]）。 +(If you're unfamiliar with how Sinatra works, we recommend [reading the Sinatra guide][Sinatra].) -启动此服务器。 默认情况下，Sinatra 在端口 `4567` 上启动，因此您还需要配置 ngrok 开始监听。 +Start this server up. By default, Sinatra starts on port `4567`, so you'll want +to configure ngrok to start listening for that, too. -为了使此服务器正常工作，我们需要使用 web 挂钩来设置一个仓库。 Web 挂钩应配置为在创建或合并拉取请求时触发。 继续创建一个您可以自由支配的仓库。 我们可以推荐 [@octocat 的 Spoon/Knife 仓库](https://github.com/octocat/Spoon-Knife)吗？ 之后，您将在自己的仓库中创建新的 web 挂钩，向其馈送 ngrok 给您的 URL，并选择 `application/x-www-form-urlencoded` 作为内容类型： +In order for this server to work, we'll need to set a repository up with a webhook. +The webhook should be configured to fire whenever a Pull Request is created, or merged. +Go ahead and create a repository you're comfortable playing around in. Might we +suggest [@octocat's Spoon/Knife repository](https://github.com/octocat/Spoon-Knife)? +After that, you'll create a new webhook in your repository, feeding it the URL +that ngrok gave you, and choosing `application/x-www-form-urlencoded` as the +content type: -![新的 ngrok URL](/assets/images/webhook_sample_url.png) +![A new ngrok URL](/assets/images/webhook_sample_url.png) -单击 **Update webhook**。 您应该会看到正文为 `Well, it worked!` 的响应。 太好了！ 单击 **Let me select individual events（让我选择单个事件）**，然后选择以下项： +Click **Update webhook**. You should see a body response of `Well, it worked!`. +Great! Click on **Let me select individual events**, and select the following: -* 状态 -* 拉取请求 +* Status +* Pull Request -在发生相关操作时，{% data variables.product.product_name %} 会将这些事件发送到我们的服务器。 我们来将服务器更新为*仅*立即处理拉取请求场景： +These are the events {% data variables.product.product_name %} will send to our server whenever the relevant action +occurs. Let's update our server to *just* handle the Pull Request scenario right now: ``` ruby post '/event_handler' do @@ -76,15 +94,26 @@ helpers do end ``` -发生了什么？ {% data variables.product.product_name %} 发送的每个事件都附有 `X-GitHub-Event` HTTP 标头。 我们现在只关注拉取请求事件。 我们将从其中获取信息的有效负载，并返回标题字段。 在理想情况下，我们的服务器会关注每次更新拉取请求时的情况（而不仅仅是打开时的情况）。 这将确保每个新推送都通过 CI 测试。 但就此演示而言，我们只需关注它被打开时的情况。 +What's going on? Every event that {% data variables.product.product_name %} sends out attached a `X-GitHub-Event` +HTTP header. We'll only care about the PR events for now. From there, we'll +take the payload of information, and return the title field. In an ideal scenario, +our server would be concerned with every time a pull request is updated, not just +when it's opened. That would make sure that every new push passes the CI tests. +But for this demo, we'll just worry about when it's opened. -要测试此概念验证，请在测试仓库的分支中进行一些更改，然后打开拉取请求。 您的服务器应该会做出相应的响应！ +To test out this proof-of-concept, make some changes in a branch in your test +repository, and open a pull request. Your server should respond accordingly! -## 处理状态 +## Working with statuses -服务器就位后，我们就可以开始实现第一个要求，即设置（和更新）CI 状态。 请注意，无论何时更新服务器，都可以单击 **Redeliver（重新交付）**以发送相同的有效负载。 不需要每次进行更改时都发出新的拉取请求！ +With our server in place, we're ready to start our first requirement, which is +setting (and updating) CI statuses. Note that at any time you update your server, +you can click **Redeliver** to send the same payload. There's no need to make a +new pull request every time you make a change! -由于我们在与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 进行交互，因此我们将使用 [Octokit.rb][octokit.rb] 来管理我们的交互。 我们将配置该客户端： +Since we're interacting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll use [Octokit.rb][octokit.rb] +to manage our interactions. We'll configure that client with +[a personal access token][access token]: ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -96,7 +125,8 @@ before do end ``` -之后，我们只需要在 {% data variables.product.product_name %} 上更新拉取请求以明确表示我们正在处理 CI： +After that, we'll just need to update the pull request on {% data variables.product.product_name %} to make clear +that we're processing on the CI: ``` ruby def process_pull_request(pull_request) @@ -105,13 +135,16 @@ def process_pull_request(pull_request) end ``` -我们在这里做三件非常基本的事情： +We're doing three very basic things here: -* 查找仓库的全名 -* 查找拉取请求的最后一个 SHA -* 将状态设置为“待处理” +* we're looking up the full name of the repository +* we're looking up the last SHA of the pull request +* we're setting the status to "pending" -搞定！ 从这里，您可以运行任何需要的进程来执行测试套件。 也许您会将代码传递给 Jenkins，或者通过其 API 调用另一个 web 服务，例如 [Travis][travis api]。 之后，请务必再次更新状态。 在我们的示例中，我们将其设置为 `"success"`： +That's it! From here, you can run whatever process you need to in order to execute +your test suite. Maybe you're going to pass off your code to Jenkins, or call +on another web service via its API, like [Travis][travis api]. After that, you'd +be sure to update the status once more. In our example, we'll just set it to `"success"`: ``` ruby def process_pull_request(pull_request) @@ -120,24 +153,33 @@ def process_pull_request(pull_request) @client.create_status(pull_request['base']['repo']['full_name'], pull_request['head']['sha'], 'success') puts "Pull request processed!" end -``` +``` -## 结论 +## Conclusion -在 GitHub，我们多年来一直使用 [Janky][janky] 版本来管理 CI。 基本流程本质上与我们上面构建的服务器完全相同。 在 GitHub，我们： +At GitHub, we've used a version of [Janky][janky] to manage our CI for years. +The basic flow is essentially the exact same as the server we've built above. +At GitHub, we: -* 在创建或更新（通过 Janky）时触发 Jenkins -* 等待关于 CI 状态的响应 -* 如果代码为绿色，我们将合并拉取请求 +* Fire to Jenkins when a pull request is created or updated (via Janky) +* Wait for a response on the state of the CI +* If the code is green, we merge the pull request -所有这些通信都会流回我们的聊天室。 使用此示例并不需要构建自己的 CI 设置。 您始终可以依赖 [GitHub 集成][integrations]。 +All of this communication is funneled back to our chat rooms. You don't need to +build your own CI setup to use this example. +You can always rely on [GitHub integrations][integrations]. +[deploy API]: /rest/reference/repos#deployments [status API]: /rest/reference/repos#statuses [ngrok]: https://ngrok.com/ [using ngrok]: /webhooks/configuring/#using-ngrok [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/building-a-ci-server [Sinatra]: http://www.sinatrarb.com/ +[webhook]: /webhooks/ [octokit.rb]: https://github.com/octokit/octokit.rb +[access token]: /articles/creating-an-access-token-for-command-line-use [travis api]: https://api.travis-ci.org/docs/ [janky]: https://github.com/github/janky +[heaven]: https://github.com/atmos/heaven +[hubot]: https://github.com/github/hubot [integrations]: https://github.com/integrations diff --git a/translations/zh-CN/content/rest/guides/delivering-deployments.md b/translations/zh-CN/content/rest/guides/delivering-deployments.md index 178248d85a..13ad16c3da 100644 --- a/translations/zh-CN/content/rest/guides/delivering-deployments.md +++ b/translations/zh-CN/content/rest/guides/delivering-deployments.md @@ -1,9 +1,9 @@ --- -title: 交付部署 -intro: 使用部署 REST API，您可以构建与您的服务器和第三方应用程序交互的自定义工具。 +title: Delivering deployments +intro: 'Using the Deployments REST API, you can build custom tooling that interacts with your server and a third-party app.' redirect_from: - - /guides/delivering-deployments/ - - /guides/automating-deployments-to-integrators/ + - /guides/delivering-deployments + - /guides/automating-deployments-to-integrators - /v3/guides/delivering-deployments versions: fpt: '*' @@ -16,23 +16,33 @@ topics: -[部署 API][deploy API] 为您托管在 {% data variables.product.product_name %} 上的项目提供在您自己的服务器上启动它们的功能。 结合 [状态 API][status API]，您将能够在您的代码到达 `master` 时协调部署。 +The [Deployments API][deploy API] provides your projects hosted on {% data variables.product.product_name %} with +the capability to launch them on a server that you own. Combined with +[the Status API][status API], you'll be able to coordinate your deployments +the moment your code lands on the default branch. -本指南将使用该 API 来演示您可以使用的设置。 在我们的场景中，我们将： +This guide will use that API to demonstrate a setup that you can use. +In our scenario, we will: -* 合并拉取请求 -* 在 CI 完成后，我们将相应地设置拉取请求的状态。 -* 合并拉取请求后，我们将在服务器上运行部署。 +* Merge a pull request +* When the CI is finished, we'll set the pull request's status accordingly. +* When the pull request is merged, we'll run our deployment to our server. -我们的 CI 系统和主机服务器将是我们想象中的虚拟物。 它们可能是 Heroku、Amazon 或其他完全不同的工具。 本指南的重点是设置和配置负责管理通信的服务器。 +Our CI system and host server will be figments of our imagination. They could be +Heroku, Amazon, or something else entirely. The crux of this guide will be setting up +and configuring the server managing the communication. -请务必[下载 ngrok][ngrok]（如果尚未下载），并了解如何[使用它][using ngrok]。 我们发现它在暴露本地连接方面是一款非常有用的工具。 +If you haven't already, be sure to [download ngrok][ngrok], and learn how +to [use it][using ngrok]. We find it to be a very useful tool for exposing local +connections. -注：您可以[从平台样本仓库][platform samples]下载此项目的完整源代码。 +Note: you can download the complete source code for this project +[from the platform-samples repo][platform samples]. -## 编写服务器 +## Writing your server -我们将编写一个快速的 Sinatra 应用程序，以证明我们的本地连接工作正常。 首先编写以下代码： +We'll write a quick Sinatra app to prove that our local connections are working. +Let's start with this: ``` ruby require 'sinatra' @@ -44,21 +54,31 @@ post '/event_handler' do end ``` -（如果您不熟悉 Sinatra 的工作方式，建议您阅读 [ Sinatra 指南][Sinatra]）。 +(If you're unfamiliar with how Sinatra works, we recommend [reading the Sinatra guide][Sinatra].) -启动此服务器。 默认情况下，Sinatra 在端口 `4567` 上启动，因此您还需要配置 ngrok 开始监听。 +Start this server up. By default, Sinatra starts on port `4567`, so you'll want +to configure ngrok to start listening for that, too. -为了使此服务器正常工作，我们需要使用 web 挂钩来设置一个仓库。 Web 挂钩应配置为在创建或合并拉取请求时触发。 继续创建一个您可以自由支配的仓库。 我们可以推荐 [@octocat 的 Spoon/Knife 仓库](https://github.com/octocat/Spoon-Knife)吗？ 之后，您将在自己的仓库中创建新的 web 挂钩，向其馈送 ngrok 给您的 URL，并选择 `application/x-www-form-urlencoded` 作为内容类型： +In order for this server to work, we'll need to set a repository up with a webhook. +The webhook should be configured to fire whenever a pull request is created, or merged. +Go ahead and create a repository you're comfortable playing around in. Might we +suggest [@octocat's Spoon/Knife repository](https://github.com/octocat/Spoon-Knife)? +After that, you'll create a new webhook in your repository, feeding it the URL +that ngrok gave you, and choosing `application/x-www-form-urlencoded` as the +content type: -![新的 ngrok URL](/assets/images/webhook_sample_url.png) +![A new ngrok URL](/assets/images/webhook_sample_url.png) -单击 **Update webhook**。 您应该会看到正文为 `Well, it worked!` 的响应。 太好了！ 单击 **Let me select individual events（让我选择单个事件）**，然后选择以下项： +Click **Update webhook**. You should see a body response of `Well, it worked!`. +Great! Click on **Let me select individual events.**, and select the following: -* 部署 -* 部署状态 -* 拉取请求 +* Deployment +* Deployment status +* Pull Request -在发生相关操作时，{% data variables.product.product_name %} 会将这些事件发送到我们的服务器。 我们将服务器配置为*仅*在合并拉取请求时立即处理： +These are the events {% data variables.product.product_name %} will send to our server whenever the relevant action +occurs. We'll configure our server to *just* handle when pull requests are merged +right now: ``` ruby post '/event_handler' do @@ -73,15 +93,20 @@ post '/event_handler' do end ``` -发生了什么？ {% data variables.product.product_name %} 发送的每个事件都附有 `X-GitHub-Event` HTTP 标头。 我们现在只关注拉取请求事件。 当拉取请求被合并时（其状态为 `closed`，并且 `merged` 为 `true`），我们将启动部署。 +What's going on? Every event that {% data variables.product.product_name %} sends out attached a `X-GitHub-Event` +HTTP header. We'll only care about the PR events for now. When a pull request is +merged (its state is `closed`, and `merged` is `true`), we'll kick off a deployment. -要测试此概念验证，请在测试仓库的分支中进行一些更改，打开拉取请求，然后合并它。 您的服务器应该会做出相应的响应！ +To test out this proof-of-concept, make some changes in a branch in your test +repository, open a pull request, and merge it. Your server should respond accordingly! -## 处理部署 +## Working with deployments -服务器已就位，代码在接受审查，拉取请求已合并，现在我们需要部署项目。 +With our server in place, the code being reviewed, and our pull request +merged, we want our project to be deployed. -我们将首先修改事件侦听器，以便在拉取请求被合并时对其进行处理，并开始关注部署： +We'll start by modifying our event listener to process pull requests when they're +merged, and start paying attention to deployments: ``` ruby when "pull_request" @@ -95,7 +120,8 @@ when "deployment_status" end ``` -根据拉取请求中的信息，我们将首先填写 `start_deployment` 方法： +Based on the information from the pull request, we'll start by filling out the +`start_deployment` method: ``` ruby def start_deployment(pull_request) @@ -105,13 +131,19 @@ def start_deployment(pull_request) end ``` -部署可以附加一些元数据，其形式为 `payload` 和 `description`。 尽管这些值是可选的，但对于记录和表示信息很有帮助。 +Deployments can have some metadata attached to them, in the form of a `payload` +and a `description`. Although these values are optional, it's helpful to use +for logging and representing information. -创建新部署时，将触发完全独立的事件。 因此我们的事件处理程序中有一个用于 `deployment` 的新 `switch` 单元。 在触发部署时，您可以根据此信息得到通知。 +When a new deployment is created, a completely separate event is triggered. That's +why we have a new `switch` case in the event handler for `deployment`. You can +use this information to be notified when a deployment has been triggered. -部署可能需要很长时间，因此我们需要侦听各种事件，例如，部署创建时间以及部署处于什么状态。 +Deployments can take a rather long time, so we'll want to listen for various events, +such as when the deployment was created, and what state it's in. -让我们模拟一个能够完成某些工作的部署，并注意它对输出的影响。 首先，我们来完成 `process_deployment` 方法： +Let's simulate a deployment that does some work, and notice the effect it has on +the output. First, let's complete our `process_deployment` method: ``` ruby def process_deployment @@ -125,7 +157,7 @@ def process_deployment end ``` -最后，我们将模拟将状态信息存储为控制台输出： +Finally, we'll simulate storing the status information as console output: ``` ruby def update_deployment_status @@ -133,20 +165,27 @@ def update_deployment_status end ``` -我们来分析一下发生了什么。 一个新的部署由 `start_support` 创建，它触发 `deployment` 事件。 我们从那里调用 `process_deployment` 来模拟正在进行的工作。 在处理过程中，我们还调用 `create_deployment_status`，当我们将状态切换到 `pending` 时，它让接收者知道发生了什么。 +Let's break down what's going on. A new deployment is created by `start_deployment`, +which triggers the `deployment` event. From there, we call `process_deployment` +to simulate work that's going on. During that processing, we also make a call to +`create_deployment_status`, which lets a receiver know what's going on, as we +switch the status to `pending`. -部署完成后，我们将状态设置为 `success`。 +After the deployment is finished, we set the status to `success`. -## 结论 +## Conclusion -在 GitHub，我们多年来一直使用 [Heaven][heaven] 版本来管理部署。 共同流程本质上与我们上面构建的服务器基本相同： +At GitHub, we've used a version of [Heaven][heaven] to manage +our deployments for years. A common flow is essentially the same as the +server we've built above: -* 等待 CI 检查状态的响应（成功或失败） -* 如果所需的检查成功，则合并拉取请求 -* Heaven 提取合并的代码，并将其部署到暂存和生产服务器上 -* 同时。Heaven 还通过坐在我们聊天室中的 [Hubot][hubot] 通知所有人有关构建的信息 +* Wait for a response on the state of the CI checks (success or failure) +* If the required checks succeed, merge the pull request +* Heaven takes the merged code, and deploys it to staging and production servers +* In the meantime, Heaven also notifies everyone about the build, via [Hubot][hubot] sitting in our chat rooms -搞定！ 使用此示例并不需要构建自己的部署设置。 您始终可以依赖 [GitHub 集成][integrations]。 +That's it! You don't need to build your own deployment setup to use this example. +You can always rely on [GitHub integrations][integrations]. [deploy API]: /rest/reference/repos#deployments [status API]: /guides/building-a-ci-server @@ -154,6 +193,11 @@ end [using ngrok]: /webhooks/configuring/#using-ngrok [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/delivering-deployments [Sinatra]: http://www.sinatrarb.com/ +[webhook]: /webhooks/ +[octokit.rb]: https://github.com/octokit/octokit.rb +[access token]: /articles/creating-an-access-token-for-command-line-use +[travis api]: https://api.travis-ci.org/docs/ +[janky]: https://github.com/github/janky [heaven]: https://github.com/atmos/heaven [hubot]: https://github.com/github/hubot [integrations]: https://github.com/integrations diff --git a/translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md b/translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md index 74f1211882..11f6410042 100644 --- a/translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md +++ b/translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md @@ -2,7 +2,7 @@ title: Discovering resources for a user intro: Learn how to find the repositories and organizations that your app can access for a user in a reliable way for your authenticated requests to the REST API. redirect_from: - - /guides/discovering-resources-for-a-user/ + - /guides/discovering-resources-for-a-user - /v3/guides/discovering-resources-for-a-user versions: fpt: '*' diff --git a/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md b/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md index 86d5220126..4e6053352c 100644 --- a/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md @@ -2,7 +2,7 @@ title: Getting started with the REST API intro: 'Learn the foundations for using the REST API, starting with authentication and some endpoint examples.' redirect_from: - - /guides/getting-started/ + - /guides/getting-started - /v3/guides/getting-started versions: fpt: '*' diff --git a/translations/zh-CN/content/rest/guides/rendering-data-as-graphs.md b/translations/zh-CN/content/rest/guides/rendering-data-as-graphs.md index f810a0ef67..a46becae06 100644 --- a/translations/zh-CN/content/rest/guides/rendering-data-as-graphs.md +++ b/translations/zh-CN/content/rest/guides/rendering-data-as-graphs.md @@ -1,8 +1,8 @@ --- -title: 将数据渲染为图形 -intro: 了解如何使用 D3.js 库和 Ruby Octokit 可视化仓库中的编程语言。 +title: Rendering data as graphs +intro: Learn how to visualize the programming languages from your repository using the D3.js library and Ruby Octokit. redirect_from: - - /guides/rendering-data-as-graphs/ + - /guides/rendering-data-as-graphs - /v3/guides/rendering-data-as-graphs versions: fpt: '*' @@ -15,15 +15,21 @@ topics: -在本指南中，我们将使用 API 来获取有关我们拥有的仓库以及构成这些仓库的编程语言的信息。 然后，我们将使用 [D3.js][D3.js] 库来以几种不同的方式可视化这些信息。 要与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 交互，我们将使用卓越的 Ruby 库 [Octokit.rb][Octokit]。 +In this guide, we're going to use the API to fetch information about repositories +that we own, and the programming languages that make them up. Then, we'll +visualize that information in a couple of different ways using the [D3.js][D3.js] library. To +interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using the excellent Ruby library, [Octokit][Octokit]. -在开始本示例之前，您应该阅读[“身份验证基础知识”][basics-of-authentication]指南（如果尚未阅读）。 您可以在[平台样本][platform samples]仓库中找到此项目的完整源代码。 +If you haven't already, you should read the ["Basics of Authentication"][basics-of-authentication] +guide before starting this example. You can find the complete source code for this project in the [platform-samples][platform samples] repository. -我们马上开始！ +Let's jump right in! -## 设置 OAuth 应用程序 +## Setting up an OAuth application -首先，请在 {% data variables.product.product_name %} 上[注册一个新应用程序][new oauth application]。 将主 URL 和回调 URL 设置为 `http://localhost:4567/`。 与[之前][basics-of-authentication]一样，我们将使用 [sinatra-auth-github][sinatra auth github] 实现 Rack 中间件，以处理 API 的身份验证： +First, [register a new application][new oauth application] on {% data variables.product.product_name %}. Set the main and callback +URLs to `http://localhost:4567/`. As [before][basics-of-authentication], we're going to handle authentication for the API by +implementing a Rack middleware using [sinatra-auth-github][sinatra auth github]: ``` ruby require 'sinatra/auth/github' @@ -62,7 +68,7 @@ module Example end ``` -设置与上一个示例类似的 _config.ru_ 文件： +Set up a similar _config.ru_ file as in the previous example: ``` ruby ENV['RACK_ENV'] ||= 'development' @@ -74,11 +80,15 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'server')) run Example::MyGraphApp ``` -## 获取仓库信息 +## Fetching repository information -这次，为了与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 进行对话，我们将使用 [Octokit Ruby 库][Octokit]。 这比直接进行一大堆 REST 调用要容易得多。 另外，Octokit 是由 GitHubber 开发的，并且一直在积极维护，因此可以确保有效性。 +This time, in order to talk to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we're going to use the [Octokit +Ruby library][Octokit]. This is much easier than directly making a bunch of +REST calls. Plus, Octokit was developed by a GitHubber, and is actively maintained, +so you know it'll work. -通过 Octokit 进行 API 身份验证非常简单。 只需将您的登录名和令牌传递到 `Octokit::Client` 构造函数： +Authentication with the API via Octokit is easy. Just pass your login +and token to the `Octokit::Client` constructor: ``` ruby if !authenticated? @@ -88,13 +98,17 @@ else end ``` -我们来用仓库的数据做一些有趣的事情。 我们将看到它们使用的不同编程语言，并计算出哪些是最常用的。 为此，我们首先需要从 API 获取仓库列表。 使用 Octokit 时，其代码如下所述： +Let's do something interesting with the data about our repositories. We're going +to see the different programming languages they use, and count which ones are used +most often. To do that, we'll first need a list of our repositories from the API. +With Octokit, that looks like this: ``` ruby repos = client.repositories ``` -接下来，我们将遍历每个仓库，并计算 {% data variables.product.product_name %} 与之关联的语言： +Next, we'll iterate over each repository, and count the language that {% data variables.product.product_name %} +associates with it: ``` ruby language_obj = {} @@ -112,19 +126,25 @@ end languages.to_s ``` -当您重新启动服务器时，您的 web 页面应显示如下代码： +When you restart your server, your web page should display something +that looks like this: ``` ruby {"JavaScript"=>13, "PHP"=>1, "Perl"=>1, "CoffeeScript"=>2, "Python"=>1, "Java"=>3, "Ruby"=>3, "Go"=>1, "C++"=>1} ``` -到目前为止，进展不错，但结果不是很人性化。 可视化将非常有助于我们理解这些语言计数是如何分布的。 我们来将这些计数输入到 D3 中，得到一个表示语言使用频率的简洁条形图。 +So far, so good, but not very human-friendly. A visualization +would be great in helping us understand how these language counts are distributed. Let's feed +our counts into D3 to get a neat bar graph representing the popularity of the languages we use. -## 可视化语言计数 +## Visualizing language counts -D3.js（或仅 D3）是用于创建多种图表、图形和交互式可视化内容的综合库。 详细介绍 D3 的用法超出了本指南的范围，但我们推荐您阅读一篇不错的介绍性文章[“D3 for Mortals（面向大众的 D3)”][D3 mortals]。 +D3.js, or just D3, is a comprehensive library for creating many kinds of charts, graphs, and interactive visualizations. +Using D3 in detail is beyond the scope of this guide, but for a good introductory article, +check out ["D3 for Mortals"][D3 mortals]. -D3 是一个JavaScript 库，喜欢以数组的形式处理数据。 因此，让我们将 Ruby 哈希转换为 JSON 数组，以供浏览器中的 JavaScript 使用。 +D3 is a JavaScript library, and likes working with data as arrays. So, let's convert our Ruby hash into +a JSON array for use by JavaScript in the browser. ``` ruby languages = [] @@ -135,9 +155,13 @@ end erb :lang_freq, :locals => { :languages => languages.to_json} ``` -我们只需遍历对象中的每个键值对，然后将它们推入新的数组。 我们之前没有这样做是因为我们不想在创建 `language_obj` 对象的过程中遍历它。 +We're simply iterating over each key-value pair in our object and pushing them into +a new array. The reason we didn't do this earlier is because we didn't want to iterate +over our `language_obj` object while we were creating it. -现在，_lang_freq.erb_ 将需要一些 JavaScript 来支持渲染条形图。 以后，您只需使用此处提供的代码，如果您想详细了解 D3 的工作原理，您可以参考上面链接的资源： +Now, _lang_freq.erb_ is going to need some JavaScript to support rendering a bar graph. +For now, you can just use the code provided here, and refer to the resources linked above +if you want to learn more about how D3 works: ``` html @@ -218,15 +242,26 @@ erb :lang_freq, :locals => { :languages => languages.to_json} ``` -唷！ 同样，不必担心这段代码的主要功能。 这里值得注意的是顶行--`var data = <%= languages %>;`--它表示我们正在将先前创建的 `languages` 数组传递到 ERB 中进行处理。 +Phew! Again, don't worry about what most of this code is doing. The relevant part +here is a line way at the top--`var data = <%= languages %>;`--which indicates +that we're passing our previously created `languages` array into ERB for manipulation. -如“D3 for Mortals（面向大众的 D3）”所述，这未必是 D3 的最佳用法。 但它确实表明了您能够如何配合使用该库与 Octokit，做出一些真正令人惊叹的事情。 +As the "D3 for Mortals" guide suggests, this isn't necessarily the best use of +D3. But it does serve to illustrate how you can use the library, along with Octokit, +to make some really amazing things. -## 结合不同的 API 调用 +## Combining different API calls -现在是时候坦白了：仓库中的 `language` 属性仅标识定义的“主要”语言。 这意味着，如果您的仓库结合了多种语言，则代码字节最多的语言将被视为主要语言。 +Now it's time for a confession: the `language` attribute within repositories +only identifies the "primary" language defined. That means that if you have +a repository that combines several languages, the one with the most bytes of code +is considered to be the primary language. -让我们结合几个 API 调用来_真正_呈现哪种语言在我们所有代码中写入的字节数最多。 相比简单的计数，[树形图][D3 treemap]应该是可视化编码语言使用量的好方法。 我们需要构造一个如下所示的对象数组： +Let's combine a few API calls to get a _true_ representation of which language +has the greatest number of bytes written across all our code. A [treemap][D3 treemap] +should be a great way to visualize the sizes of our coding languages used, rather +than simply the count. We'll need to construct an array of objects that looks +something like this: ``` json [ { "name": "language1", "size": 100}, @@ -235,7 +270,8 @@ erb :lang_freq, :locals => { :languages => languages.to_json} ] ``` -我们在前面已经获取了仓库列表，现在我们来检查每个仓库，然后调用[语言列表 API 方法][language API]： +Since we already have a list of repositories above, let's inspect each one, and +call [the language listing API method][language API]: ``` ruby repos.each do |repo| @@ -244,7 +280,7 @@ repos.each do |repo| end ``` -我们将从中找到的每种语言累加到“主列表”中： +From there, we'll cumulatively add each language found to a list of languages: ``` ruby repo_langs.each do |lang, count| @@ -256,7 +292,7 @@ repo_langs.each do |lang, count| end ``` -之后，我们将内容格式化为 D3 可以理解的结构： +After that, we'll format the contents into a structure that D3 understands: ``` ruby language_obj.each do |lang, count| @@ -267,15 +303,16 @@ end language_bytes = [ :name => "language_bytes", :elements => language_byte_count] ``` -（有关 D3 树图魔方的更多信息，请查看[这个简单教程][language API]。） +(For more information on D3 tree map magic, check out [this simple tutorial][language API].) -最后，我们将这些 JSON 信息传递到同一个 ERB 模板： +To wrap up, we pass this JSON information over to the same ERB template: ``` ruby erb :lang_freq, :locals => { :languages => languages.to_json, :language_byte_count => language_bytes.to_json} ``` -与以前一样，这里有一堆 JavaScript，您可以直接将它们放到模板中： +Like before, here's a bunch of JavaScript that you can drop +directly into your template: ``` html
@@ -325,18 +362,19 @@ erb :lang_freq, :locals => { :languages => languages.to_json, :language_byte_cou ``` -瞧！ 包含仓库语言信息的精美矩形，按相对比例显示，让您一目了然。 您可能需要调整树形图的高度和宽度（作为前两个参数传递到上述 `drawTreemap`），使所有信息适当显示。 +Et voila! Beautiful rectangles containing your repo languages, with relative +proportions that are easy to see at a glance. You might need to +tweak the height and width of your treemap, passed as the first two +arguments to `drawTreemap` above, to get all the information to show up properly. [D3.js]: http://d3js.org/ [basics-of-authentication]: /rest/guides/basics-of-authentication -[basics-of-authentication]: /rest/guides/basics-of-authentication [sinatra auth github]: https://github.com/atmos/sinatra_auth_github [Octokit]: https://github.com/octokit/octokit.rb -[Octokit]: https://github.com/octokit/octokit.rb [D3 mortals]: http://www.recursion.org/d3-for-mere-mortals/ -[D3 treemap]: https://www.d3-graph-gallery.com/treemap.html -[language API]: /rest/reference/repos#list-repository-languages +[D3 treemap]: https://www.d3-graph-gallery.com/treemap.html [language API]: /rest/reference/repos#list-repository-languages +[simple tree map]: http://2kittymafiasoftware.blogspot.com/2011/09/simple-treemap-visualization-with-d3.html [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/rendering-data-as-graphs [new oauth application]: https://github.com/settings/applications/new diff --git a/translations/zh-CN/content/rest/guides/traversing-with-pagination.md b/translations/zh-CN/content/rest/guides/traversing-with-pagination.md index 36400d1399..4b13c46e3d 100644 --- a/translations/zh-CN/content/rest/guides/traversing-with-pagination.md +++ b/translations/zh-CN/content/rest/guides/traversing-with-pagination.md @@ -2,7 +2,7 @@ title: Traversing with pagination intro: Explore how to use pagination to manage your responses with some examples using the Search API. redirect_from: - - /guides/traversing-with-pagination/ + - /guides/traversing-with-pagination - /v3/guides/traversing-with-pagination versions: fpt: '*' diff --git a/translations/zh-CN/content/rest/guides/working-with-comments.md b/translations/zh-CN/content/rest/guides/working-with-comments.md index 371054556f..3b5736faea 100644 --- a/translations/zh-CN/content/rest/guides/working-with-comments.md +++ b/translations/zh-CN/content/rest/guides/working-with-comments.md @@ -2,7 +2,7 @@ title: Working with comments intro: 'Using the REST API, you can access and manage comments in your pull requests, issues, or commits.' redirect_from: - - /guides/working-with-comments/ + - /guides/working-with-comments - /v3/guides/working-with-comments versions: fpt: '*' diff --git a/translations/zh-CN/content/rest/overview/libraries.md b/translations/zh-CN/content/rest/overview/libraries.md index 3cd06c3758..0128487f72 100644 --- a/translations/zh-CN/content/rest/overview/libraries.md +++ b/translations/zh-CN/content/rest/overview/libraries.md @@ -1,8 +1,8 @@ --- -title: 库 -intro: '您可以使用官方的 Octokit 库和其他第三方库来扩展和简化您使用 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 的方式。' +title: Libraries +intro: 'You can use the official Octokit library and other third-party libraries to extend and simplify how you use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API.' redirect_from: - - /libraries/ + - /libraries - /v3/libraries versions: fpt: '*' @@ -14,9 +14,9 @@ topics: ---
- Gundamcat -

Octokit 风格多样

-

使用官方的 Octokit 库，或者使用任何适用的第三方库。

+ The Gundamcat +

Octokit comes in many flavors

+

Use the official Octokit library, or choose between any of the available third party libraries.


Ruby → octokit.rb

.NET → octokit.net

@@ -24,130 +24,130 @@ topics:
-# 第三方库 +# Third-party libraries ### Clojure -| 库名称 | 仓库 | -| ------------- | ------------------------------------------------------- | -| **Tentacles** | [Raynes/tentacles](https://github.com/Raynes/tentacles) | +| Library name | Repository | +|---|---| +|**Tentacles**| [Raynes/tentacles](https://github.com/Raynes/tentacles)| ### Dart -| 库名称 | 仓库 | -| --------------- | ----------------------------------------------------------------------- | -| **github.dart** | [DirectMyFile/github.dart](https://github.com/DirectMyFile/github.dart) | +| Library name | Repository | +|---|---| +|**github.dart** | [DirectMyFile/github.dart](https://github.com/DirectMyFile/github.dart)| ### Emacs Lisp -| 库名称 | 仓库 | -| --------- | --------------------------------------------- | -| **gh.el** | [sigma/gh.el](https://github.com/sigma/gh.el) | +| Library name | Repository | +|---|---| +|**gh.el** | [sigma/gh.el](https://github.com/sigma/gh.el)| ### Erlang -| 库名称 | 仓库 | -| ------------ | ------------------------------------------------------- | -| **octo-erl** | [sdepold/octo.erl](https://github.com/sdepold/octo.erl) | +| Library name | Repository | +|---|---| +|**octo-erl** | [sdepold/octo.erl](https://github.com/sdepold/octo.erl)| ### Go -| 库名称 | 仓库 | -| ------------- | ------------------------------------------------------- | -| **go-github** | [google/go-github](https://github.com/google/go-github) | +| Library name | Repository | +|---|---| +|**go-github**| [google/go-github](https://github.com/google/go-github)| ### Haskell -| 库名称 | 仓库 | -| ------------------ | --------------------------------------------- | -| **haskell-github** | [fpco/Github](https://github.com/fpco/GitHub) | +| Library name | Repository | +|---|---| +|**haskell-github** | [fpco/Github](https://github.com/fpco/GitHub)| ### Java -| 库名称 | 仓库 | 更多信息 | -| ----------------------- | ------------------------------------------------------------------- | -------------------------------------------------------------- | -| **GitHub API for Java** | [org.kohsuke.github（来自 github-api）](http://github-api.kohsuke.org/) | 定义 GitHub API 的面向对象的表示。 | -| **JCabi GitHub API** | [github.jcabi.com（个人网站）](http://github.jcabi.com) | 基于 JavaScript API (JSR-353)，可简化使用运行时 GitHub stub 的测试，并覆盖整个API。 | +| Library name | Repository | More information | +|---|---|---| +|**GitHub API for Java**| [org.kohsuke.github (From github-api)](http://github-api.kohsuke.org/)|defines an object oriented representation of the GitHub API.| +|**JCabi GitHub API**|[github.jcabi.com (Personal Website)](http://github.jcabi.com)|is based on Java7 JSON API (JSR-353), simplifies tests with a runtime GitHub stub, and covers the entire API.| ### JavaScript -| 库名称 | 仓库 | -| ----------------------------------------------------- | ----------------------------------------------------------------------- | -| **NodeJS GitHub library** | [pksunkara/octonode](https://github.com/pksunkara/octonode) | -| **gh3 client-side API v3 wrapper** | [k33g/gh3](https://github.com/k33g/gh3) | -| **关于 GitHub API 的 Github.js 包装程序** | [michael/github](https://github.com/michael/github) | -| **适用于 Browser 或 NodeJS 的基于 Promise 的 CoffeeScript 库** | [philschatz/github-client](https://github.com/philschatz/github-client) | +| Library name | Repository | +|---|---| +|**NodeJS GitHub library**| [pksunkara/octonode](https://github.com/pksunkara/octonode)| +|**gh3 client-side API v3 wrapper**| [k33g/gh3](https://github.com/k33g/gh3)| +|**Github.js wrapper around the GitHub API**|[michael/github](https://github.com/michael/github)| +|**Promise-Based CoffeeScript library for the Browser or NodeJS**|[philschatz/github-client](https://github.com/philschatz/github-client)| ### Julia -| 库名称 | 仓库 | -| ------------- | ----------------------------------------------------------- | -| **GitHub.jl** | [JuliaWeb/GitHub.jl](https://github.com/JuliaWeb/GitHub.jl) | +| Library name | Repository | +|---|---| +|**GitHub.jl**|[JuliaWeb/GitHub.jl](https://github.com/JuliaWeb/GitHub.jl)| ### OCaml -| 库名称 | 仓库 | -| ---------------- | ------------------------------------------------------------- | -| **ocaml-github** | [mirage/ocaml-github](https://github.com/mirage/ocaml-github) | +| Library name | Repository | +|---|---| +|**ocaml-github**|[mirage/ocaml-github](https://github.com/mirage/ocaml-github)| ### Perl -| 库名称 | 仓库 | 库的 metacpan 网站 | -| --------------- | --------------------------------------------------------------------- | ------------------------------------------------------- | -| **Pithub** | [plu/Pithub](https://github.com/plu/Pithub) | [Pithub CPAN](http://metacpan.org/module/Pithub) | -| **Net::GitHub** | [fayland/perl-net-github](https://github.com/fayland/perl-net-github) | [Net:GitHub CPAN](https://metacpan.org/pod/Net::GitHub) | +| Library name | Repository | metacpan Website for the Library | +|---|---|---| +|**Pithub**|[plu/Pithub](https://github.com/plu/Pithub)|[Pithub CPAN](http://metacpan.org/module/Pithub)| +|**Net::GitHub**|[fayland/perl-net-github](https://github.com/fayland/perl-net-github)|[Net:GitHub CPAN](https://metacpan.org/pod/Net::GitHub)| ### PHP -| 库名称 | 仓库 | -| ----------------------------- | --------------------------------------------------------------------------------- | -| **PHP GitHub API** | [KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api) | -| **GitHub Joomla! 包** | [joomla-framework/github-api](https://github.com/joomla-framework/github-api) | -| **GitHub bridge for Laravel** | [GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) | +| Library name | Repository | +|---|---| +|**PHP GitHub API**|[KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api)| +|**GitHub Joomla! Package**|[joomla-framework/github-api](https://github.com/joomla-framework/github-api)| +|**GitHub bridge for Laravel**|[GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub)| ### PowerShell -| 库名称 | 仓库 | -| ----------------------- | --------------------------------------------------------------------------------- | -| **PowerShellForGitHub** | [microsoft/PowerShellForGitHub](https://github.com/microsoft/PowerShellForGitHub) | +| Library name | Repository | +|---|---| +|**PowerShellForGitHub**|[microsoft/PowerShellForGitHub](https://github.com/microsoft/PowerShellForGitHub)| ### Python -| 库名称 | 仓库 | -| ---------------- | ---------------------------------------------------------------------- | -| **gidgethub** | [brettcannon/gidgethub](https://github.com/brettcannon/gidgethub) | -| **ghapi** | [fastai/ghapi](https://github.com/fastai/ghapi) | -| **PyGithub** | [PyGithub/PyGithub](https://github.com/PyGithub/PyGithub) | -| **libsaas** | [duckboard/libsaas](https://github.com/ducksboard/libsaas) | -| **github3.py** | [sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py) | -| **sanction** | [demianbrecht/sanction](https://github.com/demianbrecht/sanction) | -| **agithub** | [jpaugh/agithub](https://github.com/jpaugh/agithub) | -| **octohub** | [turnkeylinux/octohub](https://github.com/turnkeylinux/octohub) | -| **github-flask** | [github-flask (Official Website)](http://github-flask.readthedocs.org) | -| **torngithub** | [jkeylu/torngithub](https://github.com/jkeylu/torngithub) | +| Library name | Repository | +|---|---| +|**gidgethub**|[brettcannon/gidgethub](https://github.com/brettcannon/gidgethub)| +|**ghapi**|[fastai/ghapi](https://github.com/fastai/ghapi)| +|**PyGithub**|[PyGithub/PyGithub](https://github.com/PyGithub/PyGithub)| +|**libsaas**|[duckboard/libsaas](https://github.com/ducksboard/libsaas)| +|**github3.py**|[sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py)| +|**sanction**|[demianbrecht/sanction](https://github.com/demianbrecht/sanction)| +|**agithub**|[jpaugh/agithub](https://github.com/jpaugh/agithub)| +|**octohub**|[turnkeylinux/octohub](https://github.com/turnkeylinux/octohub)| +|**github-flask**|[github-flask (Official Website)](http://github-flask.readthedocs.org)| +|**torngithub**|[jkeylu/torngithub](https://github.com/jkeylu/torngithub)| ### Ruby -| 库名称 | 仓库 | -| ------------------ | ------------------------------------------------------------- | -| **GitHub API Gem** | [peter-murach/github](https://github.com/peter-murach/github) | -| **Ghee** | [rauhryan/ghee](https://github.com/rauhryan/ghee) | +| Library name | Repository | +|---|---| +|**GitHub API Gem**|[peter-murach/github](https://github.com/peter-murach/github)| +|**Ghee**|[rauhryan/ghee](https://github.com/rauhryan/ghee)| ### Rust -| 库名称 | 仓库 | -| ------------ | ------------------------------------------------------------- | -| **Octocrab** | [XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab) | +| Library name | Repository | +|---|---| +|**Octocrab**|[XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab)| ### Scala -| 库名称 | 仓库 | -| ------------ | ------------------------------------------------------- | -| **Hubcat** | [softprops/hubcat](https://github.com/softprops/hubcat) | -| **Github4s** | [47deg/github4s](https://github.com/47deg/github4s) | +| Library name | Repository | +|---|---| +|**Hubcat**|[softprops/hubcat](https://github.com/softprops/hubcat)| +|**Github4s**|[47deg/github4s](https://github.com/47deg/github4s)| ### Shell -| 库名称 | 仓库 | -| --------- | ----------------------------------------------------- | -| **ok.sh** | [whiteinge/ok.sh](https://github.com/whiteinge/ok.sh) | +| Library name | Repository | +|---|---| +|**ok.sh**|[whiteinge/ok.sh](https://github.com/whiteinge/ok.sh)| diff --git a/translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md b/translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md index d3ebb7c1e2..49c8175768 100644 --- a/translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md +++ b/translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md @@ -2,7 +2,7 @@ title: Resources in the REST API intro: 'Learn how to navigate the resources provided by the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API.' redirect_from: - - /rest/initialize-the-repo/ + - /rest/initialize-the-repo versions: fpt: '*' ghes: '*' diff --git a/translations/zh-CN/content/rest/reference/enterprise-admin.md b/translations/zh-CN/content/rest/reference/enterprise-admin.md index fbe657c8eb..d903396303 100644 --- a/translations/zh-CN/content/rest/reference/enterprise-admin.md +++ b/translations/zh-CN/content/rest/reference/enterprise-admin.md @@ -186,7 +186,7 @@ $ curl -L 'https://hostname:admin_port/setup/api?api_key=y You can also use standard HTTP authentication to send this token. For example: ```shell -$ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api' +$ curl -L -u "api_key:your-amazing-password" 'https://hostname:admin_port/setup/api' ``` {% for operation in currentRestOperations %} diff --git a/translations/zh-CN/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md b/translations/zh-CN/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md index f6f7e88e11..74e1a19074 100644 --- a/translations/zh-CN/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md +++ b/translations/zh-CN/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md @@ -2,11 +2,11 @@ title: About searching on GitHub intro: 'Our integrated search covers the many repositories, users, and lines of code on {% data variables.product.product_name %}.' redirect_from: - - /articles/using-the-command-bar/ - - /articles/github-search-basics/ - - /articles/search-basics/ - - /articles/searching-github/ - - /articles/advanced-search/ + - /articles/using-the-command-bar + - /articles/github-search-basics + - /articles/search-basics + - /articles/searching-github + - /articles/advanced-search - /articles/about-searching-on-github - /github/searching-for-information-on-github/about-searching-on-github - /github/searching-for-information-on-github/getting-started-with-searching-on-github/about-searching-on-github diff --git a/translations/zh-CN/content/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment.md b/translations/zh-CN/content/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment.md index cf410536e1..2e98bbd3ee 100644 --- a/translations/zh-CN/content/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment.md +++ b/translations/zh-CN/content/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment.md @@ -3,9 +3,9 @@ title: Enabling GitHub.com repository search from your private enterprise enviro shortTitle: Search GitHub.com from enterprise intro: 'You can connect your personal accounts on {% data variables.product.prodname_dotcom_the_website %} and your private {% data variables.product.prodname_enterprise %} environment to search for content in certain {% data variables.product.prodname_dotcom_the_website %} repositories{% ifversion fpt or ghec %} from your private environment{% else %} from {% data variables.product.product_name %}{% endif %}.' redirect_from: - - /articles/enabling-private-githubcom-repository-search-in-your-github-enterprise-account/ - - /articles/enabling-private-github-com-repository-search-in-your-github-enterprise-server-account/ - - /articles/enabling-private-githubcom-repository-search-in-your-github-enterprise-server-account/ + - /articles/enabling-private-githubcom-repository-search-in-your-github-enterprise-account + - /articles/enabling-private-github-com-repository-search-in-your-github-enterprise-server-account + - /articles/enabling-private-githubcom-repository-search-in-your-github-enterprise-server-account - /articles/enabling-githubcom-repository-search-in-github-enterprise-server - /github/searching-for-information-on-github/enabling-githubcom-repository-search-in-github-enterprise-server - /github/searching-for-information-on-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-in-github-enterprise-server diff --git a/translations/zh-CN/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md b/translations/zh-CN/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md index dc0b4880d1..82108d649c 100644 --- a/translations/zh-CN/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md +++ b/translations/zh-CN/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md @@ -1,8 +1,8 @@ --- -title: 了解搜索语法 -intro: '搜索 {% data variables.product.product_name %} 时，您可以构建匹配特定数字和单词的查询。' +title: Understanding the search syntax +intro: 'When searching {% data variables.product.product_name %}, you can construct queries that match specific numbers and words.' redirect_from: - - /articles/search-syntax/ + - /articles/search-syntax - /articles/understanding-the-search-syntax - /github/searching-for-information-on-github/understanding-the-search-syntax - /github/searching-for-information-on-github/getting-started-with-searching-on-github/understanding-the-search-syntax @@ -13,88 +13,87 @@ versions: ghec: '*' topics: - GitHub search -shortTitle: 了解搜索语法 +shortTitle: Understand search syntax --- +## Query for values greater or less than another value -## 查询大于或小于另一个值的值 +You can use `>`, `>=`, `<`, and `<=` to search for values that are greater than, greater than or equal to, less than, and less than or equal to another value. -您可以使用 `>`、`>=`、`<` 和 `<=` 搜索大于、大于等于、小于以及小于等于另一个值的值。 +Query | Example +------------- | ------------- +>n | **[cats stars:>1000](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%3E1000&type=Repositories)** matches repositories with the word "cats" that have more than 1000 stars. +>=n | **[cats topics:>=5](https://github.com/search?utf8=%E2%9C%93&q=cats+topics%3A%3E%3D5&type=Repositories)** matches repositories with the word "cats" that have 5 or more topics. +<n | **[cats size:<10000](https://github.com/search?utf8=%E2%9C%93&q=cats+size%3A%3C10000&type=Code)** matches code with the word "cats" in files that are smaller than 10 KB. +<=n | **[cats stars:<=50](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%3C%3D50&type=Repositories)** matches repositories with the word "cats" that have 50 or fewer stars. -| 查询 | 示例 | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| >n | **[cats stars:>1000](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%3E1000&type=Repositories)** 匹配含有 "cats" 字样、星标超过 1000 个的仓库。 | -| >=n | **[cats topics:>=5](https://github.com/search?utf8=%E2%9C%93&q=cats+topics%3A%3E%3D5&type=Repositories)** 匹配含有 "cats" 字样、有 5 个或更多主题的仓库。 | -| <n | **[cats size:<10000](https://github.com/search?utf8=%E2%9C%93&q=cats+size%3A%3C10000&type=Code)** 匹配小于 10 KB 的文件中含有 "cats" 字样的代码。 | -| <=n | **[cats stars:<=50](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%3C%3D50&type=Repositories)** 匹配含有 "cats" 字样、星标不超过 50 个的仓库。 | +You can also use [range queries](#query-for-values-between-a-range) to search for values that are greater than or equal to, or less than or equal to, another value. -您还可以使用[范围查询](#query-for-values-between-a-range)搜索大于等于或小于等于另一个值的值。 +Query | Example +------------- | ------------- +n..* | **[cats stars:10..*](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A10..*&type=Repositories)** is equivalent to `stars:>=10` and matches repositories with the word "cats" that have 10 or more stars. +*..n | **[cats stars:*..10](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%22*..10%22&type=Repositories)** is equivalent to `stars:<=10` and matches repositories with the word "cats" that have 10 or fewer stars. -| 查询 | 示例 | -| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| n..* | **[cats stars:10..*](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A10..*&type=Repositories)** 等同于 `stars:>=10` 并匹配含有 "cats" 字样、有 10 个或更多星号的仓库。 | -| *..n | **[cats stars:*..10](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%22*..10%22&type=Repositories)** 等同于 `stars:<=10` 并匹配含有 "cats" 字样、有不超过 10 个星号的仓库。 | +## Query for values between a range -## 查询范围之间的值 +You can use the range syntax n..n to search for values within a range, where the first number _n_ is the lowest value and the second is the highest value. -您可以使用范围语法 n..n 搜索范围内的值，其中第一个数字 _n_ 是最低值，而第二个是最高值。 +Query | Example +------------- | ------------- +n..n | **[cats stars:10..50](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A10..50&type=Repositories)** matches repositories with the word "cats" that have between 10 and 50 stars. -| 查询 | 示例 | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| n..n | **[cats stars:10..50](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A10..50&type=Repositories)** 匹配含有 "cats" 字样、有 10 到 50 个星号的仓库。 | +## Query for dates -## 查询日期 +You can search for dates that are earlier or later than another date, or that fall within a range of dates, by using `>`, `>=`, `<`, `<=`, and [range queries](#query-for-values-between-a-range). {% data reusables.time_date.date_format %} -您可以通过使用 `>`、`>=`、`<`、`<=` 和[范围查询](#query-for-values-between-a-range)搜索早于或晚于另一个日期，或者位于日期范围内的日期。 {% data reusables.time_date.date_format %} - -| 查询 | 示例 | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| >YYYY-MM-DD | **[cats created:>2016-04-29](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3E2016-04-29&type=Issues)** 匹配含有 "cats" 字样、在 2016 年 4 月 29 日之后创建的议题。 | -| >=YYYY-MM-DD | **[cats created:>=2017-04-01](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3E%3D2017-04-01&type=Issues)** 匹配含有 "cats" 字样、在 2017 年 4 月 1 日或之后创建的议题。 | -| <YYYY-MM-DD | **[cats pushed:<2012-07-05](https://github.com/search?q=cats+pushed%3A%3C2012-07-05&type=Code&utf8=%E2%9C%93)** 匹配在 2012 年 7 月 5 日之前推送的仓库中含有 "cats" 字样的代码。 | -| <=YYYY-MM-DD | **[cats created:<=2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3C%3D2012-07-04&type=Issues)** 匹配含有 "cats" 字样、在 2012 年 7 月 4 日或之前创建的议题。 | -| YYYY-MM-DD..YYYY-MM-DD | **[cats pushed:2016-04-30..2016-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+pushed%3A2016-04-30..2016-07-04&type=Repositories)** 匹配含有 "cats" 字样、在 2016 年 4 月末到 7 月之间推送的仓库。 | -| YYYY-MM-DD..* | **[cats created:2012-04-30..*](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2012-04-30..*&type=Issues)** 匹配在 2012 年 4 月 30 日之后创建、含有 "cats" 字样的议题。 | -| *..YYYY-MM-DD | **[cats created:*..2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A*..2012-07-04&type=Issues)** 匹配在 2012 年 7 月 4 日之前创建、含有 "cats" 字样的议题。 | +Query | Example +------------- | ------------- +>YYYY-MM-DD | **[cats created:>2016-04-29](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3E2016-04-29&type=Issues)** matches issues with the word "cats" that were created after April 29, 2016. +>=YYYY-MM-DD | **[cats created:>=2017-04-01](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3E%3D2017-04-01&type=Issues)** matches issues with the word "cats" that were created on or after April 1, 2017. +<YYYY-MM-DD | **[cats pushed:<2012-07-05](https://github.com/search?q=cats+pushed%3A%3C2012-07-05&type=Code&utf8=%E2%9C%93)** matches code with the word "cats" in repositories that were pushed to before July 5, 2012. +<=YYYY-MM-DD | **[cats created:<=2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3C%3D2012-07-04&type=Issues)** matches issues with the word "cats" that were created on or before July 4, 2012. +YYYY-MM-DD..YYYY-MM-DD | **[cats pushed:2016-04-30..2016-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+pushed%3A2016-04-30..2016-07-04&type=Repositories)** matches repositories with the word "cats" that were pushed to between the end of April and July of 2016. +YYYY-MM-DD..* | **[cats created:2012-04-30..*](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2012-04-30..*&type=Issues)** matches issues created after April 30th, 2012 containing the word "cats." +*..YYYY-MM-DD | **[cats created:*..2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A*..2012-07-04&type=Issues)** matches issues created before July 4th, 2012 containing the word "cats." {% data reusables.time_date.time_format %} -| 查询 | 示例 | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| YYYY-MM-DDTHH:MM:SS+00:00 | **[cats created:2017-01-01T01:00:00+07:00..2017-03-01T15:30:15+07:00](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2017-01-01T01%3A00%3A00%2B07%3A00..2017-03-01T15%3A30%3A15%2B07%3A00&type=Issues)** 匹配在 2017 年 1 月 1 日凌晨 1 点（UTC 偏移为 `07:00`）与 2017 年 3 月 1 日下午 3 点（UTC 偏移为 `07:00`）之间创建的议题。 UTC 偏移量 `07:00`，2017 年 3 月 1 日下午 3 点。 UTC 偏移量 `07:00`。 | -| YYYY-MM-DDTHH:MM:SSZ | **[cats created:2016-03-21T14:11:00Z..2016-04-07T20:45:00Z](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2016-03-21T14%3A11%3A00Z..2016-04-07T20%3A45%3A00Z&type=Issues)** 匹配在 2016 年 3 月 21 日下午 2:11 与 2016 年 4 月 7 日晚上 8:45 之间创建的议题。 | +Query | Example +------------- | ------------- +YYYY-MM-DDTHH:MM:SS+00:00 | **[cats created:2017-01-01T01:00:00+07:00..2017-03-01T15:30:15+07:00](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2017-01-01T01%3A00%3A00%2B07%3A00..2017-03-01T15%3A30%3A15%2B07%3A00&type=Issues)** matches issues created between January 1, 2017 at 1 a.m. with a UTC offset of `07:00` and March 1, 2017 at 3 p.m. with a UTC offset of `07:00`. +YYYY-MM-DDTHH:MM:SSZ | **[cats created:2016-03-21T14:11:00Z..2016-04-07T20:45:00Z](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2016-03-21T14%3A11%3A00Z..2016-04-07T20%3A45%3A00Z&type=Issues)** matches issues created between March 21, 2016 at 2:11pm and April 7, 2106 at 8:45pm. -## 排除特定结果 +## Exclude certain results -您可以使用 `NOT` 语法排除包含特定字词的结果。 `NOT` 运算符只能用于字符串关键词， 不适用于数字或日期。 +You can exclude results containing a certain word, using the `NOT` syntax. The `NOT` operator can only be used for string keywords. It does not work for numerals or dates. -| 查询 | 示例 | -| ----- | ----------------------------------------------------------------------------------------------------------------------- | -| `NOT` | **[hello NOT world](https://github.com/search?q=hello+NOT+world&type=Repositories)** 匹配含有 "hello" 字样但不含有 "world" 字样的仓库。 | +Query | Example +------------- | ------------- +`NOT` | **[hello NOT world](https://github.com/search?q=hello+NOT+world&type=Repositories)** matches repositories that have the word "hello" but not the word "world." -缩小搜索结果范围的另一种途径是排除特定的子集。 您可以为任何搜索限定符添加 `-` 前缀，以排除该限定符匹配的所有结果。 +Another way you can narrow down search results is to exclude certain subsets. You can prefix any search qualifier with a `-` to exclude all results that are matched by that qualifier. -| 查询 | 示例 | -| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| -QUALIFIER | **[mentions:defunkt -org:github](https://github.com/search?utf8=%E2%9C%93&q=mentions%3Adefunkt+-org%3Agithub&type=Issues)** 匹配提及 @defunkt 且不在 GitHub 组织仓库中的议题. | +Query | Example +------------- | ------------- +-QUALIFIER | **[mentions:defunkt -org:github](https://github.com/search?utf8=%E2%9C%93&q=mentions%3Adefunkt+-org%3Agithub&type=Issues)** matches issues mentioning @defunkt that are not in repositories in the GitHub organization. -## 对带有空格的查询使用引号 +## Use quotation marks for queries with whitespace -如果搜索含有空格的查询，您需要用引号将其括起来。 例如： +If your search query contains whitespace, you will need to surround it with quotation marks. For example: -* [cats NOT "hello world"](https://github.com/search?utf8=✓&q=cats+NOT+"hello+world"&type=Repositories) 匹配含有 "cats" 字样但不含有 "hello world" 字样的仓库。 -* [build label:"bug fix"](https://github.com/search?utf8=%E2%9C%93&q=build+label%3A%22bug+fix%22&type=Issues) 匹配具有标签 "bug fix"、含有 "build" 字样的议题。 +* [cats NOT "hello world"](https://github.com/search?utf8=✓&q=cats+NOT+"hello+world"&type=Repositories) matches repositories with the word "cats" but not the words "hello world." +* [build label:"bug fix"](https://github.com/search?utf8=%E2%9C%93&q=build+label%3A%22bug+fix%22&type=Issues) matches issues with the word "build" that have the label "bug fix." -某些非字母数字符号（例如空格）会从引号内的代码搜索查询中删除，因此结果可能出乎意料。 +Some non-alphanumeric symbols, such as spaces, are dropped from code search queries within quotation marks, so results can be unexpected. {% ifversion fpt or ghes or ghae or ghec %} -## 使用用户名的查询 +## Queries with usernames -如果搜索查询包含需要用户名的限定符，例如 `user`、`actor` 或 `assignee`，您可以使用任何 {% data variables.product.product_name %} 用户名指定特定人员，或使用 `@me` 指定当前用户。 +If your search query contains a qualifier that requires a username, such as `user`, `actor`, or `assignee`, you can use any {% data variables.product.product_name %} username, to specify a specific person, or `@me`, to specify the current user. -| 查询 | 示例 | -| -------------------- | ------------------------------------------------------------------------------------------------------------- | -| `QUALIFIER:USERNAME` | [`author:nat`](https://github.com/search?q=author%3Anat&type=Commits) 匹配 @nat 创作的提交。 | -| `QUALIFIER:@me` | [`is:issue assignee:@me`](https://github.com/search?q=is%3Aissue+assignee%3A%40me&type=Issues) 匹配已分配给结果查看者的议题 | +Query | Example +------------- | ------------- +`QUALIFIER:USERNAME` | [`author:nat`](https://github.com/search?q=author%3Anat&type=Commits) matches commits authored by @nat +`QUALIFIER:@me` | [`is:issue assignee:@me`](https://github.com/search?q=is%3Aissue+assignee%3A%40me&type=Issues) matches issues assigned to the person viewing the results -`@me` 只能与限定符一起使用，而不能用作搜索词，例如 `@me main.workflow`。 +You can only use `@me` with a qualifier and not as search term, such as `@me main.workflow`. {% endif %} diff --git a/translations/zh-CN/content/search-github/index.md b/translations/zh-CN/content/search-github/index.md index 9774146e39..c2eeff5e6d 100644 --- a/translations/zh-CN/content/search-github/index.md +++ b/translations/zh-CN/content/search-github/index.md @@ -1,9 +1,9 @@ --- -title: 在 GitHub 上搜索信息 -intro: 使用不同类型的搜索来查找您想要的信息。 +title: Searching for information on GitHub +intro: Use different types of searches to find the information you want. redirect_from: - - /categories/78/articles/ - - /categories/search/ + - /categories/78/articles + - /categories/search - /categories/searching-for-information-on-github - /github/searching-for-information-on-github versions: @@ -16,6 +16,6 @@ topics: children: - /getting-started-with-searching-on-github - /searching-on-github -shortTitle: 在 GitHub 上搜索 +shortTitle: Search on GitHub --- diff --git a/translations/zh-CN/content/search-github/searching-on-github/searching-for-repositories.md b/translations/zh-CN/content/search-github/searching-on-github/searching-for-repositories.md index d0f25c2d0c..f12649f07a 100644 --- a/translations/zh-CN/content/search-github/searching-on-github/searching-for-repositories.md +++ b/translations/zh-CN/content/search-github/searching-on-github/searching-for-repositories.md @@ -2,7 +2,7 @@ title: Searching for repositories intro: 'You can search for repositories on {% data variables.product.product_name %} and narrow the results using these repository search qualifiers in any combination.' redirect_from: - - /articles/searching-repositories/ + - /articles/searching-repositories - /articles/searching-for-repositories - /github/searching-for-information-on-github/searching-for-repositories - /github/searching-for-information-on-github/searching-on-github/searching-for-repositories diff --git a/translations/zh-CN/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/translations/zh-CN/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index 87b2785ed3..d41e60cedd 100644 --- a/translations/zh-CN/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/translations/zh-CN/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -2,7 +2,7 @@ title: Searching issues and pull requests intro: 'You can search for issues and pull requests on {% data variables.product.product_name %} and narrow the results using these search qualifiers in any combination.' redirect_from: - - /articles/searching-issues/ + - /articles/searching-issues - /articles/searching-issues-and-pull-requests - /github/searching-for-information-on-github/searching-issues-and-pull-requests - /github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests diff --git a/translations/zh-CN/data/features/actions-starter-template-ui.yml b/translations/zh-CN/data/features/actions-starter-template-ui.yml new file mode 100644 index 0000000000..7e1ebe5384 --- /dev/null +++ b/translations/zh-CN/data/features/actions-starter-template-ui.yml @@ -0,0 +1,6 @@ +--- +#Reference: #5169. +#Documentation for the Actions starter template UI updates +versions: + fpt: '*' + ghec: '*' diff --git a/translations/zh-CN/data/glossaries/README.md b/translations/zh-CN/data/glossaries/README.md index 017e3ed12a..f8be75a360 100644 --- a/translations/zh-CN/data/glossaries/README.md +++ b/translations/zh-CN/data/glossaries/README.md @@ -3,5 +3,6 @@ 下列文件包含我们的 [Crowdin 词汇表](https://support.crowdin.com/glossary/)： * `external.yml` 包含面向客户的词汇条目。 + * Strings within `external.yml` support Liquid conditionals. See [contributing/liquid-helpers.md](/contributing/liquid-helpers.md). * `internal.yml` 包含仅供译员使用的条目。 这些术语显示在 Crowdin UI 中，为译员提供关于所翻译内容的附加上下文信息，以及相应术语的推荐本地化字符串。 * `candidates.yml` 包含可能位于内部或外部词汇表中但尚未定义的术语。 diff --git a/translations/zh-CN/data/learning-tracks/README.md b/translations/zh-CN/data/learning-tracks/README.md index 40a459672c..343e523b2b 100644 --- a/translations/zh-CN/data/learning-tracks/README.md +++ b/translations/zh-CN/data/learning-tracks/README.md @@ -33,7 +33,10 @@ Liquid 条件**不**需要用用于指南的 YAML 文件中的版本控制。 只有适用于当前版本的学习跟踪指南才会自动呈现。 如果没有任何属于当前版本的指南的跟踪，学习跟踪部分将不会呈现。 -还支持在产品的学习跟踪 YML 数据中的明确版本。 例如： +还支持在产品的学习跟踪 YML 数据中的明确版本。 格式和允许值与 [frontmatter 版本属性](/content#versions)相同。 + +例如： + ``` learning_track_name: title: 'Learning track title' @@ -45,6 +48,7 @@ learning_track_name: - /path/to/guide1 - /path/to/guide2 ``` + 如果不包含 `版本` 属性，它假定跟踪在所有版本中可用。 ## 架构执行 diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-0/22.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-0/22.yml index 111914cb46..3474566233 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-0/22.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-0/22.yml @@ -3,6 +3,7 @@ date: '2021-12-13' sections: security_fixes: - '**CRITICAL:** A remote code execution vulnerability in the Log4j library, identified as [CVE-2021-44228](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228), affected all versions of {% data variables.product.prodname_ghe_server %} prior to 3.3.1. The Log4j library is used in an open source service running on the {% data variables.product.prodname_ghe_server %} instance. This vulnerability was fixed in {% data variables.product.prodname_ghe_server %} versions 3.0.22, 3.1.14, 3.2.6, and 3.3.1. For more information, please see [this post](https://github.blog/2021-12-13-githubs-response-to-log4j-vulnerability-cve-2021-44228/) on the GitHub Blog.' + - '**December 17, 2021 update**: The fixes in place for this release also mitigate [CVE-2021-45046](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-45046), which was published after this release. No additional upgrade for {% data variables.product.prodname_ghe_server %} is required to mitigate both CVE-2021-44228 and CVE-2021-45046.' known_issues: - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 上，攻击者可以创建第一个管理员用户。 - 自定义防火墙规则在升级过程中被删除。 diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-1/14.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-1/14.yml index e6c462f3c4..7976fb59e4 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-1/14.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-1/14.yml @@ -3,6 +3,7 @@ date: '2021-12-13' sections: security_fixes: - '**CRITICAL:** A remote code execution vulnerability in the Log4j library, identified as [CVE-2021-44228](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228), affected all versions of {% data variables.product.prodname_ghe_server %} prior to 3.3.1. The Log4j library is used in an open source service running on the {% data variables.product.prodname_ghe_server %} instance. This vulnerability was fixed in {% data variables.product.prodname_ghe_server %} versions 3.0.22, 3.1.14, 3.2.6, and 3.3.1. For more information, please see [this post](https://github.blog/2021-12-13-githubs-response-to-log4j-vulnerability-cve-2021-44228/) on the GitHub Blog.' + - '**December 17, 2021 update**: The fixes in place for this release also mitigate [CVE-2021-45046](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-45046), which was published after this release. No additional upgrade for {% data variables.product.prodname_ghe_server %} is required to mitigate both CVE-2021-44228 and CVE-2021-45046.' known_issues: - '{% data variables.product.prodname_registry %} npm 注册表不再返回元数据响应的时间值。这样做是为了大幅改善性能。作为元数据响应的一部分，我们继续拥有返回时间值所需的所有数据，并将在我们解决现有性能问题后恢复返回这个值。' - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 上，攻击者可以创建第一个管理员用户。 diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-2/6.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-2/6.yml index 119379595b..7cd48b20a1 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-2/6.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-2/6.yml @@ -3,6 +3,7 @@ date: '2021-12-13' sections: security_fixes: - '**CRITICAL:** A remote code execution vulnerability in the Log4j library, identified as [CVE-2021-44228](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228), affected all versions of {% data variables.product.prodname_ghe_server %} prior to 3.3.1. The Log4j library is used in an open source service running on the {% data variables.product.prodname_ghe_server %} instance. This vulnerability was fixed in {% data variables.product.prodname_ghe_server %} versions 3.0.22, 3.1.14, 3.2.6, and 3.3.1. For more information, please see [this post](https://github.blog/2021-12-13-githubs-response-to-log4j-vulnerability-cve-2021-44228/) on the GitHub Blog.' + - '**December 17, 2021 update**: The fixes in place for this release also mitigate [CVE-2021-45046](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-45046), which was published after this release. No additional upgrade for {% data variables.product.prodname_ghe_server %} is required to mitigate both CVE-2021-44228 and CVE-2021-45046.' known_issues: - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 上，攻击者可以创建第一个管理员用户。 - 自定义防火墙规则在升级过程中被删除。 diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-3/1.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-3/1.yml index 9e1fbc6568..79628c93a4 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-3/1.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-3/1.yml @@ -3,6 +3,7 @@ date: '2021-12-13' sections: security_fixes: - '**CRITICAL:** A remote code execution vulnerability in the Log4j library, identified as [CVE-2021-44228](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228), affected all versions of {% data variables.product.prodname_ghe_server %} prior to 3.3.1. The Log4j library is used in an open source service running on the {% data variables.product.prodname_ghe_server %} instance. This vulnerability was fixed in {% data variables.product.prodname_ghe_server %} versions 3.0.22, 3.1.14, 3.2.6, and 3.3.1. For more information, please see [this post](https://github.blog/2021-12-13-githubs-response-to-log4j-vulnerability-cve-2021-44228/) on the GitHub Blog.' + - '**December 17, 2021 update**: The fixes in place for this release also mitigate [CVE-2021-45046](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-45046), which was published after this release. No additional upgrade for {% data variables.product.prodname_ghe_server %} is required to mitigate both CVE-2021-44228 and CVE-2021-45046.' known_issues: - After upgrading to {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_actions %} may fail to start automatically. To resolve this issue, connect to the appliance via SSH and run the `ghe-actions-start` command. - On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user. diff --git a/translations/zh-CN/data/reusables/actions/create-azure-app-plan.md b/translations/zh-CN/data/reusables/actions/create-azure-app-plan.md new file mode 100644 index 0000000000..4d6eedc268 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/create-azure-app-plan.md @@ -0,0 +1,17 @@ +1. 创建 Azure App Service 计划。 + + 例如，可以使用 Azure CLI 创建新的应用服务计划： + + ```bash{:copy} + az appservice plan create \ + --resource-group MY_RESOURCE_GROUP \ + --name MY_APP_SERVICE_PLAN \ + --is-linux + ``` + + 在上述命令中，将 `MY_ResourcesURCE_GROUP` 替换为您原有的 Azure 资源组，`MY_APP_SERVICE_PLAN` 替换为应用服务计划的新名称。 + + 请查看 Azure 文档以了解更多有关使用 [Azure CLI](https://docs.microsoft.com/cli/azure/) 的信息： + + * For authentication, see "[Sign in with Azure CLI](https://docs.microsoft.com/cli/azure/authenticate-azure-cli)." + * 如果需要创建新的资源组，请参阅“[az 组](https://docs.microsoft.com/cli/azure/group?view=azure-cli-latest#az_group_create)”。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/create-azure-publish-profile.md b/translations/zh-CN/data/reusables/actions/create-azure-publish-profile.md new file mode 100644 index 0000000000..a4e77c0c20 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/create-azure-publish-profile.md @@ -0,0 +1,5 @@ +1. 配置 Azure 发布配置文件并创建 `AZURE_WEBAPP_PUBLISH_PROFILE` 机密。 + + 使用发布配置文件生成 Azure 部署凭据。 更多信息请参阅 Azure 文档中的“[生成部署凭据](https://docs.microsoft.com/azure/app-service/deploy-github-actions?tabs=applevel#generate-deployment-credentials)”。 + + 在 {% data variables.product.prodname_dotcom %} 仓库中，创建一个名为 `AZURE_WEBAPP_PUBLISH_PROFILE` 的机密，其中包含发布配置文件的内容。 有关创建机密的更多信息，请参阅“[加密密码](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository)”。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/docs/you-can-read-docs-for-your-product.md b/translations/zh-CN/data/reusables/docs/you-can-read-docs-for-your-product.md new file mode 100644 index 0000000000..8de7a8d98f --- /dev/null +++ b/translations/zh-CN/data/reusables/docs/you-can-read-docs-for-your-product.md @@ -0,0 +1 @@ +You can read documentation that reflects the features available to you on {% data variables.product.product_name %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." diff --git a/translations/zh-CN/data/reusables/enterprise-accounts/dormant-user-activity-threshold.md b/translations/zh-CN/data/reusables/enterprise-accounts/dormant-user-activity-threshold.md index b78499d214..534d9c25e0 100644 --- a/translations/zh-CN/data/reusables/enterprise-accounts/dormant-user-activity-threshold.md +++ b/translations/zh-CN/data/reusables/enterprise-accounts/dormant-user-activity-threshold.md @@ -1 +1 @@ -A user account is considered to be dormant if it has not been active for {% ifversion ghec %}90 days{% else %}at least a month{% endif %}.{% ifversion ghes %} You may choose to suspend dormant users to release user licenses.{% endif %} +{% ifversion not ghec%}By default, a{% else %}A{% endif %} user account is considered to be dormant if it has not been active for 90 days. {% ifversion not ghec %}You can configure the length of time a user must be inactive to be considered dormant{% ifversion ghes%} and choose to suspend dormant users to release user licenses{% endif %}.{% endif %} diff --git a/translations/zh-CN/data/reusables/enterprise_migrations/locking-repositories.md b/translations/zh-CN/data/reusables/enterprise_migrations/locking-repositories.md index 9c4e985a5a..2edf6dfcda 100644 --- a/translations/zh-CN/data/reusables/enterprise_migrations/locking-repositories.md +++ b/translations/zh-CN/data/reusables/enterprise_migrations/locking-repositories.md @@ -1,6 +1,6 @@ {% tip %} -**注意：** 锁定仓库会阻止对仓库的所有读取或写入。 您不能将新团队或协作者与锁定的仓库相关联。 +**Note:** Locking a repository prevents all write access to the repository. 您不能将新团队或协作者与锁定的仓库相关联。 如果您执行的试用版，则无需锁定仓库。 当您从正在使用的仓库迁移数据时， {% data variables.product.company_short %} 强烈建议锁定仓库。 更多信息请参阅“[关于迁移](/enterprise/admin/migrations/about-migrations#types-of-migrations)”。 diff --git a/translations/zh-CN/data/reusables/pages/check-workflow-run.md b/translations/zh-CN/data/reusables/pages/check-workflow-run.md new file mode 100644 index 0000000000..9a20b621d1 --- /dev/null +++ b/translations/zh-CN/data/reusables/pages/check-workflow-run.md @@ -0,0 +1,8 @@ +{% ifversion fpt %} +1. If your {% data variables.product.prodname_pages %} site is built from a public repository, it is built and deployed with a {% data variables.product.prodname_actions %} workflow run unless you've configured your {% data variables.product.prodname_pages %} site to use a different CI tool. For more information about how to view the workflow status, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." + +{% note %} + +{% data reusables.pages.pages-builds-with-github-actions-public-beta %} + +{% endnote %}{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/pages/pages-builds-with-github-actions-public-beta.md b/translations/zh-CN/data/reusables/pages/pages-builds-with-github-actions-public-beta.md new file mode 100644 index 0000000000..68073a7756 --- /dev/null +++ b/translations/zh-CN/data/reusables/pages/pages-builds-with-github-actions-public-beta.md @@ -0,0 +1,5 @@ +{% ifversion fpt %} + +**Note:** {% data variables.product.prodname_actions %} workflow runs for your {% data variables.product.prodname_pages %} sites are in public beta for public repositories and subject to change. {% data variables.product.prodname_actions %} workflow runs are free for public repositories. + +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/pages/twenty-minutes-to-publish.md b/translations/zh-CN/data/reusables/pages/twenty-minutes-to-publish.md index 44de95938b..60b5541d26 100644 --- a/translations/zh-CN/data/reusables/pages/twenty-minutes-to-publish.md +++ b/translations/zh-CN/data/reusables/pages/twenty-minutes-to-publish.md @@ -1 +1 @@ -**注：**对站点的更改在推送到 {% data variables.product.product_name %} 后，最长可能需要 20 分钟才会发布。 如果一小时后仍然在浏览器中看不到您的更改，请参阅“[关于 {% data variables.product.prodname_pages %} 站点的 Jekyll 构建错误](/articles/about-jekyll-build-errors-for-github-pages-sites)”。 +**注：**对站点的更改在推送到 {% data variables.product.product_name %} 后，最长可能需要 10 分钟才会发布。 If your don't see your {% data variables.product.prodname_pages %} site changes reflected in your browser after an hour, see "[About Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/about-jekyll-build-errors-for-github-pages-sites)." \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/saml/saml-accounts.md b/translations/zh-CN/data/reusables/saml/saml-accounts.md index 5a939dfc7d..e03c7fce45 100644 --- a/translations/zh-CN/data/reusables/saml/saml-accounts.md +++ b/translations/zh-CN/data/reusables/saml/saml-accounts.md @@ -1 +1,7 @@ -If you configure SAML SSO, members of your organization will continue to log into their user accounts on {% data variables.product.prodname_dotcom_the_website %}. 当成员访问组织内使用 SAML SSO 的资源时，{% data variables.product.prodname_dotcom %} 会将该成员重定向到 IdP 进行身份验证。 身份验证成功后，IdP 将该成员重定向回 {% data variables.product.prodname_dotcom %}，然后成员可以访问组织的资源。 +If you configure SAML SSO, members of your organization will continue to log into their user accounts on {% data variables.product.prodname_dotcom_the_website %}. When a member accesses non-public resources within your organization that uses SAML SSO, {% data variables.product.prodname_dotcom %} redirects the member to your IdP to authenticate. 身份验证成功后，IdP 将该成员重定向回 {% data variables.product.prodname_dotcom %}，然后成员可以访问组织的资源。 + +{% note %} + +**Note:** Organization members can perform read operations such as viewing, cloning, and forking on public resources owned by your organization even without a valid SAML session. + +{% endnote %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/secret-scanning/partner-secret-list-private-repo.md b/translations/zh-CN/data/reusables/secret-scanning/partner-secret-list-private-repo.md index 01efffa0b8..99bbe9a4e2 100644 --- a/translations/zh-CN/data/reusables/secret-scanning/partner-secret-list-private-repo.md +++ b/translations/zh-CN/data/reusables/secret-scanning/partner-secret-list-private-repo.md @@ -18,6 +18,8 @@ Asana | Asana Personal Access Token | asana_personal_access_token{% endif %} Atl {%- ifversion fpt or ghec or ghes > 3.1 or ghae %} Atlassian | Bitbucket Server Personal Access Token | bitbucket_server_personal_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.3 %} +Azure | Azure Active Directory Application Secret | azure_active_directory_application_secret{% endif %} +{%- ifversion fpt or ghec or ghes > 3.3 %} Azure | Azure Cache for Redis Access Key | azure_cache_for_redis_access_key{% endif %} Azure | Azure DevOps Personal Access Token | azure_devops_personal_access_token Azure | Azure SAS Token | azure_sas_token Azure | Azure Service Management Certificate | azure_management_certificate {%- ifversion ghes < 3.4 or ghae or ghae-issue-5342 %} Azure | Azure SQL Connection String | azure_sql_connection_string{% endif %} Azure | Azure Storage Account Key | azure_storage_account_key diff --git a/translations/zh-CN/data/ui.yml b/translations/zh-CN/data/ui.yml index caf2d95311..2c3a3c4a04 100644 --- a/translations/zh-CN/data/ui.yml +++ b/translations/zh-CN/data/ui.yml @@ -29,6 +29,7 @@ toc: popular: 热门 guides: 指南 whats_new: 新增内容 + videos: 视频 pages: article_version: '文章版本' miniToc: 本文内容 diff --git a/translations/zh-CN/data/variables/product.yml b/translations/zh-CN/data/variables/product.yml index da55e25743..5300bf579c 100644 --- a/translations/zh-CN/data/variables/product.yml +++ b/translations/zh-CN/data/variables/product.yml @@ -17,6 +17,7 @@ prodname_ghe_server: 'GitHub Enterprise Server' prodname_ghe_cloud: 'GitHub Enterprise Cloud' prodname_ghe_managed: 'GitHub AE' prodname_ghe_one: 'GitHub One' +prodname_docs: 'GitHub Docs' ## Use these variables when referring specifically to a location within a product product_location: >- {% ifversion ghes %}your GitHub Enterprise Server instance{% elsif ghae %}your enterprise{% else %}GitHub.com{% endif %} @@ -182,7 +183,7 @@ api_url_code: >- {% ifversion fpt or ghec %}https://api.github.com{% elsif ghes %}http(s)://[hostname]/api/v3{% elsif ghae %}https://[hostname]/api/v3{% endif %} #Use this inside command-line code blocks graphql_url_pre: >- - {% ifversion fpt or ghec %}https://api.github.com/graphql{% elsif ghes %}http(s)://[hostname]/api/graphql{% elsif ghae %}https://api.[hostname]/graphql{% endif %} + {% ifversion fpt or ghec %}https://api.github.com/graphql{% elsif ghes %}http(s)://[hostname]/api/graphql{% elsif ghae %}https://[hostname]/api/graphql{% endif %} #Use this all other code blocks graphql_url_code: >- - {% ifversion fpt or ghec %}https://api.github.com/graphql{% elsif ghes %}http(s)://[hostname]/api/graphql{% elsif ghae %}https://api.[hostname]/graphql{% endif %} + {% ifversion fpt or ghec %}https://api.github.com/graphql{% elsif ghes %}http(s)://[hostname]/api/graphql{% elsif ghae %}https://[hostname]/api/graphql{% endif %}