Телеграмм чат группы docsascode страница 914

Size: a a a

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

929 membersпожаловаться на группу

2021 August 24

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

👍

источник

08:22пожаловаться #1

Maksim Lapshin in DocOps-сообщество

https://swagger.io/blog/news/mulesoft-joins-the-openapi-initiative/

коллеги, а тут говорят, что raml больше не нужен

https://foliant-docs.github.io/docs/tutorials/api/#raml

а тут его поддерживают. Он всё таки совсем закончился или на него ещё надо посмотреть?

Нам надо описать 4 http сервиса

SmartBear.com

MuleSoft Joins the OpenAPI Initiative: The End of the API Spec Wars

Yesterday, MuleSoft, the creators of RAML, announced that they have joined the Open API Initiative. Created by SmartBear Software and based on the wildly popular Swagger Specification, the OpenAPI Initiative is a Linux Foundation project with over 20 members, including Adobe, IBM, Google, Mi...

источник

14:55пожаловаться #2

Dima Boger in DocOps-сообщество

а вроде не говорят что не нужен, говорят что raml будет надстройкой над опенапи 🤔

источник

15:12пожаловаться #3

Maksim Lapshin in DocOps-сообщество

Коллеги, а вот вопрос.

Мы сейчас собираемся документировать апи, у нас вся документация через фолиант и mkdocs собрана.

Апи всё описано в сваггере.

Получается, что если хочется slate, то непонятно как меню синхронизировать?

источник

18:17пожаловаться #4

2021 August 26

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

Всем доброго утра.

Может быть кто-то сталкивался и есть решение: использую Mkdocs для генерации сайта. Одну страницу (в отдельном файле .md) решил пока не использовать для сборки и закомментировал ее mkdocs.yaml в разделе nav, но она все равно собирается (доступна по url) и индексируется поисковиками (почитал хабр - так и должно быть).

Можно ли без удаления файла убрать из сборки файл?

источник

09:46пожаловаться #5

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

Пока решил проблему переименованием расширения файла 👀
Оставлю тут, может кому-нибудь пригодится)

источник

09:53пожаловаться #6

Fox Mulder in DocOps-сообщество

Перефразирую вопрос:
А разве можно использовать кириллицу ?
Это раз. А два - файлы надо оборачивать в ``, например ` index.md`

источник

10:00пожаловаться #7

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

yaml позволяет использовать любой Unicode. Кавычки нужны только для строк с пробелами и другими служебными символами.

источник

13:53пожаловаться #8

Fox Mulder in DocOps-сообщество

@cats_cradle спасибо за наводку с юникодом, не знал. что касается же ковычек, то я залез сейчас в доку к mkdocs и там в кавычках все значения, даже если там просто файлы

источник

13:56пожаловаться #9

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

Достоинство YAML - человекочитаемый формат. Сопряжённый с ним недостаток - огромное количество способов сделать одно и то же.

источник

13:57пожаловаться #10

Dmytro Lispyvnyi '(🌲... in DocOps-сообщество

у YAML есть огромная проблема в том, что он не годится для длинных и глубоковложенных данных

источник

13:59пожаловаться #11

Fox Mulder in DocOps-сообщество

я просто подумал, что сам мкдок может накладывать доп. ограничения