Size: a a a

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

2018 July 10

NV

Nick Volynkin in DocOps-сообщество
и я не то чтобы сторонник вики на гитхабе вести, просто для полноты упомянул )
источник

a

arvikon in DocOps-сообщество
А я как раз ищу прос/конс по вики
источник

ML

Maksim Lapshin in DocOps-сообщество
arvikon
А я как раз ищу прос/конс по вики
Вики хорошо когда с допплагинами
источник

NV

Nick Volynkin in DocOps-сообщество
Maksim Lapshin
Вики хорошо когда с допплагинами
это вики на гитхабе, там нет плагинов
источник

ML

Maksim Lapshin in DocOps-сообщество
У нас например в редмайне в страничку v_18_07 подтягиваюся статусы тикетов этой версии
источник

ML

Maksim Lapshin in DocOps-сообщество
Nick Volynkin
это вики на гитхабе, там нет плагинов
А это уже больно, там нужны генераторы
источник

SV

Ser V in DocOps-сообщество
Maksim Lapshin
У нас например в редмайне в страничку v_18_07 подтягиваюся статусы тикетов этой версии
то же самое можно макросом в конфу подтянуть
источник

NV

Nick Volynkin in DocOps-сообщество
Maksim Lapshin
А это уже больно, там нужны генераторы
источник

NV

Nick Volynkin in DocOps-сообщество
вот это я писал
источник

NV

Nick Volynkin in DocOps-сообщество
источник

NV

Nick Volynkin in DocOps-сообщество
> Nick Volynkin edited this page on 24 Jun 2015 · 45 revisions
источник
2018 July 11

NV

Nick Volynkin in DocOps-сообщество
Maksim Lapshin
А это уже больно, там нужны генераторы
В смысле, что там и генераторов нет. Только маркдаун, из которого Гитхаб сам делает странички.
источник

NV

Nick Volynkin in DocOps-сообщество
arvikon
А я как раз ищу прос/конс по вики
давайте обсудим эту тему )
источник

ML

Maksim Lapshin in DocOps-сообщество
Nick Volynkin
В смысле, что там и генераторов нет. Только маркдаун, из которого Гитхаб сам делает странички.
Не, экосистема у гитхаба дальше гита грустновата
источник

NV

Nick Volynkin in DocOps-сообщество
Maksim Lapshin
Не, экосистема у гитхаба дальше гита грустновата
Ну да. А ещё, кажется, никто не заходит на эти вики-страницы в гитхабе.
источник

NV

Nick Volynkin in DocOps-сообщество
Вот Readme на первой странице все видят.
источник

ML

Maksim Lapshin in DocOps-сообщество
Nick Volynkin
Ну да. А ещё, кажется, никто не заходит на эти вики-страницы в гитхабе.
Очень мало у кого это читаемо. Плюс к сожалению в каждой второй вики страница «список всех страниц» полезнее чем та структура, которую сделали руками
источник

NV

Nick Volynkin in DocOps-сообщество
Maksim Lapshin
Очень мало у кого это читаемо. Плюс к сожалению в каждой второй вики страница «список всех страниц» полезнее чем та структура, которую сделали руками
🤦‍♂️ Отдельная тема, кстати — как сделать удобную структуру.
источник

НС

Никита Самохвалов in DocOps-сообщество
Дико раздражает, что ссылка на вики в Гитхабе по умолчанию активна. А вручную не все её отключают, если там пусто. И вот ты такой жмёшь на ссылку — а там пусто.

Я часто вижу, что вики используют неправильно. В неё нельзя засовывать документацию, ибо она не будет версионироваться вместе с кодом. Но в вики можно закидывать просто полезную инфу. Кроме того, в Гитхабе доступ на редактирование можно открыть всем. Пара примеров страниц, редактируемых сообществом:
https://github.com/Seldaek/monolog/wiki/Third-Party-Packages
https://github.com/lord/slate/wiki/Slate-in-the-Wild

Основное назначение вики — подсказки и полезные ссылки. Из вики не нужно делать хранилище технической документации.
источник

НН

Нац Нац in DocOps-сообщество
Maksim Lapshin
Не, экосистема у гитхаба дальше гита грустновата
а как же прекрасный джекилл? :3
источник