что такое confluence простыми словами

Как мы используем Confluence для разработки требований к продукту

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

В статье описаны наши подходы к использованию Confluence в качестве инструмента для работы с требованиями к продукту. Не претендуем на универсальность, но, возможно, эти подходы будут полезны для решения ваших задач, которые не обязательно связанны с процессами разработки требований (ведение пользовательской документации, описание внутренних регламентов работы отдела, организация базы знаний и пр).

Все изменения в требованиях к новой фиче на одной странице

Мы разрабатываем сложные Enterprise-продукты, которые тиражируются для сотен корпоративных заказчиков. В одном из наших продуктов больше ста функциональных модулей и у каждого модуля есть отдельный документ с требованиями. Фичи нового релиза, как правило, затрагивают несколько (от 3 до 20) функциональных модулей.

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

Чтобы понять все изменения в требованиях, проектная команда должна прочитать все документы, которые затрагивает новая функциональность, и вдобавок к этому, разобраться, что именно поменялось в каждом из них. Это долго и неудобно.

Для решения проблемы мы сделали сводный документ по каждой новой функциональности. Он содержит только изменившиеся части требований к функциональным модулям. При этом, если в исходном документе что-то изменится, это будет автоматически отражено в сводном документе.

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

Примерно так это выглядит в жизни:

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

Теперь проектной команде достаточно прочитать один документ, чтобы понять все изменения. Аналитик же один раз «собирает» документ и не беспокоится, что возникающие изменения нужно поддерживать сразу в двух документах.

Технически это реализовано с помощью плагина Multi Excerpt, который позволяет вставлять части одного документа в разные документы.

В документе с требованиями к функциональному модулю:
Текст изменившейся части требований обрамляется макросом MultiExcerpt. Если изменение небольшое (например, поменялась какая-то одна цифра или небольшое предложение), мы добавляем в макрос немного текста вокруг этого изменения, чтобы читатель понимал контекст.
что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

На странице документа с новой функциональностью:
Добавляем макрос Multiexcerpt include. В нём указываем, какой блок из какой страницы нужно вставлять:
что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

Готовая страница фичи в режиме редактирования выглядит примерно так:
что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

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

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

Делается это с помощью стандартных макросов «Отчёт о свойствах страницы» и «Свойства страницы».

На каждую страницу с требованиями к функциональным модулям добавляется метка (тэг) новой функциональности и макрос «Свойства страницы». В этот макрос добавляется стандартная таблица, в строках которой заполняются нужные свойства (на первый взгляд кажется сложно, но в документации всё подробно описано).

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

А на страницу фичи добавляется макрос «Отчет по свойствам страницы», в нем указывается метка фичи, а также список свойств, которые необходимо отображать.

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

«Трассировка» требований

Изменения в требованиях к одному функциональному модулю могут потребовать изменений и в других модулях. Если забыть про связанные изменения на этапе проработки требований, скорее всего, это станет известно на более позднем этапе (например, во время тестирования) и повлияет на сроки сдачи релиза. К сожалению, у нас бывали такие прецеденты.

Чтобы отследить влияние функциональных модулей друг на друга и не забывать о связанных изменениях в требованиях, мы используем функциональные возможности меток (тэгирование). Получается своего рода трассировка требований, но с крупным шагом: на уровне функциональных модулей, а не атомарных требований.

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

При более чем сотне функциональных модулей и их взаимосвязи даже такой крупный шаг трассировки позволил нам значительно сократить количество случаев, когда аналитик в процессе разработки требований к новой функциональности забывает учесть связанные требования.

Для этого мы используем стандартную функциональность меток в Confluence и макрос «Результаты поиска».

В режиме редактирования это выглядит так:

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

А читатель видит так:

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

Версионирование требований по релизам

Confluence в паре с плагином Scroll Versions позволяет для каждого нового релиза делать отдельную ветку требований, при этом у всех документов в каждом релизе остается собственная история изменений. Переключение между версиями релизов выполняется в пару кликов. Кроме того, можно сравнивать между собой требования как разных релизов, так и разных версий одного документа внутри одного релиза.

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

Так выглядит в жизни переключение между версиями релизов:

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

Комментирование

Для работы с комментариями мы используем плагин Talk.

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

От стандартного функционала комментирования в Confluence мы отказались, потому что у него были критичные для нас минусы:

Создание диаграмм и мокапов

Сначала мы использовали MS Visio и экспортировали схемы в растровый формат, а затем загружали в Confluence. Такой подход был неудобен — актуальность схем приходится поддерживать в двух местах, для этого нужно слишком много действий.

Как оказалось, в Confluence есть множество плагинов для работы с разного рода графическими объектами (диаграммы, схемы, мокапы и пр). Balsamiq Wireframes for Confluence и Draw.io Diagrams for Confluence позволяют редактировать графические объекты, не выходя из Confluence. На данный момент эти плагины почти полностью покрывают наши потребности.
что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

Базовые возможности

Кратко расскажу о базовых возможностях, которые предоставляет Confluence (как и большинство других вики-систем). Чтобы не пересказывать документацию, ограничусь списком того, чем мы в основном пользуемся:

Переход с MS Word

Есть несколько неочевидных вещей, с которыми почти сразу сталкиваешься после перехода с Word на Confluence.

Нумерация заголовков

Чтобы добавить автоматическую нумерацию заголовков, нужно обрамить текст макросом Numbering headings.

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

Гиперссылка на раздел

Чтобы внутри документа сослаться на какую-нибудь часть документа или заголовок раздела, нужно сначала добавить макроc Anchor (в русской локализации он называется «Анкер»), а затем добавить гиперссылку на него из нужной части документа.

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

Так он выглядит в документе в режиме редактирования:

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

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

Цвет фона текста

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

Для заливки мы используем такой код:

Подставьте RGB-код нужного вам цвета.

Для любителей автоматизации есть еще один лайфхак: можно сначала в визуальном редакторе изменить цвет текста, а потом в режиме редактирования исходного кода страницы с помощью регулярных выражений сделать автозамену HTML-разметки выделения текста цветом на заливку.

Это не очень удобно, но другого способа выделять текст заливкой мы пока не нашли.
Из минусов:

Источник

Основы работы в Confluence

О Confluence

Создавайте контент, сотрудничайте и организуйте всю рабочую информацию в одном месте. Confluence — это пространство для команд, в котором накопленные знания объединены с возможностями для совместной работы. Динамические страницы представляют собой площадку для творчества, сбора информации и совместной работы участников команды над любыми проектами и идеями. Благодаря разделам можно структурировать и организовывать работу в команде, а также предоставлять общий доступ к базе знаний организации и к информации, необходимой участникам для эффективной работы. Подробнее о возможностях Confluence.

Confluence могут использовать команды любого размера и типа — как те, которые занимаются крупными, критически важными проектами и должны строго следовать рекомендациям, так и те, которые ищут пространство для формирования командной культуры и более открытого и естественного способа взаимодействия друг с другом.

Вооружившись Confluence, команда сможет быстро принимать решения, добиться согласованности и достичь больших результатов при совместной работе.

Варианты размещения

Confluence может работать в облаке, в вашей собственной инфраструктуре или в большом масштабе. Изучите предложенные далее варианты размещения и определите, какой из них лучше всего подходит вашей организации.

что такое confluence простыми словами. . что такое confluence простыми словами фото. что такое confluence простыми словами-. картинка что такое confluence простыми словами. картинка .

Cloud

В варианте Confluence Cloud мы разместим сайт за вас: никаких серверов, хранилищ или технического обслуживания не потребуется. Вы получите мгновенный доступ к новейшим возможностям с автоматическим обновлением, оптимальной производительностью и эластичным масштабированием благодаря размещению в облаке AWS.

что такое confluence простыми словами. . что такое confluence простыми словами фото. что такое confluence простыми словами-. картинка что такое confluence простыми словами. картинка .

Data Center

Confluence Data Center — это решение для самостоятельного управления с разными вариантами конфигурации, которые позволят выстроить командную работу с учетом потребностей организации. Режим «Только чтение» и гибкость развертывания с привлечением поставщиков IaaS (таких как AWS и Azure) обеспечат бесперебойный доступ и масштабирование с учетом потребностей ваших пользователей.

что такое confluence простыми словами. Server. что такое confluence простыми словами фото. что такое confluence простыми словами-Server. картинка что такое confluence простыми словами. картинка Server.

Server

При выборе варианта Confluence Server вы размещаете Confluence на собственном оборудовании и можете настраивать параметры установки по своему усмотрению. Этот вариант подходит командам, которые хотят контролировать все детали, установить более жесткие требования к управлению данными и готовы к любым сложностям, связанным с самостоятельным размещением.

Для варианта Confluence Cloud мы предлагаем тарифные планы Free, Standard и Premium, рассчитанные на команды с разными потребностями. Подробнее о планах подписки на Confluence Cloud см. в этом обзоре.

Основные термины

Страница

Контент размещается на страницах — динамических документах, которые вы создаете на сайте Confluence. Страницы могут содержать любую информацию: от планов проектов до протоколов собраний, от руководств по поиску и устранению неисправностей до политик и многого другого. Вместе с Confluence поставляются шаблоны, которые помогают создавать прекрасные страницы для любого контента. Если не удастся найти шаблон для нужного типа контента, всегда можно начать с чистого листа.

Раздел

Страницы хранятся в разделах — рабочих пространствах, предназначенных для совместной работы и упорядочения контента. Связанный контент лучше размещать в одном разделе, но вы можете создать столько разделов, сколько требуется команде. Например, одна маркетинговая команда может хранить всю работу в одном разделе, выделив на каждую маркетинговую кампанию по одной странице, тогда как другая может создать для каждой кампании отдельный раздел. Одновременно с разделом создается обзорная часть (главная страница) и блог. Это облегчает распространение обновлений и объявлений среди участников команды.

Дерево страниц

Систематизировать содержимое раздела помогает иерархическое дерево страниц. Благодаря этому найти нужную информацию можно быстрее и проще. Страницы можно упорядочивать любым способом, создавая вложенные страницы внутри связанных с ними разделов и страниц.

Источник

Confluence

что такое confluence простыми словами. confluence. что такое confluence простыми словами фото. что такое confluence простыми словами-confluence. картинка что такое confluence простыми словами. картинка confluence.

Confluence

Confluence — это среда, в которой вы создаете, упорядочиваете и обсуждаете рабочие процессы всей командой.

Описание

Confluence — тиражируемая вики-система для внутреннего использования организациями с целью создания единой базы знаний. Написана на Java.

Atlassian Confluence это простая в работе и обновременно мощная система публикации web-страниц и документов в стиле wiki, позволяющая обмениваться контентом между участниками вашей команды и оранизовать обсуждение.

Возможности сервиса

Функционал сервиса

Аналоги и альтернативы для Confluence

что такое confluence простыми словами. 98545. что такое confluence простыми словами фото. что такое confluence простыми словами-98545. картинка что такое confluence простыми словами. картинка 98545.

XWiki

Open-source Вики-движок с возможностью создания мини-приложений на вики-страничках

что такое confluence простыми словами. 11193. что такое confluence простыми словами фото. что такое confluence простыми словами-11193. картинка что такое confluence простыми словами. картинка 11193.

Quip объединяет документы, электронные таблицы и чаты, чтобы удаленные команды могли эффективно работать все вместе

что такое confluence простыми словами. 141915. что такое confluence простыми словами фото. что такое confluence простыми словами-141915. картинка что такое confluence простыми словами. картинка 141915.

Conceptboard

Conceptboard – это интерактивная цифровая доска задач (канбан-доска), где любой участник проекта может писать и рисовать, а также импортировать любые рабочие документы простым перетаскиванием

что такое confluence простыми словами. 2020 04 25 19 28 25 Zenkit Online Project Management. что такое confluence простыми словами фото. что такое confluence простыми словами-2020 04 25 19 28 25 Zenkit Online Project Management. картинка что такое confluence простыми словами. картинка 2020 04 25 19 28 25 Zenkit Online Project Management.

Zenkit

Zenkit органайзер данных и информации

что такое confluence простыми словами. 819.1. что такое confluence простыми словами фото. что такое confluence простыми словами-819.1. картинка что такое confluence простыми словами. картинка 819.1.

HelpDesk

Helpdesk — это информационная система для организации помощи пользователям технологичных продуктов и услуг

что такое confluence простыми словами. 8201. что такое confluence простыми словами фото. что такое confluence простыми словами-8201. картинка что такое confluence простыми словами. картинка 8201.

Columns

Columns — это списки (чек-листы), которые формируются в колонки

что такое confluence простыми словами. 74. что такое confluence простыми словами фото. что такое confluence простыми словами-74. картинка что такое confluence простыми словами. картинка 74.

weDocs

что такое confluence простыми словами. 748. что такое confluence простыми словами фото. что такое confluence простыми словами-748. картинка что такое confluence простыми словами. картинка 748.

Nuclino

Nuclino — это программное обеспечение совместной работы, которая позволяет командам сотрудничать и обмениваться информацией в режиме реального времени

что такое confluence простыми словами. 749. что такое confluence простыми словами фото. что такое confluence простыми словами-749. картинка что такое confluence простыми словами. картинка 749.

Slite

Slite — удобный командный сервис для ведения заметок

что такое confluence простыми словами. 641 1. что такое confluence простыми словами фото. что такое confluence простыми словами-641 1. картинка что такое confluence простыми словами. картинка 641 1.

Zendesk

SaaS helpdesk с интуитивным интерфейсом.

что такое confluence простыми словами. Screenshot 3. что такое confluence простыми словами фото. что такое confluence простыми словами-Screenshot 3. картинка что такое confluence простыми словами. картинка Screenshot 3.

Evernote

Приложение для ведения заметок, чек-листов, записей встреч и прочей важной информации

что такое confluence простыми словами. header devices 2x 616e3a6423a45d1737127ec42a6f1965dcaeec18565190ff30d70e2d1db804ce. что такое confluence простыми словами фото. что такое confluence простыми словами-header devices 2x 616e3a6423a45d1737127ec42a6f1965dcaeec18565190ff30d70e2d1db804ce. картинка что такое confluence простыми словами. картинка header devices 2x 616e3a6423a45d1737127ec42a6f1965dcaeec18565190ff30d70e2d1db804ce.

MindMeister

Инструмент для майндмэппинга #1. Захватывайте, разрабатывайте и делитесь идеями визуально.

что такое confluence простыми словами. Nonion. что такое confluence простыми словами фото. что такое confluence простыми словами-Nonion. картинка что такое confluence простыми словами. картинка Nonion.

Notion

Notion объединяет в себе огромное количество инструментов. Заметки и списки дел, документы и таблицы, канбан-доски и базы знаний — здесь есть всё, с чем нам приходится иметь дело ежедневно.

что такое confluence простыми словами. Miro2. что такое confluence простыми словами фото. что такое confluence простыми словами-Miro2. картинка что такое confluence простыми словами. картинка Miro2.

Онлайн доска и платформа для создания совместной работы и централизации коммуникации в вашей компании.

что такое confluence простыми словами. omni sneakpeak. что такое confluence простыми словами фото. что такое confluence простыми словами-omni sneakpeak. картинка что такое confluence простыми словами. картинка omni sneakpeak.

OmniDesk

Выведите общение с клиентами на новый уровень. Поддержка через эл. почту и чаты.

Стоимость, Цены и Тарифы

4 отзыва на Confluence

Плюсы и минусы продукта

По большому счету Confluence является качественным инструментом, но есть ряд нюансов. Так, иногда он может спонтанно зависать или значительно терять в скорости на целый день. Функция поиска же не всегда работает корректно, отображая ошибку при поиске существующего файла.

Но в целом же Confluence справляется со всеми возложенными на неё обязанностями. В нашей команде хранилище выступает в виде стержня, что объединяет нас и указывает конечную цель.

Отличное рабочее хранилище, в котором можно содержать все электронные документы. Настройка проста, есть приличного качества визуальные инструменты, имеются уровни доступа, открывающие путь к файлам определенным лицам по вашему желанию.

Легкая настройка, возможно, является главным достоинством Confluence. Еще могу отметить прекрасную интеграцию с JIRA, а также представленные авторами шаблоны, которые подходят практически под любой проект и не требуют серьезных правок.

А вот ограничений у Confluence много: те же шаблоны можно редактировать только поверхностно, отсутствует возможность использовать их на нескольких сайтах (приходится много переделывать).

Посоветовать эту программу я могу только тем, кто собирается оперировать с малым количеством контента. Если же вы хотите пересылать крупные объемы информации, использовать DRM и им подобные серьезные ограничения, то в таком случае лучше поищите что-нибудь другое.

веб-приложение сильно тормозит на слабых компах, и иногда просто не грузится авторизация — даже на нормальных ПК
перевод на русский язык неполный и кривой
саму структуру нельзя назвать удобной
хотели сделать небольшую корпоративную базу знаний, для не-IT компании, получилось хреново
для IT наверное будет норм

Источник

Confluence для публичной базы знаний: меняем дизайн и настраиваем разделение по языкам

У нас есть шесть продуктов, которые используют в России и за рубежом. Это значит, что документация к ним должна быть в одном месте, но разделена по продуктам и языкам.

Раньше мы использовали MediaWiki, но со временем она устарела. От платформы мы ожидали так же хорошую вёрстку статей, гибкий поиск и внутренний редактор текстов. В качестве альтернативы выбрали Confluence.

В процессе стало ясно, что возможностей этой платформы из коробки тоже недостаточно для всех наших задач. Пришлось докупить плагин Scroll Viewport и потратить некоторое время на его настройку.

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

что такое confluence простыми словами. azdnd3muoqlkshm d jppor95yw. что такое confluence простыми словами фото. что такое confluence простыми словами-azdnd3muoqlkshm d jppor95yw. картинка что такое confluence простыми словами. картинка azdnd3muoqlkshm d jppor95yw.

Меняем дизайн

Компания начала переносить документацию с движка MediaWiki на Confluence год назад. Но когда я приступила к проекту, Confluence выглядел стандартно, предыдущий разработчик добавил наш логотип и скрыл ненужные анонимному пользователю элементы. К запуску надо было привести документацию к нашему стилю. Дизайнеры подготовили макеты, а я должна была их сверстать.

Но дело в том, что сам Confluence даёт очень мало гибкости в стилях и скриптах, а возможности из коробки нетривиальны для понимания и использования, да и непривычны веб-разработчику.

Отмечу, что Confluence — это Java-приложение, а вовсе не веб-сайт с привычными бэкендом и фронтендом. В разделе Внешний вид можно добавить таблицу стилей или настроить пользовательский HTML, но этого недостаточно для полноценного редизайна. Поэтому для вёрстки мы купили плагин Scroll Viewport. Тут-то и началось самое интересное.

Плагин Scroll Viewport

Scroll Viewport — это плагин для Confluence, который позволяет создавать темы, используя привычный редактор кода и файловый менеджер. С его помощью можно писать стили, работать с шаблонами страниц, добавлять изображения, настраивать поиск.

Темы создаются для пространств. Пространства в Confluence — это сущности контента, в которых хранится информация по одному проекту. У нас есть пространство для продуктов: ISPmanager, BILLmanager и т. д., а также для главной страницы. У пространства есть ключ, заголовок, ряд настроек и, собственно, тема.

Редактирование темы в Scroll Viewport: разметка, стили и html

Начнём осваивать Scroll Viewport. Когда плагин установлен и включён, надо кликнуть на шестерёнку и далее — Основные настройки — раздел Scroll ViewportThemes.

Выбираем, копируем или создаём тему и нажимаем Edit. Открывается редактор темы Scroll Viewport.

Обратите внимание, Scroll Viewport рекомендует не создавать тему с нуля, а брать за основу Scroll WebHelp Theme.

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.
Редактор темы Scroll Viewport: слева структура темы, сверху название файла, в основной части сами файлы

Когда тема создана, можно приступить к её настройке. Зададим разметку и структуру страниц, добавим стили и скрипты, а потом перейдём к редактированию HTML-разметки элементов контента.

Разметка: редактируем, добавляем классы и выводим однотипные элементы в цикле

Структура страниц по типу

В корне темы находятся основные шаблоны: page.vm, search.vm, error.vm, а также изображение-обложка темы thumbnail.png.

Шаблон “page.vm” задаёт структуру всех страниц темы. Здесь можно редактировать html и с помощью переменных placeholders задавать, где будет выводиться контент. Плейсхолдеры обращаются к контенту пространства или данным пользователя (заголовок материала, название пространства, имя автора), с их полным списком можно ознакомиться в хелп-центре разработчика Scroll Viewport.

“page.vm” обращается к шаблонам, которые лежат на уровень ниже, в папке “include”, и оборачивает их в теги и блоки. В этом файле (page.vm) мы собираем страницу по кусочкам, и дополняем разметку всеми необходимыми атрибутами html-документа. Именно здесь мы указываем doctype, прописываем head и body.

Составные элементы страницы

В папке “include” лежат кусочки страницы. По названиям файлов можно догадаться, какой за что отвечает:

Стилизация: добавляем стили, изображения и скрипты

Внутри папки “assets” хранятся файлы js и css. Так как мы не создавали тему с нуля, там уже содержатся файлы от разработчиков Scroll Viewport.

Чтобы кастомизировать стили, лучше создать новый css-файл и подключить его в head шаблона страницы. Файлы, которые начинаются на theme, содержат в себе правила базовой темы Scroll Viewport. Их стоит редактировать в случае, когда новые стили упираются в базовые. Будьте внимательны, удаляя и добавляя правила, помните об иерархии селекторов, она может выручить.

В “assets” я также добавила папку с изображениями и папку с файлами шрифтов. Файловый менеджер работает не идеально, добавить папку в нужную директорию нельзя, поэтому пришлось схитрить. Я создала папку на своём компьютере, добавила в неё файл, а потом загрузила в нужную директорию драг-энд-дропом. Как только папка создана, с загрузкой файлов проблем нет.

При создании нового дизайна мы учитывали возможности плагина и ориентировались на уже существующие темы в Scroll Viewport, поэтому внутри assets/js я задержалась ненадолго. Внесла небольшие изменения в существующие файлы скриптов и добавила файлы нужных библиотек. Если изменения будут более значительными, со скриптами придётся разобраться детальнее.

Редактор html-разметки контента статьи

что такое confluence простыми словами. . что такое confluence простыми словами фото. что такое confluence простыми словами-. картинка что такое confluence простыми словами. картинка .

Благо, всегда можно поискать плагины, и, какая удача, нужный нашёлся почти сразу. Это Confluence Source Editor. После его установки можно в режиме редактирования статьи прошерстить и старый добрый гипертекст. Наконец-то!

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.
Плагин Source Editor

В Scroll Viewport верстаем шапку, сайдбар, футер и задаём стили. Контент верстаем с помощью Source Editor. Всего я создала две темы: для страниц статей и для главной страницы документации.

Настройки Viewport пространства: применяем тему

Когда тема создана, её надо связать с пространством. Для этого в настройках пространства нужно создать Viewport. Viewport — это то, что связывает пространство и тему. Только создав эту сущность, можно применить стили темы для пространства.

Войдите в пространство нужного продукта, откройте Настройки пространства — Дополнения. Здесь можно создать Viewport и управлять им: задавать темы, типы контента, разрешения, домен и путь.

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.
Форма для связи пространства с темой, создания Viewport

Выбрать тему

На вкладке Themes представлены все созданные темы и одна тема по умолчанию, которая появляется вместе с плагином Scroll Viewport. Выберите тему и примените к пространству.

Вкладка Content позволяет выбрать тип контента, к которому будет применяться тема. Она нам наименее интересна, так как ключ пространства подтягивается автоматически.

Настроить адреса

На вкладке URL можно выбрать домен и путь, по которому будет открываться пространство, а также задать структуру адресов. Она так же понадобится, чтобы разделить документацию на два домена по языкам.

Есть два типа структуры URL:

Но нужно учесть, что при выборе многоуровневых адресов URL будет зависим от названия статьи. Изменится название — изменится и адрес статьи. Если выбрать одноуровневую структуру, адрес будет менее читаем и понятен, но перестанет зависеть от заголовка страницы.

Мы выбрали многоуровневый тип структуры и читаемые адреса, но нам придётся следить за изменением названий статей и вовремя настраивать редиректы. И идеальный вариант мы всё ещё ищем. Мы также используем краткие ссылки, которые всегда ведут на статью и не меняются, такую ссылку можно найти в разделе Информация о странице.

Включить тему

Во вкладке Permissions можно обозначить, каким пользователям будет доступен просмотр пространства с применением Viewport.

Чтобы анонимные пользователи видели документацию только в заданном дизайне, нужно поставить две галочки:

Настраиваем разделение по языкам

В Scroll Viewport такие настройки предусмотрены, но если просто ввести отличный от основного домен во вкладке URL в поле Domain Name, два домена не заработают. Это особенность плагина Scroll Viewport.

Надо настроить Reverse proxy, чтобы запросы пользователей передавались Confluence и там разруливались на два домена — см. инструкцию Scroll Viewport (конфигурации для Nginx и TOMCAT). После этого надо выключить режим совместного редактирования или внести дополнительные изменения. Теперь можно указывать один из двух доменов в настройках Viewport.

Темы для разных языков

Применить одну тему к пространствам на разном языке не получится, потому что тема включает в себя не только стили, но и шаблоны страниц. Это означает, что язык элементов, которые выводятся не переменными, не меняется. Например, текст-плейсхолдер в строке поиска, контакты в футере и др. Так что пришлось делать отдельные темы для пространств на русском и английском языках.

Фактически я создаю идентичные по стилям темы, но вот шаблоны для них различны, в основном по части текста. Это излишество и дублирование, да, но иного способа я пока не нашла. К тому же тема регулирует и работу поиска тоже, а это ещё один аргумент в пользу разделения по языкам.

В итоге у меня получилось четыре темы: две для главных страниц на русском и английском, и ещё по две для страниц контента для каждого языка.

Настраиваем поиск по сайту

Параметры поиска настраиваются в файлах из папки “include”. Внутри них мы задаём параметры поиска:

Где искать

По умолчанию поиск работает только по текущему пространству. Например, в пространстве ISPmanager — только по статьям об ISPmanager. Если нужен поиск по списку пространств, в настройках include-quicksearch.vm нужно указать их ключи.

Форма поиска для отдельного пространства

Форма поиска по списку пространств

Как выводить результаты

Как будет выглядеть список с результатами поиска, задаёт шаблон include-search.vm. В моём случае у каждой найденной ссылки есть заголовок, описание и название пространства, к которому относится статья. Здесь же можно указать, что пользователь увидит, если поиск ничего не найдёт.

Из фрагмента шаблона ниже видно, что результаты поиска выводятся в цикле с использованием переменных-плейсхолдеров. Результатов поиска может быть довольно много, поэтому внизу страницы сделали пагинацию. Подробное руководство по шаблонам страниц поиска можно посмотреть в документации по поиску Scroll Viewport.

Как выглядит страница поиска

Все шаблоны первого уровня, расположенные в структуре рядом с page.vm, переопределяют структуру страницы в зависимости от ее типа. Так search.vm задаёт вёрстку страниц поиска, а error.vm — страниц ошибок.

Остаётся задать стили элементам, возможно добавить скрипты, и наша тема становится функциональной, выполняет задачи и выглядит согласно дизайну.

Настраиваем индексацию

Чтобы настроить индексацию, нужно положить карту сайта в корневую папку. Но у нас нет корневой папки, ведь Confluence — это Java-приложение, а не сайт. Что делать?

Подсказка нашлась в документации Scroll Viewport. Внутри пространства разводящих страниц, где хранится главная, надо создать новую статью, назвать её sitemap.xml и расположить на уровень ниже главной.

Расположение важно, потому что, как отмечают в документации, файл карты не будет доступен для Viewport с префиксом пути “/”. Как раз такой префикс у Viewport пространства главной страницы.

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.
Статья sitemap.xml в структуре пространства

Мы помним, что в Confluence заголовок статьи и её URL связаны. Когда страница создана и уже открывается по адресу docs.ispsystem.com/sitemap-xml, займёмся её корректным отображением. Такой формат URL не совсем типичен, но вполне нам подойдёт.

Карта сайта должна быть без лишних тегов и стилей, ведь она создаётся для поисковиков. Чтобы заданные раньше стили не применялись к карте сайта, надо создать шаблон include-sitemap.vm и скопировать в него содержимое подготовленной карты сайта — sitemap.xml. Это будет выглядеть следующим образом:

что такое confluence простыми словами. image loader. что такое confluence простыми словами фото. что такое confluence простыми словами-image loader. картинка что такое confluence простыми словами. картинка image loader.

Теперь для страницы sitemap.xml создадим отдельное условие в шаблоне page.vm, чтобы стили и структура из шаблонов применялись для всех страниц, кроме карты сайта.

Для условия понадобится идентификатор. Узнать его можно, открыв страницу, а затем нажав Многоточие — Информация о странице, в конце адресной строки и будет идентификатор. Теперь пишем условие:

После описанных манипуляций путь к карте сайта можно указать в панелях вебмастера Яндекс и Google, и начнётся индексация.

В целом вопрос индексации для меня остаётся открытым. Не до конца понятно, как индексируются страницы контента Confluence. Нужно подумать, как автоматизировать процесс.

Источник

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *