Size: a a a

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

2018 August 15

НС

Никита Самохвалов in DocOps-сообщество
Раскрыто ещё одно предназначение ПХП )
источник

EN

Ekaterina Noskova in DocOps-сообщество
Никита Самохвалов
Всё так. Но нужен бекенд, который будет отруливать обратную совместимость и права доступа.
А бэкенд почему не хотите сделать?
источник

НС

Никита Самохвалов in DocOps-сообщество
Ленивый :) Хочу взять готовое, кем-то написанное и проверенное решение. Поэтому всё, к чему нужно ограничивать доступ (сложнее, чем ХТТП-аутентификация) веду в Конфе.

Собственно, в этом и был вопрос — не пропустил ли я чего, подумал, может уже есть готовая опенсорсная коробочка с бекендом, фронтом и инфрой, которая красиво маркдаун облагораживает. Понял, что нет — не пропустил :)
источник

EN

Ekaterina Noskova in DocOps-сообщество
У генераторов статических сайтов есть cms в которых может быть то что вам нужно
источник

EN

Ekaterina Noskova in DocOps-сообщество
Ну и разные плагины
источник

MN

Max Nikulin in DocOps-сообщество
Никита Самохвалов
Ленивый :) Хочу взять готовое, кем-то написанное и проверенное решение. Поэтому всё, к чему нужно ограничивать доступ (сложнее, чем ХТТП-аутентификация) веду в Конфе.

Собственно, в этом и был вопрос — не пропустил ли я чего, подумал, может уже есть готовая опенсорсная коробочка с бекендом, фронтом и инфрой, которая красиво маркдаун облагораживает. Понял, что нет — не пропустил :)
мы bookstack используем
источник

ИЦ

Игорь Цупко in DocOps-сообщество
кубы, несколько репочек, для авторизации - либо active directory с nginx-ом, либо какие-то другие варианты на базе авторизации nginx-а
источник

EN

Ekaterina Noskova in DocOps-сообщество
Никита Самохвалов
Ленивый :) Хочу взять готовое, кем-то написанное и проверенное решение. Поэтому всё, к чему нужно ограничивать доступ (сложнее, чем ХТТП-аутентификация) веду в Конфе.

Собственно, в этом и был вопрос — не пропустил ли я чего, подумал, может уже есть готовая опенсорсная коробочка с бекендом, фронтом и инфрой, которая красиво маркдаун облагораживает. Понял, что нет — не пропустил :)
Какой у вас генератор?
источник

ИЦ

Игорь Цупко in DocOps-сообщество
Max Nikulin
мы bookstack используем
крутая штука, спасибо
источник

DB

Dima Boger in DocOps-сообщество
Я тут стал тыкать в знакомых по поводу документации внутренних библиотек. По питону оказалось всё понятно — sphinx-apidoс, бац бац, выбрал тему, задеплоил.

По фронту оказалось всё веселее — кроме генераторов доки есть сторибуки. Это когда основой доки является песочница с прописанными "историями" по каждому UI-компоненту — и можно открыть, потыкать, потрогать и посмотреть исходный код как оно сделано:
https://storybooks-vue.netlify.com
источник

SV

Ser V in DocOps-сообщество
а еще у них есть Slow start guide - https://storybook.js.org/basics/slow-start-guide/
источник

НС

Никита Самохвалов in DocOps-сообщество
Max Nikulin
мы bookstack используем
Лендинг выглядит интересно, спасибо.
источник

НС

Никита Самохвалов in DocOps-сообщество
Игорь Цупко
кубы, несколько репочек, для авторизации - либо active directory с nginx-ом, либо какие-то другие варианты на базе авторизации nginx-а
А редиректы на случай перемещения статьи из одного раздела в другой?
источник

ИЦ

Игорь Цупко in DocOps-сообщество
Никита Самохвалов
А редиректы на случай перемещения статьи из одного раздела в другой?
а дока вообще должна быть версионирована, по тегам.
источник

ИЦ

Игорь Цупко in DocOps-сообщество
ну и да, в чистом виде проблема не решается, кодить надо (
источник

НС

Никита Самохвалов in DocOps-сообщество
Должно. Но тем не менее, нужны редиректы :) В Конфе это реализовано айдишниками.
источник

НС

Никита Самохвалов in DocOps-сообщество
Dima Boger
Я тут стал тыкать в знакомых по поводу документации внутренних библиотек. По питону оказалось всё понятно — sphinx-apidoс, бац бац, выбрал тему, задеплоил.

По фронту оказалось всё веселее — кроме генераторов доки есть сторибуки. Это когда основой доки является песочница с прописанными "историями" по каждому UI-компоненту — и можно открыть, потыкать, потрогать и посмотреть исходный код как оно сделано:
https://storybooks-vue.netlify.com
Мы такой используем.
источник

ИЦ

Игорь Цупко in DocOps-сообщество
Товарищи. Вот есть фраза ты должен понимать, что происходит в проекте, а есть фраза ты должен держать в голове и актуализировать информацию по проекту. Я пытаюсь дать определение разнице, что есть между этими формулировками.
Первое - оно какое-то пассивное, не подразумевает активных действий. Во втором хотя бы одно реальное действие есть.

Вот как эту разницу объяснить ёмко?
источник

NV

Nick Volynkin in DocOps-сообщество
Понимание сложно формализовать и измерить
источник

NV

Nick Volynkin in DocOps-сообщество
Актуальность документов легко оценить: тут актуально, тут устарело, тут нет информации про новую фичу.
источник