-
Notifications
You must be signed in to change notification settings - Fork 1
ContentModels
Matus Backor edited this page Nov 25, 2019
·
5 revisions
The main type of this section that represents a single page on the website.
Notable elements:
- Title - Text element, serves as an <h1> and is used for generating URL slug
- Short title - Text element, title shown in the navigation
- Introduction - Rich text element, introductory paragraphs that can contain Content Chunk and Callout types
- Content - Rich text element, main body of the article, can contain Content Chunk, Callout, Code Sample and Code Samples types
- Next steps - Rich text element, short summary, can contain Content Chunk, Callout, Code Sample and Code Samples types
- Platform - Taxonomy element, specifies which resources the article covers, for example .NET or JavaScript
- Visibility - Taxonomy element, determines whether the article is findable through KCD search and whether it should be displayed in the navigation
Describes the top level scenarios within the Tutorials section.
Notable elements:
- Title - Text element, serves as an <h1> and is used for generating URL slug
- Short title - Text element, title shown in the navigation
- Introduction - Rich text element, introductory paragraphs that can contain Content Chunk and Callout types
- Content - Rich text element, main body of the scenario, can contain Content Chunk, Callout, Code Sample and Code Samples types
- Visibility - Taxonomy element, determines whether the scenario is findable through KCD search and whether it should be displayed in the navigation
Serves as a piece of text that can be reused. It can also can be targetted only at a specific platform.
Notable elements:
- Content - Rich text element, can contain Callout, Code Sample and Code Samples types
- Platform - Taxonomy element, specifies which resources the article covers, for example .NET or JavaScript
Multiple different content types are a part of this section. In general, they vaguely mirror the OpenAPI specification version 3.
A tip, warning, or other distinctive piece of information.
Notable elements:
- Content - Rich text element
- Type - Multiple choice element, specifies the callout's color and significance
Describes content of a code block in a single language. Notable elements:
- Code - Text element
- Programming language - Taxonomy element, the programming language that the code is written in
- Platform - Taxonomy element, the technology of the code sample
Serves as a wrapper for multiple code sample items that describe a single scenario in multiple languages.
- Code Samples - Linked items element that contains specific Code Sample items
- Overview
- Website
- Dispatcher
- Notifier
- Search Functionality
- GitHub Integration
- Bulk Publishing / Scheduling to Publish
- API Reference
- Integration Tests
- Content Models