Git Product home page Git Product logo

docs's Introduction

Документация Yandex.Cloud

Добро пожаловать в репозиторий документации Yandex.Cloud.

Про документацию

Документация разработана с использованием Yandex Flavored Markdown. Подробнее про синтаксис.

Как предложить правки

Чтобы предложить правки, вы должны прочитать «Лицензионное Соглашение Яндекса с Контрибьютором» и подтвердить свое согласие с его условиями. Подробная информация о том, как это сделать, и ссылки на текст Соглашения приведены в файле CONTRIBUTING.md.

Если вы заметили опечатку или ошибку в документации или хотите дополнить какой-то раздел, создайте pull request (PR) с правками через GitHub.

Как собрать документацию локально

Перед тем так создавать pull request, удобно собрать документацию локально и посмотреть на нее вживую. Для этого используется инструмент yfm-docs.

  1. Установите yfm-docs:

    npm i @doc-tools/docs

    Чтобы обновить версию yfm-docs, используйте эту же команду.

  2. Соберите документацию:

    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.

docs's People

Contributors

1844144 avatar alex-vlasov-l1 avatar alexanderkhaustov avatar alexv-smirnov avatar amatol avatar andgein avatar antonydevanchi avatar artyrian avatar aygiz avatar burashka avatar chaos-adept avatar cloud-docs-writer avatar gennadyspb avatar h0t0sh0 avatar jokero avatar llelik8 avatar migs911 avatar peter-idea avatar peter-volkov avatar serjkanunnikov avatar skrashevich avatar sychevigor avatar valenzione avatar vasilymagay avatar vbelov avatar velkerr avatar vitalets avatar vkobozev avatar yurmischenkov avatar zolotukhinsergey avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.