Documentation Migration Steps

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)
  • Add the nav property in order to visualize the buttons in the main top navigation, where the 'key' column is the button (link) text and the 'value' column is the respective URL (e.g:

nav:

"Demos": https://telerik-winforms-demos.s3.amazonaws.com/TelerikWinFormsExamplesLauncher.exe
"Release History": https://www.telerik.com/support/whats-new/winforms/release-history
"About": https://www.telerik.com/products/winforms.aspx
"Pricing": https://www.telerik.com/purchase/individual/winforms.aspx

• Add the social icons by adding the following:

footer_social:

  facebook: https://www.facebook.com/Telerik/
  youtube: https://www.youtube.com/user/TelerikInc
  linkedin: https://www.linkedin.com/showcase/telerik/ 
  twitter: https://twitter.com/Telerik/ 

• Add the footer property with items which describe the columns title and links

For reference, you can use the Telerik UI for WinForms _config.yml file.

Step 2 Builds