diff --git a/docs/plugins/_index.md b/docs/plugins/_index.md index becd217a..936e6611 100644 --- a/docs/plugins/_index.md +++ b/docs/plugins/_index.md @@ -8,6 +8,8 @@ hideChildren: true # Plugins +## Data sources and content providers + Fabric plugins implement various [data sources]({{< ref "data-sources.md" >}}) and [content providers]({{< ref "content-providers.md" >}}): - **data sources** are integrations responsible for loading data from the file, external service, API, or data storage. diff --git a/docs/templates.md b/docs/templates.md new file mode 100644 index 00000000..c76bc858 --- /dev/null +++ b/docs/templates.md @@ -0,0 +1,30 @@ +--- +title: Templates +description: Discover a diverse range of data sources within Fabric plugins. These integrations empower you to effortlessly load data from files, external services, APIs, and data storage systems. Simplify your data retrieval process and enhance your document generation workflow with Fabric's versatile data sources. +type: docs +weight: 60 +--- + +# Templates + +Fabric templates are the blueprints for configuring and generating documents. They offer a structured framework for defining data requirements, content structures, and rendering specifications within the [Fabric Configuration Language]({{< ref "language" >}}). + +With Fabric templates, users can streamline their document generation process, ensuring consistency, accuracy, and scalability. + +
+ Fabric template code + Rendered Fabric template +
+ +## Templates repository + +[Fabric Templates](https://github.com/blackstork-io/fabric-templates) repository contains use-case focused open-source templates for Fabric and is a great place to start: + +- Cyber Threat Intelligence: + - MITRE CTID CTI Blueprints ([source](https://mitre-engenuity.org/cybersecurity/center-for-threat-informed-defense/our-work/cti-blueprints/)) + - [Campaign Report Template](https://github.com/blackstork-io/fabric-templates/tree/main/cybersec/cti/mitre-ctid-campaign-report.fabric) ([example](https://github.com/blackstork-io/fabric-templates/tree/main/cybersec/cti/mitre-ctid-campaign-report-example.md)) + - [Executive Report Template](https://github.com/blackstork-io/fabric-templates/tree/main/cybersec/cti/mitre-ctid-executive-report.fabric) ([example](https://github.com/blackstork-io/fabric-templates/tree/main/cybersec/cti/mitre-ctid-executive-report-example.md)) + - [Intrusion Analysis Report Template](https://github.com/blackstork-io/fabric-templates/tree/main/cybersec/cti/mitre-ctid-intrusion-analysis-report.fabric) ([example](https://github.com/blackstork-io/fabric-templates/tree/main/cybersec/cti/mitre-ctid-intrusion-analysis-report-example.md)) + - [Threat Actor Profile Report Template](https://github.com/blackstork-io/fabric-templates/tree/main/cybersec/cti/mitre-ctid-threat-actor-profile-report.fabric) ([example](https://github.com/blackstork-io/fabric-templates/tree/main/cybersec/cti/mitre-ctid-threat-actor-profile-report-example.md)) +- SecOps: + - [Weekly Activity Overview Template](https://github.com/blackstork-io/fabric-templates/tree/main/cybersec/secops/weekly-activity-overview-elastic-security.fabric) ([example](https://github.com/blackstork-io/fabric-templates/tree/main/cybersec/secops/weekly-activity-overview-elastic-security-example.md)) diff --git a/docs/tutorial.md b/docs/tutorial.md index c8833f48..3b99ba66 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -142,11 +142,11 @@ There are 8 planets and 146 moons in our solar system. ## Content providers -Fabric seamlessly integrates with external APIs for content generation. An excellent example is the utilization of the OpenAI API to dynamically generate text through prompts. +Fabric seamlessly integrates with external APIs for content generation. An excellent example is the use of the OpenAI API to dynamically generate text through prompts. In scenarios where providing the exact text or a template string for the content block proves challenging or impossible, leveraging generative AI for summarization becomes invaluable. This enables users to dynamically create context-aware text. -In this tutorial, we will utilize the [`openai_text`]({{< ref "plugins/openai/content-providers/openai_text" >}}) content provider, allowing us to generate text with the OpenAI Language Model (LLM). +In this tutorial, we will use the [`openai_text`]({{< ref "plugins/openai/content-providers/openai_text" >}}) content provider to generate text with the OpenAI Large Language Model (LLM). ### Installation @@ -285,7 +285,7 @@ document "greeting" { } ``` -To render the document, `OPENAI_API_KEY` environment variable must be set. A simple way to do that, is to set it for each execution: +To render the document, `OPENAI_API_KEY` environment variable must be set. A simple way to do that, is to set it for each `fabric` command execution: ```shell $ OPENAI_API_KEY="" fabric render document.greeting @@ -320,8 +320,8 @@ An excellent choice for macOS users is [MacDown](https://macdown.uranusjr.com/), # Next steps -Congratulations! By completing this tutorial, you've gained a solid understanding of Fabric and its core principles. +Congratulations! By completing this tutorial, you've gained a good understanding of Fabric and its core principles. -Explore the open-source templates in the [Fabric Templates](https://github.com/blackstork-io/fabric-templates) GitHub repository. You can reuse entire documents or specific blocks in your own templates! +Take a look at the detailed [FCL specification]({{< ref "language" >}}), explore [the open-source templates]({{< ref "templates" >}}) the community made, and see if there are integrations for your tech stack in [Fabric plugins]({{< ref "plugins" >}}). If you have any questions, feel free to ask in the [Fabric Community Slack](https://fabric-community.slack.com/) and we'll be glad to assist you!