Могу ли я использовать здесь внешнюю ссылку? И использовать _blank для открытия в новой вкладке?
Вы можете начать с краткого необязательного описания категории.
## Тест внешней ссылки
* Google: https://google.com
## Первый раздел
* https://discourse.example.com/t/topic-title/12
* https://discourse.example.com/t/another-topic-title/34
* Короткий заголовок: https://discourse.example.com/t/topic-with-a-long-title/56
* Другой заголовок: https://discourse.example.com/t/another-topic-with-a-long-title/78
## Второй раздел
* Заголовок темы: https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76
Любые неподдерживаемые установки обычно получают ссылку на страницу о неподдерживаемых установках. Это предупреждение, так как любые проблемы могут быть частично связаны с этим.
Плагин, темы и компоненты тем обычно содержат файл, касающийся совместимости версий.
Открытие этого файла предоставит важные примечания о совместимости версий. У других может быть эта информация в описании. Например, плагин Category Moderators содержит отказ от ответственности о поддержке только стабильной ветки.
Pavilion рекомендует частоту обновлений Discourse, чтобы у них было время обновить свои дополнения.
Работает ли это для подкатегорий? У меня есть сайт с 6 основными категориями, но я хочу иметь документацию для каждой категории, а также обсуждение. Не совсем уверен, как лучше всего этого добиться.
Только что наткнулся на это и у меня есть несколько вопросов: как мы можем установить это на наш сайт, размещенный в облаке? И, как вы думаете, как долго еще будут доступны старые Документация?
У нас пока нет графика полного удаления старого плагина, но его активная разработка уже прекращена. Как только мы примем по этому вопросу решения, мы опубликуем объявление, чтобы все были в курсе!
Поскольку этот плагин всё ещё находится в статусе experimental, он недоступен в нашем хостинге, но мы сейчас обсуждаем это внутренне и рассматриваем возможность его предоставления. Мы вернёмся к этому обсуждению, как только примем окончательное решение.
Я просто добавлю это для тех, кто, возможно, запутается, как и я, в том, что на самом деле делает этот плагин.
Со всеми настройками, темой индекса и прочим это может показаться ошеломляющим, особенно когда ещё нужно понять, что можно сделать и как это использовать. По крайней мере, я немного запутался, пока не нашёл способ разобраться (если я что-то упустил, пожалуйста, поделитесь этим).
Так вот, по моему мнению, всё работает так: создайте свои категории так, как вам нужно, а этот плагин просто удаляет боковую панель по умолчанию (с разделами для категорий, тегов и т.д.) и заменяет её списком разделов и ссылками внутри этих разделов на темы, категории, внешние ссылки и т.п. Мне так проще это воспринимать. Это больше про кастомизацию боковой панели при посещении определённой категории. Что-то вроде: когда посещается категория А, боковая панель по умолчанию заменяется на ту, что задана в теме индекса. Всё просто.
Интересно, как сделать индекс боковой панели в Docs более заметным на мобильных устройствах, ведь пользователи не видят темы, пока не нажмут на значок «гамбургер».
На компьютере это работает отлично, но, к сожалению, большинство пользователей используют смартфоны.
Вариантов не так много, или, скорее, их вообще нет. На мобильных устройствах просто не хватает места.
Это одна из причин, почему я рассматриваю возможность полного отказа от документации. Около 95% моих пользователей используют мобильные устройства, и они крайне редко или вообще не пользуются боковой панелью. Поэтому курирование меню документации отнимает много времени, и я не думаю, что соотношение затраченного времени и пользы здесь сбалансировано
Хорошо, я прочитал всю эту дискуссию и у меня есть несколько вопросов. Я понимаю, что структура этой страницы создается с помощью этой страницы, но тогда вам также нужна страница-индекс для каждой подкатегории? Индекс для этой страницы должен быть огромным… или для любой другой с большим количеством статей.
Насколько сложно было бы реализовать макет в стиле XWiki для страниц, которые являются частью документации сайта Discourse. Интерфейс достаточно прост: при создании страницы вы ставите галочку, указывая, что это документация. Система просто спрашивает, какой родительский элемент. Если родителя нет — это тема верхнего уровня. Если вы зададите родителя, страница отобразится под этой темой/категорией. Это полностью устраняет необходимость вручную поддерживать страницы-индексы. Они выглядят как лишняя работа, которая не должна быть обязательной. К тому же легко упустить добавление новых элементов по мере их создания.
Если вы перейдете на https://checkin.technospider.com и раскроете некоторые элементы в боковой панели, вы увидите, как работает вложение на реальном примере. Вся эта боковая панель генерируется динамически просто за счет вложения страниц друг в друга (отношение родитель/потомок). На этом сайте всего около 150 страниц, но мне потребовалось бы в два раза больше времени, чтобы завершить работу, если бы мне пришлось создавать индексы для всего этого.
И это подводит меня к проблеме UI/UX с расположением боковой панели Документации. Как только вы переходите со главной страницы, вы теряете начальный список категорий. Должен быть способ вернуться на страницу откуда-то.
Каждая из ваших 8 основных областей должна иметь треугольники раскрытия, чтобы независимо от того, нажали ли вы на галочку на главной странице или на название в боковой панели, список просто раскрывался, и вы не теряли возможность напрямую перейти к другой основной области.
У вас есть хлебные крошки на каждой конечной статье, но даже их нет в 8 категориях. Нажатие «удалить фильтр» в подразделах в верхней части страницы возвращает меня назад, но это очень неинтуитивно. Кроме того, можно сделать странные вещи, манипулируя фильтрами: например, красивый зеленый баннер исчезает, если нажать «нет подразделов».
Согласен, должно было потребоваться немало усилий, чтобы собрать все ссылки на страницы и аккуратно разложить их по категориям с подписями. Но результат получился просто замечательным и удобным в использовании!
Действительно, выглядит отлично, но, как я уже говорил, есть проблемы с удобством использования, особенно в части навигации.
А если удастся устранить эту работу, это будет выигрышем для всех.
Я не критикую проделанную работу — она выглядит очень хорошо. И поскольку я не умею программировать даже на базовом уровне, я даже не могу оценить, сколько усилий было вложено в неё, или сколько дополнительной работы потребовали бы мои предложения.
Это хорошо для минимальной документации, но отсутствует много разметки, которую я использовал на вики, на которую я ссылался. Возможно, я просто что-то упускаю. Я всё ещё довольно новичок в Discourse.
Например, я не могу найти способ создать информационные/предупреждающие/ошибочные блоки.
Для пользователей самохостинга, использующих этот плагин, наше последнее обновление потребует ручной пересборки индекса. Это потребует выполнения следующей задачи Rake:
bundle exec rake doc_categories:build_sidebar
# если выполнение задачи выше завершается ошибкой NoDatabaseError,
# выполните её со следующими параметрами для типичных самохостинговых настроек
sudo -E -u discourse bundle exec rake doc_categories:build_sidebar
Если вы не можете выполнить эту задачу Rake, вы можете перейти в настройки каждой категории документации, удалить индекс категории, сохранить изменения, добавить его обратно и снова сохранить. Это пересоберёт их и обновит кэш категорий.
Почему мы это делаем?
Ранее, когда боковую панель нужно было заполнить, мы парсили каждый индексный материал на лету и кэшировали их. Это обновление переносит существующие индексы на базу данных вместо использования материалов. Это даёт нашей команде больше возможностей при поиске способов улучшения UX организации индекса.
Обновления для тех, кто использует самохостинг