3 Contributors cheatsheet

Peter Milchev редактировал(а) эту страницу 2021-08-30 17:31:13 +03:00

Содержание

• Assets and resources
• Cache busting
• Adding new assets
• Documentations build location
• API reference generation
• API reference builds
• Offline documentation
• Docker

This is a quick summary of the main structure of this repository.

Assets and resources

• _assets/js/main.js lists required scripts
• All JavaScript, CSS, font files are located in the _assets folder
• The Kendo UI TreeView (used for left navigation) is loaded from _assets folder
• The kendo.web.min.js can be loaded if explicitly enabled
  • use cdnVersion in config.yml to set a version
  • scripts are loaded if site.enable_dojo == true or page.sdk_example == true
• The site variable is equivalent to the properties in the _config.yml file
• Layout page(MasterPage) - _layout/default.hmlt
  • Content pages are loaded in {{ content }}

Cache busting

• Adding a query string - {{randomNumber}} in _layouts/default.html

Adding new assets

• Add them in _layouts/to_delete.html
  • If you receive 404 error for newly added assets, verify you add them in this file
  • This is a dirty hack to overcome the Jekyll build not recognising URLs with placeholder as needed resources

Documentations build location

• Desktop teams' documentation builds are located in bpcvsx01:8080/view/Documentations (cannot be accessed via VPN, needs explicit IP permissions)
• Kendo, Blazor, and AJAX are in the Kendo Jenkins

API reference generation

• Kendo - _plugins/api_generator.rb
• AJAX - custom build generates .md files
• Blazor, DPL and Desktop products - Use DocFX to generate API ref directly as HTML, then the build just adds the files

API reference builds

• _buildAPI/Tools
• _buildAPI/template.json za DocFX to configure the generation
• buildApiReference.proj is executed to produce the API ref in DocFX based docs
• Build name convention
  • Docs_ProductName_Content for documentation only
  • Docs_ProductName_Full for documentation and API generation

Offline documentation

• repository - https://github.com/telerik/offline-docs
• Build location - bpcvsx01:8080/view/PDF
• Document Processing Library and AngleSharp used to generate PDF from the generated .html files from the docs builds

Docker

• Docker image location - https://hub.docker.com/r/progressdocs/docs-seed
• Docker config file - https://github.com/telerik/docs-seed/blob/master/Dockerfile

1. Home
2. Handling Redirects
3. Markdown Syntax
   • Basics
   • Custom Syntax—Alerts
   • Custom Syntax—Captions
   • Custom Syntax—Code Snippets
   • Custom Syntax—Tabbed Code Snippets
   • Custom Syntax—Linking Internal Articles
4. Markdown Nesting
   • Lists: Basic Nesting
   • Lists: Nesting Images
   • Lists: Nesting Tables
   • Lists: Nesting Code Snippets
   • Alerts: Nesting Lists
5. Using Templates
   • In-article Syntax
   • Creating Templates
   • Using Arguments
   • Reusing Templates
   • Examples
   • Good Practices
6. Features Guide
   • CTA Panels
   • Documentation Migration Steps
   • Yellow Ribbon Bar
7. Workflow and Processes
8. Contribution Cheatsheet