Инструкции по переносу вики Confluence в IBM Connections

С прекращением поддержки системы вики Confluence на портале developerWorks владельцам групповых и индивидуальных страниц придется переносить свои данные в систему вики IBM Connections. В этой статье содержатся необходимые инструкции.

Дженнифер Хейнс, разработчик информации, IBM China

Дженнифер Хейнс (Jennifer Heins) ― старший инженер IBM, специализирующийся на отношении пользователей и удобстве коллективной работы с информацией. Она была организатором проекта вики Product Documentation для всех программных продуктов IBM Collaboration Solutions и Lotus. С момента своего прихода в IBM в 1998 году неустанно работает над совершенствованием способов представления технической информации IBM ― от стандартных методов публикации Web-сайтов до систем коллективной работы. Ее опыт в области информационной архитектуры, мобильной информации, архитектуры программного обеспечения и проектирования пользовательского интерфейса позволяет ей вносить вклад в решение самых разнообразных задач.



11.03.2013

Обзор процесса переноса

  1. Создание таблицы статей, подлежащих переносу
  2. Подготовка материалов к переносу
  3. Перенос материалов
  4. Окончательная очистка
  5. Переадресация с Confluence на Connections

Создание таблицы статей, подлежащих переносу

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

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

Образец таблицы статей
Название статьи Подготовка к переносу Перенос Исправление ссылок Исправление изображений и вложений Удаление значков внешних ссылок Примечания/статус
Основные понятия и термины Слияние в новую тему "Обзор"
  • Ссылка на план
  • Ссылка на FAQ
Изображений нет В процессе

Подготовка материалов к переносу

Лучше всего обновить или объединить статьи в Confluence до начала переноса. На этом этапе нужно сосредоточиться на содержании статей. Актуальна ли еще эта информация? Есть неработающие ссылки? Нужно ли объединить статьи? Лучше внести все эти изменения, пока статьи остаются на месте. Предварительная подготовка также означает, что когда вы начнете перенос, вам придется решать только задачи, связанные с переносом, не беспокоясь о точности информации.

Просмотрите статьи, обращая внимание на следующие моменты.

  1. Убедитесь, что материалы точны и отформатированы так, как они должны выглядеть в Confluence перед переносом. Заранее решив вопросы форматирования, вы позже сможете сконцентрироваться на задачах переноса.
  2. Переименуйте страницы. Это позволит вам успешно связать статьи между собой. Connections не обновляет ссылки на статью при изменении ее названия, как Confluence.
  3. Проверьте ссылки и убедитесь, что они нужны. После переноса все ссылки на перенесенные статьи вики нужно будет обновить.
    • Укажите в таблице статей, какие ссылки потребуют обновления. Поместите эту информацию в столбец "Исправление ссылок".
    • Ссылки на внешние ресурсы обновлять не обязательно.
  4. Удалите ссылки автоматических оглавлений, имеющиеся в Confluence. Это якорные ссылки, которые переносят пользователей вниз страницы, и в вики Connections их эквивалент отсутствует.
    • Вы можете сохранить эти ссылки, но после переноса каждую из них придется исправлять.
  5. Как можно больше упростите форматирование и стилевое оформление материала. Некоторых элементов форматирования, присутствующих в Confluence, в вики Connections может не оказаться. Все форматирование будет перенесено, но может потребоваться его сохранение в HTML, а не в вики-разметке. Вики Connections могут не иметь эквивалентной вики-разметки для всего, что было в Confluence. Примеры:
    • разделы и столбцы преобразуются в таблицы, и их необходимо будет оформлять как таблицы;
    • стилевое оформление, такое как цвет фона заголовков, который был установлен в присоединенной таблице стилей.
  6. Исправьте все ссылки на другие вики-статьи, снабженные значком внешней ссылки. Ссылки на другие статьи могли быть случайно созданы с использованием полного URL-адреса статьи, а не просто ссылки на wiki-статью по названию. В вики Confluence все ссылки, которые начинаются с http://, помечаются как внешние и снабжаются значком внешней ссылки. Этот значок будет перенесен, что не желательно, если это внутренняя статья. Если есть такие ссылки на другие вики-статьи, исправьте их сейчас. Для этого отредактируйте статью в Confluence и удалите полный URL-адрес, оставив только ссылку на название статьи. Пример:
    • до: [Learn now to submit a request|http://www.example.com/wiki/Request+or+track+new+information]
    • после: [Learn now to submit a request|Request or track new information]

Перенос материалов

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

  1. Создайте в вики Connections новую статью-«заготовку» и присвойте ей название переносимой статьи. Пока не помещайте в нее никакой информации или поместите только заполнитель «Готовится к публикации» и сохраните статью. Я рекомендую это по следующим причинам:
    1. Пока статья не сохранена в первый раз, ее не существует. После первого сохранения функция автосохранения поможет гарантировать, что изменения не потеряются, если что-то произойдет с браузером.
    2. На данном этапе можно создать много статей-«заготовок». Это позволит вам сосредоточиться в первую очередь на навигации по статьям.
  2. Скопируйте страницу из вики Confluence.
    1. Перейдите к странице в Confluence. НЕ входите в режим редактирования.
    2. Выделите весь текст, включая изображения, таблицы и т.д., который нужно перенести, и скопируйте его. НЕ копируйте никакие элементы пользовательского интерфейса вики Confluence.
    3. НЕ копируйте сгенерированное оглавление в верхней части статьи (если только вы не хотите обновить эти ссылки). Если сгенерированное оглавление все же оказалось скопированным, удалите его во время очистки.
  3. Вставьте страницу в вики Connections.
    1. Найдите в вики Connections статью-заготовку.
    2. Перейдите в режим редактирования статьи-заготовки.
    3. Вставьте содержимое в режиме Rich Text (форматированный текст).
    4. Просмотрите содержание, но не вносите много изменений, потому что после сохранения статья может выглядеть немного иначе. Если вы обнаружили, что скопировали слишком много или слишком мало, не пытайтесь исправить статью. Отмените правку, скопируйте текст снова и вставьте еще раз.
  4. Нажмите кнопку Save and Close (сохранить и закрыть).
  5. При необходимости внесите мелкие исправления. Опять же, если изменений много, лучше удалите все содержимое статьи и повторите попытку.
  6. Когда статья успешно перенесена, обновите столбец "Перенос" в таблице статей.

Примечание. Содержание переносится как простой HTML. В этом можно убедиться, просмотрев исходный HTML-код в режиме редактирования в Connections. Темы со сложным форматированием будут иметь сложный HTML-код, которым не так легко управлять, как в Confluence. Потому что в Connections нет эквивалентной вики-разметки для всего, что было в Confluence.

На второй взгляд могут появиться дополнительные изменения, которые нужно сделать перед переносом. Это нормально. Проверьте страницу после ее сохранения в Connections. Если что-то нужно изменить, внесите изменения в Confluence и повторите перенос. Чтобы заменить уже перенесенный материал, выберите все и удалите, затем вставьте новый текст.


Окончательная очистка

На этом этапе статья редактируется в Connections. Этот процесс должен занять около 5 минут на статью.

  1. Исправьте ссылки между вики-статьями, указав на новые статьи в вики Connections.
    • НЕ изменяйте ссылки на страницы, которые останутся в Confluence или являются внешними по отношению к вики Connections.
    • Сделайте это после переноса статьи, на которую вы ссылаетесь, чтобы ее можно было найти в вики Connections.
    • Для отслеживания ссылок, которые необходимо обновить в каждой статье, используйте таблицу статей. Это поможет следить за тем, что осталось почистить.
    • Чтобы сослаться на статью в вики Connections:
      1. Перейдите в режим редактирования.
      2. Для существующей ссылки поместите курсор на ссылку и щелкните на значке ссылки в редакторе форматированного текста или щелкните правой кнопкой мыши, чтобы изменить ссылку. Для новой ссылки выделите текст, который должен стать ссылкой, и выберите значок ссылки в редакторе форматированного текста или щелкните правой кнопкой мыши.
      3. Выберите вкладку Wiki Page и найдите вики-статью, на которую нужно сослаться.
      4. Перейдите на нужную страницу в этой статье. В процессе работы новые вики-статьи отображаются в верхней части списка, что упрощает их поиск.
      5. Выберите страницу и нажмите кнопку ОК.
  2. Удалите ссылки автоматических оглавлений, имеющиеся в Confluence. Это якорные ссылки, которые переносят пользователя вниз страницы, но они связаны с вики Confluence. Исправьте или удалите каждую ссылку.
  3. Исправьте ссылки на изображения и вложения. Все перенесенные изображения указывают на Confluence.
    • Прикрепите изображения к статье Connections и дайте ссылку на них:
      1. Сохраните изображения локально.
      2. Загрузите изображение в статью вики Connections.
      3. Дайте ссылку на вложенное изображение.
    • Прикрепите вложения к статье вики Conenctions и дайте ссылку на них:
      1. Сохраните вложение локально.
      2. Загрузите вложение статью вики Connections.
      3. Дайте ссылку на это вложение.
  4. Удалите значки внешних ссылок со стрелкой, которые могли скопироваться.
  5. Обновите порядок навигации. Вики Connections позволяет управлять порядком навигации по записям. Измените порядок следования статей при навигации.
    • Переместите страницы между партнерами.
      1. Перейдите на страницу, которую нужно переместить.
      2. Выберите пункт Page Actions > Move This Page (Действия со страницами > Переместить эту страницу).
      3. Перейдите в раздел Reorder Peer Pages (Переупорядочить страницы партнеров) и нажмите кнопку стрелки вверх или вниз для перемещения страниц между партнерами.
      4. Когда закончите, нажмите кнопку Move (переместить).
    • Переместите страницу вверх или вниз по уровням навигации.
      1. Перейдите на страницу, которую нужно переместить.
      2. Выберите пункт Page Actions > Move This Page (Действия со страницами > Переместить эту страницу).
      3. Перейдите в раздел Find Parent Page (Найти родительскую страницу) и нажмите кнопку Browse, чтобы выбрать новую родительскую страницу для страницы, которую нужно переместить вверх или вниз.
      4. Когда закончите, нажмите кнопку Move (переместить).

Переадресация с Confluence на Connections

Никогда не известно, у кого есть закладка на данную статью. Поэтому лучше добавить к новой статье в Connections ссылку на статью в Confluence.

  1. По завершении переноса каждой статьи обновите ее в Confluence.
  2. Отредактируйте статью в вики Confluence.
  3. Пользуясь вики-разметкой, поместите следующее объявление в верхней части страницы:

    {info:title=Эта информация перенесена}
    [Эта информация перенесена сюда|<ссылка на тему в новых вики>]
    {info}

Комментарии

developerWorks: Войти

Обязательные поля отмечены звездочкой (*).


Нужен IBM ID?
Забыли Ваш IBM ID?


Забыли Ваш пароль?
Изменить пароль

Нажимая Отправить, Вы принимаете Условия использования developerWorks.

 


Профиль создается, когда вы первый раз заходите в developerWorks. Информация в вашем профиле (имя, страна / регион, название компании) отображается для всех пользователей и будет сопровождать любой опубликованный вами контент пока вы специально не укажите скрыть название вашей компании. Вы можете обновить ваш IBM аккаунт в любое время.

Вся введенная информация защищена.

Выберите имя, которое будет отображаться на экране



При первом входе в developerWorks для Вас будет создан профиль и Вам нужно будет выбрать Отображаемое имя. Оно будет выводиться рядом с контентом, опубликованным Вами в developerWorks.

Отображаемое имя должно иметь длину от 3 символов до 31 символа. Ваше Имя в системе должно быть уникальным. В качестве имени по соображениям приватности нельзя использовать контактный e-mail.

Обязательные поля отмечены звездочкой (*).

(Отображаемое имя должно иметь длину от 3 символов до 31 символа.)

Нажимая Отправить, Вы принимаете Условия использования developerWorks.

 


Вся введенная информация защищена.


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=40
Zone=XML
ArticleID=861038
ArticleTitle=Инструкции по переносу вики Confluence в IBM Connections
publish-date=03112013