Skip to content

Documentation Migration Steps

Todor Mitev edited this page Nov 30, 2018 · 2 revisions

In order to migrate an existing documentation, it is necessary to follow the steps below:

Step 1

  • Remove all the Jekyll related folder and files in the existing documentation folder
    • _assets/
    • _includes/
    • _layouts/
    • _plugins/
    • Gemfile and Gemfile.lock
  • Open _config.yml file and:
    • Change the default layout for all pages to documentation
    • Rename "google_custom_search" property to "gcs_engine"
    • If the documentation has a Knowledge Base portal, add the corresponding property: has_kb_portal: true
    • Add the product property (if not existing) (e.g. product: "Telerik UI for WinForms")
    • Add the platform property (e.g. platform: winforms)
    • Add the download property which indicates from where the product could be downloaded (e.g. download: https://www.telerik.com/download-trial-file/v2-b/ui-for-winforms)

Step 2 Builds