Size: a a a

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

2019 July 27

V

Vanger in DocOps-сообщество
да пост хороший, но мне пришлось рихтовать.
источник

iv

iakov v in DocOps-сообщество
строго говоря, вопрос в голосовании поставлен некорректно. под кодом мы обычно понимаем код программы как отдельной цельной сущности, а не последовательность команд в CLI. поэтому да, в коде на bash знак # в начале строки значит комментарий, а в приглашении — права супер-пользователя. А первый вариант без каких-либо знаков вообще иезуитский
источник

V

Vanger in DocOps-сообщество
у меня не ретина
источник

iv

iakov v in DocOps-сообщество
ну и ещё тот момент, что в коде мы сами вводим #, а приглашение — это интерпретатор нам показывает
источник

NV

Nick Volynkin in DocOps-сообщество
iakov v
строго говоря, вопрос в голосовании поставлен некорректно. под кодом мы обычно понимаем код программы как отдельной цельной сущности, а не последовательность команд в CLI. поэтому да, в коде на bash знак # в начале строки значит комментарий, а в приглашении — права супер-пользователя. А первый вариант без каких-либо знаков вообще иезуитский
Ну а программы на баше чем отличаются от последовательности команд в CLI? Можно взять команду из документации, вставить в консоль и сразу выполнить, а можно в файл .sh и выполнить потом.
источник

NV

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

NV

Nick Volynkin in DocOps-сообщество
Может быть, он плейбук для Ansible пишет, у него там вообще нет рута, а есть become: yes.
источник

NV

Nick Volynkin in DocOps-сообщество
Похоже, что мы хотим сообщить читателю, какие права нужны для запуска, но вместо этого сообщаем, под каким пользователем выполнять. Строго говоря, это не одно и то же.
источник

iv

iakov v in DocOps-сообщество
ну просто приведённые варианты могут по-разному интерпретироваться читателем, в зависимости от того, это кусок листинга или скриншот CLI. Поэтому слово "код", уводящее в сторону именно "код программы", даёт одну из этих интерпретаций, но привычнее такие вещи считываются именно как CLI, то есть # это приглашение, а не комментарий
источник

NV

Nick Volynkin in DocOps-сообщество
Добавлю немного контекста. Документируемое приложение в основном будет запускаться на CI-сервере, автоматически.
источник

iv

iakov v in DocOps-сообщество
Nick Volynkin
Может быть, он плейбук для Ansible пишет, у него там вообще нет рута, а есть become: yes.
пример кода для Ansible выглядит совсем не так; из приведённых вариантов совершенно очевидно, что это не Ansible
источник

NV

Nick Volynkin in DocOps-сообщество
Т.е. пока разработчик изучает инструмент, он будет запускать команды из консоли, но в итоговой реализации их будет выполнять какой-нибудь Jenkins, и с большой вероятностью он будет делать это в докер-контейнере.
источник

NV

Nick Volynkin in DocOps-сообщество
iakov v
пример кода для Ansible выглядит совсем не так; из приведённых вариантов совершенно очевидно, что это не Ansible
Да, но можно ведь завернуть в ансибл )
источник

iv

iakov v in DocOps-сообщество
ну вам же зачем-то такая строка в документации понадобилась. она отражает именно действия человека с консолью?
источник

iv

iakov v in DocOps-сообщество
в случае с докером/дженкинсом вообще не будет ситуации bash prompt. так что если вы изображаете prompt, стало быть, контекст тут — консоль
источник

NV

Nick Volynkin in DocOps-сообщество
iakov v
в случае с докером/дженкинсом вообще не будет ситуации bash prompt. так что если вы изображаете prompt, стало быть, контекст тут — консоль
bash prompt не будет, будет неинтерактивная среда. Но команда-то останется такой же.
источник

iv

iakov v in DocOps-сообщество
а первоначальное мое замечание касалось того, что действительно символ # может интерпретироваться читателем документа двояко: как указатель на то, что мы работаем в консоли с супер-правами, и как на фрагмент кода скрипта
источник

NV

Nick Volynkin in DocOps-сообщество
iakov v
а первоначальное мое замечание касалось того, что действительно символ # может интерпретироваться читателем документа двояко: как указатель на то, что мы работаем в консоли с супер-правами, и как на фрагмент кода скрипта
с этим полностью согласен и это меня в том числе беспокоит
источник

iv

iakov v in DocOps-сообщество
Nick Volynkin
bash prompt не будет, будет неинтерактивная среда. Но команда-то останется такой же.
команда да, а приглашения не будет. вопрос же про самый первый символ в приведённых строках
источник

NV

Nick Volynkin in DocOps-сообщество
Ну и ещё всякие инструменты для подсветки кода раскрашивают такую строку как комментарий. :)
источник