Для общения в нашей команде мы используем Discourse. У нас есть специальная категория для внутренней инструкции, где все сообщения представлены в виде вики-страниц.
Плагин Docs идеально подходит для поиска и просмотра нашей внутренней документации, за исключением того факта, что при переходе со страницы документации на другую страницу открывается обычный вид форума.
Можно ли автоматически переписать ссылки так, чтобы при переходе из одного сообщения в другое оставался режим Knowledge Explorer?
Это технически возможно, но потребует довольно неуклюжей реализации. Нам пришлось бы добавлять параметр запроса к каждому клику по ссылке, а затем перенаправлять на представление документации, внедряя изменения в TopicController. Однако не все внутренние ссылки ведут на темы, которые есть в документации, и это тоже нужно учитывать.
Прежде чем пытаться реализовать это, я хотел бы увидеть больше запросов на такую функциональность.
Я поддерживаю это предложение и хотел бы также добавить возможность, чтобы темы «Документация» всегда по умолчанию открывались в режиме «Документация», независимо от того, откуда пришла ссылка. В противном случае это создаёт несколько непоследовательный опыт и иногда может казаться немного «костыльным».
Это было бы очень полезно. Я только что импортировал множество документов с другой платформы, которые содержат ссылки на другие документы, и, похоже, вынужден либо заменять их ссылками на страницу документации (/docs?category=123&topic=456), либо на страницу темы (/t/topic-title/456).
Было бы здорово иметь возможность использовать информативную ссылку на тему (содержащую название темы), но при этом перенаправлять её на документ при просмотре в режиме «Документация».
Кроме того, если мы переместим тему в другую категорию, ссылка /docs?category перестанет работать корректно. Удивительно, но она действительно отображает тему в режиме «Документация», однако фильтр устанавливается для старой категории.
Наконец-то нашли это! Именно то, что мы искали!
В данный момент мы добавляем ссылки на темы документации в таком формате: /docs?ascending=false&category=22&topic=1564, что является огромной головной болью.
Всего лишь короткое напоминание и вопрос: поддерживаете ли вы тоже PR по этому поводу? Будем рады спонсировать такую функцию.
Привет и спасибо за предложение и готовность отправить pull-запрос. Мы обсуждали улучшение документации, в том числе идею присвоения каждому документу одного URL вместо двух. Я думаю, что это решило бы проблему, но потребовало бы значительной рефакторинга текущей реализации функционала документации.
О, есть быстрое временное решение. Думаю, встроенная функция постоянных ссылок должна сработать? Вы можете настроить их в интерфейсе администратора. Это потребует немного дополнительных усилий, но позволит получать очень чистые URL-адреса для обмена.
Спасибо, ребята, я ценю ваши отзывы!
Пока попробуем использовать предложенные обходные пути. Но чем больше тем мы добавим в /docs, тем сложнее всё может стать, если нам придётся вручную управлять длинным списком URL-адресов.