Size: a a a

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

2021 September 23

FM

Fox Mulder in DocOps-сообщество
А можете кейс расписать? Как подключали? Как поняли? Что счетчик прям с первого символа начинается и тп?
источник

MM

Maxim Markelow in DocOps-сообщество
Перенесли БЗ с mkdocs на Docuaurus. И там, и там md файлы, поэтому перенос плюс-минус легко дался.

Как подключать сам поиск к Docusaurus в целом хорошо расписано в их доке: https://docusaurus.io/docs/search

У Algolia есть отдельная программа в помощи разработчиком подключения их поиска к сайтам-документациям: https://docsearch.algolia.com/
В рамках этой программы они смотрят на ваш сайт и помогают сделать конфиг для интеграции. Мы обошлись без их помощи, просто  скопировали настройки из репозитория Docusuarus (у них там тоже используется Algolia) и подправили их немного под себя. Если используется не Docusaurus, их помощь потенциально может быть полезной.

Небольшое затруднение вызвала индексация содержимого сайта для поиска. Algolia предлагают бесплатное автоматическое обновление сайта один раз в сутки. Нам захотелось обновлять индекс после каждой пересборки сайта. У Algolia есть docker образ, в котором есть crawler для формирования поискового индекса: https://docsearch.algolia.com/docs/run-your-own
Его пока запускаем вручную, перед релизом автоматизируем процесс.
источник

MM

Maxim Markelow in DocOps-сообщество
Поняли, что поиск начинается при вводе каждого символа, когда посмотрели в консоль разработчика в браузере.
источник

FM

Fox Mulder in DocOps-сообщество
А сколько примерно у вас запросов? Я пока не понимаю о сумме? В которую нам может обойтись Алголия
источник

MM

Maxim Markelow in DocOps-сообщество
До 10к запросов в месяц у них идут бесплатно. Свыше - платно. Например, 50к запросов в месяц будут стоить 40$. https://www.algolia.com/pricing/
источник

MM

Maxim Markelow in DocOps-сообщество
Мы пока не знаем, сколько примерно будет запросов, в продакшн не выпустили. Для себя решили попробовать, посмотреть пару месяцев на количество запросов, и дальше уже принимать решение.
источник

MM

Maxim Markelow in DocOps-сообщество
Они предлагают еще и статистику по поиску.
Можно посмотреть, сколько в принципе людей поиском пользуется, популярные запросы и запросы, на которые не был выдан результат.
источник

MM

Maxim Markelow in DocOps-сообщество
источник

MM

Maxim Markelow in DocOps-сообщество
источник

MM

Maxim Markelow in DocOps-сообщество
Само качество поиска намного лучше того, что было у встроенного в mkdocs lunr. Особенно на русском языке.
источник

FM

Fox Mulder in DocOps-сообщество
Спасибо! Надо будет заняться и тоже попробовать бесплатную
источник

MM

Maxim Markelow in DocOps-сообщество
источник

J

Jonny Cuba in DocOps-сообщество
Коллеги, вопрос по глоcсарию в Сфинкс+rst. Есть общий файл с глоссарием, в одном docx ссылки работают, в другом нажимаешь, ссылаются на главную страницу. Вы как делаете, для каждого дока отдельный глоссарий или как?
источник

NV

Nick Volynkin in DocOps-сообщество
Как должен выглядеть результат? Ссылки между файлами DOCX?
источник

J

Jonny Cuba in DocOps-сообщество
Да
источник

NV

Nick Volynkin in DocOps-сообщество
А если люди их переименуют или положат в разные папки?
источник

J

Jonny Cuba in DocOps-сообщество
Нет, ссылки в самом docx
источник

NV

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

Мы не делаем страницу-глоссарий. У нас где термин естественным образом вводится, там и оформляем кусочек глоссария. Ссылки на термин ведут туда. Например, https://www.tarantool.io/en/doc/latest/book/box/data_model/#term-tuple
источник

ME

Maria Ermakovich in DocOps-сообщество
btw давеча наткнулась на вашу картинку где бакеты изображены в виде вёдер и это прекрасно )
источник

J

Jonny Cuba in DocOps-сообщество
Спасибо, доберусь до компа посмотрю
источник