/vanessa-services

документация по Vanessa Stack

OtherNOASSERTION

Что это за репозиторий

Этот репозиторий содержит документацию для Open Source продуктов Vanessa Stack, а также позволяет её поддерживать в актуальном состоянии.

Что такое Vanessa Stack

  • это комплект инструментов для организации процесса разработки на 1С
  • состоит из некоторого количества внешних обработок на языке 1C (BSL) и скриптов на языке OScript (OS)
  • комплект обработок и скриптов размещен в следующих организациях

SilverBulleters, LLC Vanessa Dockers

Однако нельзя забывать про:

однако в рамках данного репозитория обсуждение и документирование указанных коллег не проводится.

Коллективное накопление документации

  • Форкайте, обновляйте и присылайте ваши изменения через концепцию pull request's. Любое, даже самое маленькое, изменение приветствуется.
  • Все изменения автоматически обновляются на основном сайте Vanessa Services

Как это работает

Наш сервер документации автоматически проверяет все обновления и публикует всегда самую последнюю версию документации.

Форматирование

Документация использует классический Синтаксис Markdown. Пожалуйста, присылайте ваши изменения именно в этом формате.

Редактирование

советуем использовать:

  • GitHub редактирование в онлайне, для быстрых изменений
  • Visual Studio Code, Sublime или Atom - для редактирования локальной копии документации
    • с раширениями для работы с Markdown

процесс редактирования

  • fork - создание своей версии и её редактирование
  • push - помещение изменений в свою версию
  • pull request - предложение поместить свою версию изменений в центральных репозиторий

Дополнительный кейс для активных контрибьюторов

не надо убивать зайцев, зайцы должны пожирать друг-друга (с)

  • расширяя документацию фиксируйте шаги необходимых операций в Markdown
  • полученный сценарий используйте как сценарий видеоролика
  • откройте любимую вами программу для screencast'ов (uvScreenCamera, OBS или любую другую) и запишите видеоролик по вашим изменениям
  • просмотрите видеоролик в полноэкранном режиме, для каждого пункта документации делайте скриншоты экрана (мы рекомендуем Yandex Screenshot's), обрежьте картинку и добавьте "стрелочек" и "выделений"
  • вставьте скриншоты в документацию
  • опубликуйте видеоролик на YouTube
  • добавьте ссылку на видеоролик в конец страницы документации

указанный видеоролик будет автоматически добавлен в канал SilverBulleter's со ссылкой на Вас как на автора. все активные пользователи Vanessa Stack получат оповещение о расширении документации и появлении видеоролика

Лицензия

Этот проект выпущен под лицензией "New BSB v3". Ознакомьтесь в файле LICENSE с её полным текстом.

![ZenHub] (https://raw.githubusercontent.com/ZenHubIO/support/master/zenhub-badge.png)