-
Notifications
You must be signed in to change notification settings - Fork 21
Call To Action(CTA) panels
The Call to Action panels are small portions of HTML on the page with the purpose of engaging new clients to go and start a Trial.
To enable the automatic rendering of CTA panels, you need to:
- Go to the
_config.yml
file of your product's documentation repository - Set
has_cta_panels: true
Then, you just need to:
- Trigger the Jenkins build for your documentation and eventually
- Promote the result production, if the result in the test environment is correct
Voila, you have automatic CTA panels now :)
The text and avatar are controlled by the data in _data/support_products.yml
The data relies on the product name set in the
_config.yml
file
The options for avatar
are Kendoka
, DevCraft
, and Ninja
.
cta_panels_data:
"ProducName":
message: "Message after <Product is a>"
trial_url: "https://www.telerik.com/download-trial-file/v2-b/ui-for-asp.net-ajax"
product_url: "https://www.telerik.com/products/aspnet-ajax.aspx"
avatar: "Ninja"
In case the position of the default panel is wrong or could be placed better, you can add the following code inside the .md file in question:
Note: the
if
is needed only for cases where you want to hide all CTA panels, automatic and manual, when the has_cta_panels is not set to true
- Main CTA:
{% if site.has_cta_panels == true %}
{% include cta-panel-main.html %}
{% endif %}
- Rest CTA:
{% if site.has_cta_panels == true %}
{% include cta-panel-rest-of-pages.html %}
{% endif %}
The only thing you need to do is either remove has_cta_panels
from your _config.yml file or set it to false
Note: If you did not wrap the manually added
{% include <cta-panel-path.html> %}
insideif
conditions, you need to go and remove all such instances manually