ΠΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΡ Yandex Cloud
ΠΡΠΈΠ²Π΅ΡΡΡΠ²ΡΠ΅ΠΌ Π² ΡΠ΅ΠΏΠΎΠ·ΠΈΡΠΎΡΠΈΠΈ yandex-cloud/docs. ΠΠ΄Π΅ΡΡ Π²Ρ ΠΌΠΎΠΆΠ΅ΡΠ΅ ΠΏΡΠ΅Π΄Π»ΠΎΠΆΠΈΡΡ Π΄ΠΎΠΏΠΎΠ»Π½Π΅Π½ΠΈΡ ΠΈ ΠΏΡΠ°Π²ΠΊΠΈ Π΄Π»Ρ Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΠΈ Yandex Cloud ΠΈΠ»ΠΈ ΡΠ΄Π΅Π»Π°ΡΡ ΠΈΡ ΡΠ°ΠΌΠΎΡΡΠΎΡΡΠ΅Π»ΡΠ½ΠΎ ΠΈ ΠΏΠΎΠ»ΡΡΠΈΡΡ Π³ΡΠ°Π½Ρ Π² ΡΠ°ΠΌΠΊΠ°Ρ ΠΊΠΎΠ½ΡΠ΅Π½Ρ-ΠΏΡΠΎΠ³ΡΠ°ΠΌΠΌΡ.
ΠΡΠ΅Π΄Π»ΠΎΠΆΠΈΡΡ ΠΏΡΠ°Π²ΠΊΠΈ
ΠΡΠΊΡΠΎΠΉΡΠ΅ Issue ΠΈ Π½Π°ΠΏΠΈΡΠΈΡΠ΅ ΡΠ²ΠΎΠΈ Π·Π°ΠΌΠ΅ΡΠ°Π½ΠΈΡ ΠΈ ΠΏΡΠ΅Π΄Π»ΠΎΠΆΠ΅Π½ΠΈΡ ΡΠ°ΠΌ. ΠΡ Π²Π΅ΡΠ½Π΅ΠΌΡΡ Ρ ΠΎΡΠ²Π΅ΡΠΎΠΌ. ΠΡΠ»ΠΈ Π²Π°ΠΌ ΡΡΠ΅Π±ΡΠ΅ΡΡΡ ΠΏΠΎΠΌΠΎΡΡ Π² ΡΠ°Π±ΠΎΡΠ΅ Ρ ΠΎΠ±Π»Π°ΠΊΠΎΠΌ, ΠΎΠ±ΡΠ°ΡΠΈΡΠ΅ΡΡ Π² ΡΠ΅Ρ Π½ΠΈΡΠ΅ΡΠΊΡΡ ΠΏΠΎΠ΄Π΄Π΅ΡΠΆΠΊΡ.
ΠΠΎΡΡΠ°ΡΡΠ²ΡΠΉΡΠ΅ Π² ΠΊΠΎΠ½ΡΠ΅Π½Ρ-ΠΏΡΠΎΠ³ΡΠ°ΠΌΠΌΠ΅
ΠΠΎΠ½ΡΠ΅Π½Ρ-ΠΏΡΠΎΠ³ΡΠ°ΠΌΠΌΠ° Yandex Cloud ΠΏΠΎΠ·Π²ΠΎΠ»ΡΠ΅Ρ Π²Π°ΠΌ ΡΠ°ΠΌΠΈΠΌ Π½Π°ΠΏΠΈΡΠ°ΡΡ Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΡ ΠΈ ΠΏΠΎΠ»ΡΡΠΈΡΡ Π·Π° Π½Π΅Π΅ Π³ΡΠ°Π½Ρ Π½Π° Π²Π°Ρ ΠΏΠ»Π°ΡΠ΅ΠΆΠ½ΡΠΉ Π°ΠΊΠΊΠ°ΡΠ½Ρ. ΠΠΎΡΡΠ°ΡΡΠ²ΠΎΠ²Π°ΡΡ Π² ΠΊΠΎΠ½ΡΠ΅Π½Ρ-ΠΏΡΠΎΠ³ΡΠ°ΠΌΠΌΠ΅ ΠΌΠΎΠΆΠ½ΠΎ Π΄Π²ΡΠΌΡ ΡΠΏΠΎΡΠΎΠ±Π°ΠΌΠΈ:
- ΠΡΠ»ΠΈ Π²Ρ Π·Π°ΠΌΠ΅ΡΠΈΠ»ΠΈ ΠΎΠΏΠ΅ΡΠ°ΡΠΊΡ ΠΈΠ»ΠΈ Ρ Π²Π°Ρ Π΅ΡΡΡ Π½Π΅Π±ΠΎΠ»ΡΡΠ°Ρ ΠΏΡΠ°Π²ΠΊΠ°, ΡΠ΄Π΅Π»Π°ΠΉΡΠ΅ PR. Π’Π°ΠΊΠΈΠ΅ ΠΏΡΠ°Π²ΠΊΠΈ ΠΌΡ ΡΠ°ΡΡΠΌΠ°ΡΡΠΈΠ²Π°Π΅ΠΌ Π±ΡΡΡΡΠΎ ΠΈ ΠΎΠ±ΡΡΠ½ΠΎ ΠΎΠ½ΠΈ Π½Π΅ ΡΡΠ΅Π±ΡΡΡ ΠΎΠ±ΡΡΠΆΠ΄Π΅Π½ΠΈΡ.
- ΠΡΠ»ΠΈ Π²Ρ Ρ ΠΎΡΠΈΡΠ΅ Π½Π°ΠΏΠΈΡΠ°ΡΡ Π±ΠΎΠ»ΡΡΠΎΠΉ ΡΠ΅ΠΊΡΡ, ΠΏΠΎΡΠ°Π³ΠΎΠ²ΠΎΠ΅ ΡΡΠΊΠΎΠ²ΠΎΠ΄ΡΡΠ²ΠΎ ΠΈΠ»ΠΈ Π²Π½Π΅ΡΡΠΈ ΠΊΡΡΠΏΠ½ΡΠ΅ ΡΠΌΡΡΠ»ΠΎΠ²ΡΠ΅ ΠΏΡΠ°Π²ΠΊΠΈ, ΠΎΡΠΊΡΠΎΠΉΡΠ΅ Issue ΠΈ ΡΠ°ΡΡΠΊΠ°ΠΆΠΈΡΠ΅, ΠΎ ΡΠ΅ΠΌ Π²Ρ Ρ ΠΎΡΠΈΡΠ΅ Π½Π°ΠΏΠΈΡΠ°ΡΡ. ΠΠ΅ Π½ΡΠΆΠ½ΠΎ ΡΡΠ°Π·Ρ ΠΏΡΠΈΠ½ΠΎΡΠΈΡΡ Π±ΠΎΠ»ΡΡΠΎΠΉ PR: Π΄Π°Π²Π°ΠΉΡΠ΅ ΡΠ½Π°ΡΠ°Π»Π° ΠΎΠ±ΡΡΠ΄ΠΈΠΌ Π²Π°ΡΠΈ ΠΈΠ΄Π΅ΠΈ ΠΈ Π²ΠΌΠ΅ΡΡΠ΅ ΡΠ΅ΡΠΈΠΌ, ΠΊΠ°ΠΊ Π΄Π΅ΠΉΡΡΠ²ΠΎΠ²Π°ΡΡ Π΄Π°Π»ΡΡΠ΅.
ΠΡ ΠΏΡΠΈΠ½ΠΈΠΌΠ°Π΅ΠΌ ΠΏΡΠ°Π²ΠΊΠΈ Π²ΠΎ Π²ΡΠ΅ Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΡ, ΠΊΡΠΎΠΌΠ΅ ΡΠΏΡΠ°Π²ΠΎΡΠ½ΠΈΠΊΠΎΠ² API ΠΈ CLI. ΠΠ±ΡΠ°ΡΠΈΡΠ΅ Π²Π½ΠΈΠΌΠ°Π½ΠΈΠ΅ Π½Π° ΡΠΏΠΈΡΠΎΠΊ Π²Π°ΠΆΠ½ΡΡ ΡΠ΅ΠΌ β Π·Π° Π½ΠΈΡ ΠΌΡ Π½Π°ΡΠΈΡΠ»ΡΠ΅ΠΌ ΠΏΠΎΠ²ΡΡΠ΅Π½Π½ΡΠ΅ Π³ΡΠ°Π½ΡΡ.
Π§ΡΠΎΠ±Ρ ΠΌΡ Π·Π½Π°Π»ΠΈ, ΠΊΡΠ΄Π° Π·Π°ΡΠΈΡΠ»ΠΈΡΡ Π³ΡΠ°Π½Ρ, ΠΎΠ±ΡΠ·Π°ΡΠ΅Π»ΡΠ½ΠΎ ΡΠΊΠ°ΠΆΠΈΡΠ΅ ΠΈΠ΄Π΅Π½ΡΠΈΡΠΈΠΊΠ°ΡΠΎΡ Π²Π°ΡΠ΅Π³ΠΎ ΠΏΠ»Π°ΡΠ΅ΠΆΠ½ΠΎΠ³ΠΎ Π°ΠΊΠΊΠ°ΡΠ½ΡΠ° Π² Issue ΠΈΠ»ΠΈ PR.
ΠΡΠΎ Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΡ
ΠΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΡ ΡΠ°Π·ΡΠ°Π±ΠΎΡΠ°Π½Π° Ρ ΠΈΡΠΏΠΎΠ»ΡΠ·ΠΎΠ²Π°Π½ΠΈΠ΅ΠΌ ΡΠΈΠ½ΡΠ°ΠΊΡΠΈΡΠ° Yandex Flavored Markdown.
ΠΠ°ΠΊ ΠΏΡΠ΅Π΄Π»ΠΎΠΆΠΈΡΡ ΠΏΡΠ°Π²ΠΊΠΈ
Π§ΡΠΎΠ±Ρ ΠΏΡΠ΅Π΄Π»ΠΎΠΆΠΈΡΡ ΠΏΡΠ°Π²ΠΊΠΈ, Π²Ρ Π΄ΠΎΠ»ΠΆΠ½Ρ ΠΏΡΠΎΡΠΈΡΠ°ΡΡ Β«ΠΠΈΡΠ΅Π½Π·ΠΈΠΎΠ½Π½ΠΎΠ΅ Π‘ΠΎΠ³Π»Π°ΡΠ΅Π½ΠΈΠ΅ Π―Π½Π΄Π΅ΠΊΡΠ° Ρ ΠΠΎΠ½ΡΡΠΈΠ±ΡΡΡΠΎΡΠΎΠΌΒ» ΠΈ ΠΏΠΎΠ΄ΡΠ²Π΅ΡΠ΄ΠΈΡΡ ΡΠ²ΠΎΠ΅ ΡΠΎΠ³Π»Π°ΡΠΈΠ΅ Ρ Π΅Π³ΠΎ ΡΡΠ»ΠΎΠ²ΠΈΡΠΌΠΈ. ΠΠΎΠ΄ΡΠΎΠ±Π½Π°Ρ ΠΈΠ½ΡΠΎΡΠΌΠ°ΡΠΈΡ ΠΎ ΡΠΎΠΌ, ΠΊΠ°ΠΊ ΡΡΠΎ ΡΠ΄Π΅Π»Π°ΡΡ, ΠΈ ΡΡΡΠ»ΠΊΠΈ Π½Π° ΡΠ΅ΠΊΡΡ Π‘ΠΎΠ³Π»Π°ΡΠ΅Π½ΠΈΡ ΠΏΡΠΈΠ²Π΅Π΄Π΅Π½Ρ Π² ΡΠ°ΠΉΠ»Π΅ CONTRIBUTING.md.
ΠΡΠ»ΠΈ Π²Ρ Π·Π°ΠΌΠ΅ΡΠΈΠ»ΠΈ ΠΎΠΏΠ΅ΡΠ°ΡΠΊΡ ΠΈΠ»ΠΈ ΠΎΡΠΈΠ±ΠΊΡ Π² Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΠΈ ΠΈΠ»ΠΈ Ρ ΠΎΡΠΈΡΠ΅ Π΄ΠΎΠΏΠΎΠ»Π½ΠΈΡΡ ΠΊΠ°ΠΊΠΎΠΉ-ΡΠΎ ΡΠ°Π·Π΄Π΅Π», ΡΠΎΠ·Π΄Π°ΠΉΡΠ΅ pull request (PR) Ρ ΠΏΡΠ°Π²ΠΊΠ°ΠΌΠΈ ΡΠ΅ΡΠ΅Π· GitHub.
ΠΠ°ΠΊ ΡΠΎΠ±ΡΠ°ΡΡ Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΡ Π»ΠΎΠΊΠ°Π»ΡΠ½ΠΎ
ΠΠ΅ΡΠ΅Π΄ ΡΠ΅ΠΌ ΡΠ°ΠΊ ΡΠΎΠ·Π΄Π°Π²Π°ΡΡ pull request, ΡΠ΄ΠΎΠ±Π½ΠΎ ΡΠΎΠ±ΡΠ°ΡΡ Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΡ Π»ΠΎΠΊΠ°Π»ΡΠ½ΠΎ ΠΈ ΠΏΠΎΡΠΌΠΎΡΡΠ΅ΡΡ Π½Π° Π½Π΅Π΅ Π²ΠΆΠΈΠ²ΡΡ. ΠΠ»Ρ ΡΡΠΎΠ³ΠΎ ΠΈΡΠΏΠΎΠ»ΡΠ·ΡΠ΅ΡΡΡ ΠΈΠ½ΡΡΡΡΠΌΠ΅Π½Ρ yfm-docs.
-
Π£ΡΡΠ°Π½ΠΎΠ²ΠΈΡΠ΅ yfm-docs:
npm i @doc-tools/docs -g
Π§ΡΠΎΠ±Ρ ΠΎΠ±Π½ΠΎΠ²ΠΈΡΡ Π²Π΅ΡΡΠΈΡ yfm-docs, ΠΈΡΠΏΠΎΠ»ΡΠ·ΡΠΉΡΠ΅ ΡΡΡ ΠΆΠ΅ ΠΊΠΎΠΌΠ°Π½Π΄Ρ.
-
Π‘ΠΎΠ±Π΅ΡΠΈΡΠ΅ Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΡ:
yfm -i docs -o docs-gen
, Π³Π΄Π΅docs
β ΠΊΠ°ΡΠ°Π»ΠΎΠ³ Ρ ΠΈΡΡ ΠΎΠ΄Π½ΡΠΌΠΈ ΡΠ΅ΠΊΡΡΠ°ΠΌΠΈ, Π°docs-gen
β ΠΊΠ°ΡΠ°Π»ΠΎΠ³, Π² ΠΊΠΎΡΠΎΡΠΎΠΌ Π±ΡΠ΄Π΅Ρ Π½Π°Ρ ΠΎΠ΄ΠΈΡΡΡΡ ΡΠ³Π΅Π½Π΅ΡΠΈΡΠΎΠ²Π°Π½Π½Π°Ρ Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΡ.
ΠΠΈΡΠ΅Π½Π·ΠΈΠΈ
Β© YANDEX LLC, 2018. Licensed under Creative Commons Attribution 4.0 International Public License. See LICENSE file for more details.