Size: a a a

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

2020 March 02

TZ

Timofey Zakrevskiy in DocOps-сообщество
Зачем читать Фихтенгольца и зачем читать комментарии преподавателя к письменной домашке, если на контрольной можно списать решение с телефона? Зачем читать ошибки компилятора и мануалы к языку, если можно скопипастить решение с SO? Создатели того же Rust или Elm уже не знают, как поближе к программисту принести объяснение ошибки, но сдаётся мне, это не сильно изменит ситуацию. /rant mode off.
источник
2020 March 03

ML

Maksim Lapshin in DocOps-сообщество
Timofey Zakrevskiy
Зачем читать Фихтенгольца и зачем читать комментарии преподавателя к письменной домашке, если на контрольной можно списать решение с телефона? Зачем читать ошибки компилятора и мануалы к языку, если можно скопипастить решение с SO? Создатели того же Rust или Elm уже не знают, как поближе к программисту принести объяснение ошибки, но сдаётся мне, это не сильно изменит ситуацию. /rant mode off.
В ваших словах звучит неуместный снобизм и вы видимо не очень понимаете проблематику ошибок приведения типов в расте
источник

NV

Nick Volynkin in DocOps-сообщество
Timofey Zakrevskiy
Зачем читать Фихтенгольца и зачем читать комментарии преподавателя к письменной домашке, если на контрольной можно списать решение с телефона? Зачем читать ошибки компилятора и мануалы к языку, если можно скопипастить решение с SO? Создатели того же Rust или Elm уже не знают, как поближе к программисту принести объяснение ошибки, но сдаётся мне, это не сильно изменит ситуацию. /rant mode off.
Когда я перешёл с C#/Java, где статическая типизация, на Python с динамической, мне было ооочень больно от того, что среда разработки больше не показывает мне документацию прямо под курсором. Работать с незнакомым API или контрибьютить в незнакомый проект на Java сильно легче: ставишь точку, среда разработки раскрывает тебе список методов с подробной документацией про каждый. Можно настроить отдельную панель, где будет полноэкранная дока про класс или метод, на котором сейчас курсор стоит.
источник

NV

Nick Volynkin in DocOps-сообщество
А в Python такого нет. В своём коде я использую опциональную типизацию (mypy-lang.org/), она сильно помогает. И то я постоянно читаю доки в браузере на втором мониторе.
источник

DB

Dima Boger in DocOps-сообщество
Nick Volynkin
А в Python такого нет. В своём коде я использую опциональную типизацию (mypy-lang.org/), она сильно помогает. И то я постоянно читаю доки в браузере на втором мониторе.
В pycharm таки есть
источник

NV

Nick Volynkin in DocOps-сообщество
Так что всё, что приносит доки поближе к «курсору», туда, куда уже направлено внимание разработчика, очень помогает этому разработчику.
источник

NV

Nick Volynkin in DocOps-сообщество
Dima Boger
В pycharm таки есть
Есть, когда он явно знает тип или может его вывести. То есть когда ты только что присвоил переменной явное значение или когда она пришла из метода с объявленным возвращаемым типом.
источник

DB

Dima Boger in DocOps-сообщество
https://www.jetbrains.com/help/pycharm/documentation-tool-window.html можно заставить сканить внешнюю документацию ещё
источник

DB

Dima Boger in DocOps-сообщество
А что сейчас есть красивого для статических сайтов? Для митапа хотим собрать простенький лендинг и немножко документации
источник

DB

Dima Boger in DocOps-сообщество
Кстати, если кому надо что-нибудь подеплоить некоммерческого или коммерческого или небольшого — мы тут обнаружили волшебный https://kintohub.com, который умеет и в серверлесс, и в веб-приложения, и в сборку, и в статику
источник

H

Hartmann in DocOps-сообщество
Dima Boger
А что сейчас есть красивого для статических сайтов? Для митапа хотим собрать простенький лендинг и немножко документации
Gatsby есть, чего же боле.
источник

BS

Borys Shchuko in DocOps-сообщество
Подскажите, пожалуйста, какая софтина поможет реализовать следующий use case.
(Простите, если вопрос боянный.)

Несколько dev-команд работает над программным продуктом.
Репозиториев у нас сотни, ибо продукт большой.
Репозитории лежат на GitLab (self-hosted) и на Github.
Технические документы пишутся на markdown и лежат в репах так же, как код. Документы по конкретному сервису лежат именно в его репе.

Хочется:
сделать сайт, на котором централизованно можно почитать всю эту нашу документацию из репозиториев. И чтобы был глобальный поиск по ней.
Есть ли для этого какой-то готовый инструмент?
источник

KC

Kseniya Chudakova in DocOps-сообщество
Dima Boger
А что сейчас есть красивого для статических сайтов? Для митапа хотим собрать простенький лендинг и немножко документации
источник

FM

Fox Mulder in DocOps-сообщество
Аскидоктор и антора
источник

NK

ID:0 in DocOps-сообщество
А кто знает хорошие примеры gRPC API? Чтобы и написано понятно было, и читать удобно. Пожалуйста, напишите мне (@Nick_Volynkin) или в чат @docsascode.
источник

ML

Maksim Lapshin in DocOps-сообщество
а всё, он самый популярный? =)
источник

BS

Borys Shchuko in DocOps-сообщество
Fox Mulder
Аскидоктор и антора
А для markdown такого не существует?
источник

NV

Nick Volynkin in DocOps-сообщество
Borys Shchuko
Подскажите, пожалуйста, какая софтина поможет реализовать следующий use case.
(Простите, если вопрос боянный.)

Несколько dev-команд работает над программным продуктом.
Репозиториев у нас сотни, ибо продукт большой.
Репозитории лежат на GitLab (self-hosted) и на Github.
Технические документы пишутся на markdown и лежат в репах так же, как код. Документы по конкретному сервису лежат именно в его репе.

Хочется:
сделать сайт, на котором централизованно можно почитать всю эту нашу документацию из репозиториев. И чтобы был глобальный поиск по ней.
Есть ли для этого какой-то готовый инструмент?
Тысячи их, staticgen.com
источник

KC

Kseniya Chudakova in DocOps-сообщество
Borys Shchuko
А для markdown такого не существует?
и вот этого тоже тысячи
источник

BS

Borys Shchuko in DocOps-сообщество
Kseniya Chudakova
и вот этого тоже тысячи
Таких, чтоб агрегировали документы из разных реп в один сайт?
источник