-
Notifications
You must be signed in to change notification settings - Fork 21
Contributors cheatsheet
Peter Milchev edited this page Aug 30, 2021
·
3 revisions
This is a quick summary of the main structure of this repository.
- _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
- use
- 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 }}
- Content pages are loaded in
- Adding a query string -
{{randomNumber}}
in _layouts/default.html
- 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
- 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
- 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
- _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
- 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 image location - https://hub.docker.com/r/progressdocs/docs-seed
- Docker config file - https://github.com/telerik/docs-seed/blob/master/Dockerfile