Size: a a a

DocOps-сообщество

2017 November 27

NV

Nick Volynkin in DocOps-сообщество
Теперь использую термин “docs as code” вместо “docs like code”, потому что: 1) более распространен такой вариант 2) согласуется с “infrastructure as code” и прочими «всё что угодно — это код» 3) так нет коллизии с книгой под названием “Docs Like Code” автора Anne Gentle (docslikecode.com)
источник

NV

Nick Volynkin in DocOps-сообщество
Здесь будут ссылки на статьи, инструменты, события и прочее: https://telegram.me/docs_as_code
источник

NV

Nick Volynkin in DocOps-сообщество
Денис, на мастерклассе мы делали себе форки репозитория https://gitlab.com/nick.volynkin/sample-homepage и пробовали в них что-нибудь поредактировать и посмотреть на результат.
источник

NV

Nick Volynkin in DocOps-сообщество
После первого сохраненного изменения результат будет опубликован на ваша-учётная-запись.gitlab.io/sample-homepage
источник

ДС

Денис Старков in DocOps-сообщество
Nick Volynkin
Денис, на мастерклассе мы делали себе форки репозитория https://gitlab.com/nick.volynkin/sample-homepage и пробовали в них что-нибудь поредактировать и посмотреть на результат.
Спасибо! Попробую
источник

AG

Alexandra Grigorenko in DocOps-сообщество
Добрый вечер. У меня тут возник такой вопрос: есть ли возможность в reStructuredText или в Markdown сделать свой тип нумерованного списка? Т.е., например, мне нужно каждое требование нумеровать "R001, R002, R003 и т.д.". Можно ли задать именно такой формат?

И еще, есть ли редакторы, где работа со строками похожа на excel-формат, т.е. если внезапно надо вставить требование в середине текста, не нужно все требования выделять, сдвигать, что-то там колдовать (как в гуглодоке), а можно просто выделить и сдвинуть на 1-2-3 строки вниз, как в excel'e?
источник

NV

Nick Volynkin in DocOps-сообщество
Про списки: думаю, можно это сделать с помощью CSS.
источник

L

Lana in DocOps-сообщество
Alexandra Grigorenko
Добрый вечер. У меня тут возник такой вопрос: есть ли возможность в reStructuredText или в Markdown сделать свой тип нумерованного списка? Т.е., например, мне нужно каждое требование нумеровать "R001, R002, R003 и т.д.". Можно ли задать именно такой формат?

И еще, есть ли редакторы, где работа со строками похожа на excel-формат, т.е. если внезапно надо вставить требование в середине текста, не нужно все требования выделять, сдвигать, что-то там колдовать (как в гуглодоке), а можно просто выделить и сдвинуть на 1-2-3 строки вниз, как в excel'e?
по первому, насколько мне известно в чистом RST без расширения с помощью стилей -  нет - они понимает много форматов нумерации, например, буквы заглавные и строчные, цифры, римские цифры, отделенные скобкой, точкой, выделенные скобками.

по второму, а в чем трудность просто вставить новое в нужное место, CTRL-C - CTRL-V, или предполагается работа в таблице с ними?
источник

NV

Nick Volynkin in DocOps-сообщество
Но если вы поставите требование между R001 и R002, то нумерация сдвинется. Непонятно, что делать со ссылками.
источник

AG

Alexandra Grigorenko in DocOps-сообщество
В excele можно ссылаться на конкретное значение ячейки, и ссылка сдвигается вместе с ней. Просто там не очень удобно делать сцепку строк с последующим копирование в гуглодоку %)
источник

L

Lana in DocOps-сообщество
Можно попробовать с автонумерацией и ее расширением поиграть, которая #.
источник

NV

Nick Volynkin in DocOps-сообщество
А, мы об одном и том же говорим, просто разными словами. )
источник

AG

Alexandra Grigorenko in DocOps-сообщество
Lana
по первому, насколько мне известно в чистом RST без расширения с помощью стилей -  нет - они понимает много форматов нумерации, например, буквы заглавные и строчные, цифры, римские цифры, отделенные скобкой, точкой, выделенные скобками.

по второму, а в чем трудность просто вставить новое в нужное место, CTRL-C - CTRL-V, или предполагается работа в таблице с ними?
Там не совсем ctrl-c ctrl-v. Если мне надо поставить новое требование между R123 и R124, а впереди еще штук 200 требований, то как тогда? Надо каждое перемещать в новый номер, т.е. R124 в R125, R125 в R126 и т.д.
источник

NV

Nick Volynkin in DocOps-сообщество
В rST можно написать небольшое расширение и добавить директиву, например:
```
.. requirement:: r001
 
  Do X
```
источник

AG

Alexandra Grigorenko in DocOps-сообщество
Пробовала играться с #, но он меня не понимать)
источник

NV

Nick Volynkin in DocOps-сообщество
Не, это наивная автонумерация, в ней нельзя ссылаться на фиксированный пункт списка.
источник

NV

Nick Volynkin in DocOps-сообщество
Если без кода, можно ставить якоря и ссылаться на них
источник

AG

Alexandra Grigorenko in DocOps-сообщество
А по поводу вставки нового пункта в середину можете посоветовать что-нибудь? На самом деле даже ссылки не проблема, проблема именно в переносе нумерации и каждого требования.
источник

L

Lana in DocOps-сообщество
Alexandra Grigorenko
Пробовала играться с #, но он меня не понимать)
ему надо задавать первое значение, чтобы он что-то понимал, это я про автонумерацию, но не уверена, что он поддержит R001
источник

NV

Nick Volynkin in DocOps-сообщество
Нужно как-то ссылаться не по номеру, потому что номер присваивается автоматически.
источник