Документерра: руководство пользователя

Резервное копирование проектов

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

Файлы, полученные из резервной копии проекта, включая тематические HTML-файлы, не предназначены для читателей, поскольку они являются только «техническими» файлами. Если вы хотите экспортировать HTML-контент страниц, вам нужно вместо этого создать документ в формате HTML.
Возможно, вы захотите использовать резервную копию проекта по разным причинам, например, сохранить данные проекта перед внесением существенных изменений или если вам больше не нужен конкретный проект и вы хотите удалить его с портала, сохранив данные под рукой. Кроме того, существует множество вариантов, когда эта функциональность может пригодиться.

Объединение проектов
Можно объединить несколько проектов в один, используя функцию резервного копирования проектов. Загрузите резервные копии проектов, которые вы хотите объединить, а затем импортируйте их в один проект!

Хранение данных в Git

Если вы хотите сохранить документацию вместе с кодом или создать историю своих проектов, функция резервного копирования проектов также может служить этой цели!
Также возможно объединение проектов с Git.

Перенос проектов между порталами
Если у вас несколько порталов в системе Документерра и вы хотите перенести свои проекты из одного в другой, вы можете это сделать, загрузив резервные копии этих проектов и импортировав их на другой портал.

Перенос данных в другие инструменты создания документации

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

Обработка контента

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

Обработка переводов проектов

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

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

Ограничения резервного копирования проектов

Функция резервного копирования проектов имеет некоторые ограничения:

Если у вас есть ссылки на страницы-сниппеты, расположенные в других проектах, эти страницы-сниппеты не включаются в резервную копию. Однако ссылки сохраняются.

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

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

История версий страницы не является частью резервных копий.

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

Особенности импорта резервных копий проектов

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

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

Если вы импортируете резервную копию проекта на другой портал и в полях «Исполнитель» и «Владелец» указан определенный пользователь, которого нет на новом портале, соответствующие поля будут заполнены текущим пользователем. Система выдает предупреждающие сообщения по таким полям «Исполнителя» и «Владельца».

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

Объединение проектов	Можно объединить несколько проектов в один, используя функцию резервного копирования проектов. Загрузите резервные копии проектов, которые вы хотите объединить, а затем импортируйте их в один проект!
Хранение данных в Git	Если вы хотите сохранить документацию вместе с кодом или создать историю своих проектов, функция резервного копирования проектов также может служить этой цели! Также возможно объединение проектов с Git.
Перенос проектов между порталами	Если у вас несколько порталов в системе Документерра и вы хотите перенести свои проекты из одного в другой, вы можете это сделать, загрузив резервные копии этих проектов и импортировав их на другой портал.
Перенос данных в другие инструменты создания документации	Функция резервного копирования проекта может стать промежуточным шагом при переносе данных из Документерры в другой инструмент для создания справочной документации. Таким образом, все пользовательские условные и динамические элементы навигации Документерры сохраняются и не преобразуются в статический HTML-код.
Обработка контента	Некоторые сложные операции по обработке контента могут быть возможны только за пределами Документерры с использованием сторонних инструментов. В этом случае вы можете загрузить резервную копию проекта, получить HTML-код и выполнить необходимые операции непосредственно в исходном коде.