Size: a a a

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

2019 March 11

NV

Nick Volynkin in DocOps-сообщество
На нём документирован Докер https://docs.docker.com/engine/api/v1.37/#operation/Session
источник

DB

Dima Boger in DocOps-сообщество
На самом деле это все ещё сваггер (опенапи спек)
источник

NV

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

АВ

Александр Викторович in DocOps-сообщество
Здравствуйте, только не стукайте. Вот смотрите, сборник требований для оформления кода - это кодстайл.
Вопрос: А как правильно назвать сборник всех нотисов от проекта для программистов по поводу написания самого кода?  Ну, которые указывают, что "если делаешь А, то делай и Б". На бизнес-процессы и прочее не тянет, ибо тут вопрос не "делай что", а "делай как", это всё внутреннее. Как называть такое правильно? Гайдлайном обозвать?
источник

DB

Dima Boger in DocOps-сообщество
Александр Викторович
Здравствуйте, только не стукайте. Вот смотрите, сборник требований для оформления кода - это кодстайл.
Вопрос: А как правильно назвать сборник всех нотисов от проекта для программистов по поводу написания самого кода?  Ну, которые указывают, что "если делаешь А, то делай и Б". На бизнес-процессы и прочее не тянет, ибо тут вопрос не "делай что", а "делай как", это всё внутреннее. Как называть такое правильно? Гайдлайном обозвать?
Я за гайдлайн
источник

DB

Dima Boger in DocOps-сообщество
Или стайлгайд
источник

EN

Ekaterina Noskova in DocOps-сообщество
Семён Факторович
и надо брать сваггер и не выпендриваться
да
источник

СФ

Семён Факторович in DocOps-сообщество
но я лелею надежду найти хотя бы один контрпример:)
источник

АВ

Александр Викторович in DocOps-сообщество
ясно, спасибо
источник

I

Igor in DocOps-сообщество
Александр Викторович
Здравствуйте, только не стукайте. Вот смотрите, сборник требований для оформления кода - это кодстайл.
Вопрос: А как правильно назвать сборник всех нотисов от проекта для программистов по поводу написания самого кода?  Ну, которые указывают, что "если делаешь А, то делай и Б". На бизнес-процессы и прочее не тянет, ибо тут вопрос не "делай что", а "делай как", это всё внутреннее. Как называть такое правильно? Гайдлайном обозвать?
у нас это называется "best practices"
источник

L

Lana in DocOps-сообщество
Александр Викторович
Здравствуйте, только не стукайте. Вот смотрите, сборник требований для оформления кода - это кодстайл.
Вопрос: А как правильно назвать сборник всех нотисов от проекта для программистов по поводу написания самого кода?  Ну, которые указывают, что "если делаешь А, то делай и Б". На бизнес-процессы и прочее не тянет, ибо тут вопрос не "делай что", а "делай как", это всё внутреннее. Как называть такое правильно? Гайдлайном обозвать?
Coding guideline у нас
источник

NV

Nick Volynkin in DocOps-сообщество
Перепутал. Manual of style это про тексты. А у вас это похоже на сборник лучших практик, + к Игорю.
источник

A

Antonio in DocOps-сообщество
Семён Факторович
и надо брать сваггер и не выпендриваться
Поверьте моему горькому опыту с гитбуком - берите сваггер и не выпендривайтесь. Мы смигрировали описания на опенапи 3.0, прикрутили авторизацию и дали ссылку на эту доку из гитбука. И тестируй запросы, сколько влезет.
Гитбук позволяет импортировать локальные файлы или из репозитория, но, там он тянет все сразу, кусками нельзя (здесь невероятно тащит asciidoctor).
Простого решения, чтобы впихнуть всегда актуальный рест в гитбук, нет. Я сам задавался вопросом, чтобы засинкать API с докой, но, пока все туманно.
Насчёт redoc - он крутой, но, в нем нет возможности отправки запросов. И это не формат документирования (как там писали про докер), это просто оболочка для swagger/openapi спек. Визуально, пожалуй, самая крутая оболочка
источник

NV

Nick Volynkin in DocOps-сообщество
Antonio
Поверьте моему горькому опыту с гитбуком - берите сваггер и не выпендривайтесь. Мы смигрировали описания на опенапи 3.0, прикрутили авторизацию и дали ссылку на эту доку из гитбука. И тестируй запросы, сколько влезет.
Гитбук позволяет импортировать локальные файлы или из репозитория, но, там он тянет все сразу, кусками нельзя (здесь невероятно тащит asciidoctor).
Простого решения, чтобы впихнуть всегда актуальный рест в гитбук, нет. Я сам задавался вопросом, чтобы засинкать API с докой, но, пока все туманно.
Насчёт redoc - он крутой, но, в нем нет возможности отправки запросов. И это не формат документирования (как там писали про докер), это просто оболочка для swagger/openapi спек. Визуально, пожалуй, самая крутая оболочка
👍
источник

A

Antonio in DocOps-сообщество
Если бы не куча переменных, которые у нас юзаются в гитбуке, я бы уже давно смигрировал доки во vuepress
источник

СФ

Семён Факторович in DocOps-сообщество
Antonio
Поверьте моему горькому опыту с гитбуком - берите сваггер и не выпендривайтесь. Мы смигрировали описания на опенапи 3.0, прикрутили авторизацию и дали ссылку на эту доку из гитбука. И тестируй запросы, сколько влезет.
Гитбук позволяет импортировать локальные файлы или из репозитория, но, там он тянет все сразу, кусками нельзя (здесь невероятно тащит asciidoctor).
Простого решения, чтобы впихнуть всегда актуальный рест в гитбук, нет. Я сам задавался вопросом, чтобы засинкать API с докой, но, пока все туманно.
Насчёт redoc - он крутой, но, в нем нет возможности отправки запросов. И это не формат документирования (как там писали про докер), это просто оболочка для swagger/openapi спек. Визуально, пожалуй, самая крутая оболочка
очень исчерпывающе, спасибо!
источник

A

Anatoliy in DocOps-сообщество
Александр Викторович
Здравствуйте, только не стукайте. Вот смотрите, сборник требований для оформления кода - это кодстайл.
Вопрос: А как правильно назвать сборник всех нотисов от проекта для программистов по поводу написания самого кода?  Ну, которые указывают, что "если делаешь А, то делай и Б". На бизнес-процессы и прочее не тянет, ибо тут вопрос не "делай что", а "делай как", это всё внутреннее. Как называть такое правильно? Гайдлайном обозвать?
Coding rules. Еще можно SonarCube подключить, что б проверял.
источник

I

Igor in DocOps-сообщество
Ого, SonarCube настолько продвинутый что ему можно скормить набор пожеланий к коду и он будет за этим следить? А как описываются основные антипаттерны?
источник

I

Igor in DocOps-сообщество
Умеет например найти три похожых куска кода и предложить зарефакторить, по Фаулеру чтоб прям всё?
источник

NV

Nick Volynkin in DocOps-сообщество
Это IDEA умеет вроде бы )
источник