Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refresh Documentation Main Page #95

Merged
merged 1 commit into from
Nov 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 39 additions & 2 deletions _index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,43 @@ menu:
---
-->
<!-- markdownlint-disable-file MD041 -->
CDEvents specification
<!-- cSpell:locale en-US -->
Welcome to the CDEvents specification documentation for release {{< param "version" >}}. Here, you can find all the information necessary to understand and implement CDEvents within your application. For those new to CDEvents, we recommend starting with the [White Paper](wpaper/) and the [Primer](primer/), to help you rapidly understand the concepts.

Note that CDEvents builds upon <a href="https://cloudevents.io/" target="_blank">CloudEvents</a>, so it may be helpful to have some understanding of that specification first.

To help you get up to speed quickly, we have broken the specification down into bite-sized chunks. The sections below will help you navigate to the information that you need.
<br><br>

{{% blocks/section type="section" color="white" %}}
{{% cardpane %}}
{{< blocks/feature icon="fa-solid fa-file-word" title="[White Paper](wpaper/)" >}}
The Continuous Delivery Foundation White Paper on CDEvents<br><br>
{{< /blocks/feature >}}
{{< blocks/feature icon="fa-solid fa-graduation-cap" title="[Primer](primer/)" >}}
An introduction to CDEvents and associated concepts<br><br>
{{< /blocks/feature >}}
{{< blocks/feature icon="fas fa-info-circle" title="[Common Metadata](spec/)" >}}
An overview of Metadata common across the CDEvents Specification<br><br>
{{< /blocks/feature >}}
{{< blocks/feature icon="fa-solid fa-bars-staggered" title="[Core Events](core/)" >}}
Definition of specific events that are fundamental to pipeline execution and orchestration<br><br>
{{< /blocks/feature >}}
{{< blocks/feature icon="fa-solid fa-code-branch" title="[Source Code Control Events](source-code-version-control/)" >}}
Handling Events relating to changes in version management of Source Code and related assets<br><br>
{{< /blocks/feature >}}
{{< blocks/feature icon="fa-solid fa-network-wired" title="[Continuous Integration Events](continuous-integration-pipeline-events/)" >}}
Handling Events associated with Continuous Integration activities, typically involving build and test<br><br>
{{< /blocks/feature >}}
{{< blocks/feature icon="fa-solid fa-satellite-dish" title="[Continuous Deployment Events](continuous-deployment-pipeline-events/)" >}}
Handling Events associated with Continuous Deployment activities<br><br>
{{< /blocks/feature >}}
{{< blocks/feature icon="fa-solid fa-arrow-right-arrow-left" title="[CloudEvents Binding and Transport](cloudevents-binding/)" >}}
Defining how CDEvents are mapped to CloudEvents for transportation and delivery<br><br>
{{< /blocks/feature >}}
{{< blocks/feature icon="fa-solid fa-rocket-launch" >}}
[<img src="https://raw.githubusercontent.com/cdfoundation/artwork/main/cdevents/horizontal/color/cdevents_horizontal-color.svg" alt="CDEvents logo"/>](/)
{{< /blocks/feature >}}
{{% /cardpane %}}
{{% /blocks/section %}}

<img src="https://raw.githubusercontent.com/cdfoundation/artwork/main/cdevents/horizontal/color/cdevents_horizontal-color.svg" alt="CDEvents logo" width="400"/>
2 changes: 2 additions & 0 deletions cloudevents-binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
---
linkTitle: "CloudEvents Binding"
weight: 100
hide_summary: true
icon: "fa-solid fa-arrow-right-arrow-left"
description: >
CloudEvents Binding for CDEvents
---
Expand Down
2 changes: 2 additions & 0 deletions continuous-deployment-pipeline-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
---
linkTitle: "Continuous Deployment Events"
weight: 60
hide_summary: true
icon: "fa-solid fa-satellite-dish"
description: >
Continuous Deployment Events
---
Expand Down
2 changes: 2 additions & 0 deletions continuous-integration-pipeline-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
---
linkTitle: "Continuous Integration Events"
weight: 50
hide_summary: true
icon: "fa-solid fa-network-wired"
description: >
Continuous Integration Events
---
Expand Down
2 changes: 2 additions & 0 deletions core.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
---
linkTitle: "Core Events"
weight: 30
hide_summary: true
icon: "fa-solid fa-bars-staggered"
description: >
Continuous Delivery Core Events
---
Expand Down
2 changes: 2 additions & 0 deletions primer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
---
linkTitle: "Primer"
weight: 20
icon: "fa-solid fa-graduation-cap"
hide_summary: true
description: >
A CDEvents primer
---
Expand Down
10 changes: 6 additions & 4 deletions source-code-version-control.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
<!--
---
linkTitle: "Source Code Version Control Events"
linkTitle: "Source Code Control Events"
weight: 40
hide_summary: true
icon: "fa-solid fa-code-branch"
description: >
Source Code Version Control Events
Source Code Control Events
---
-->
# Source Code Version Control Events
# Source Code Control Events

Source Code Version Control events includes the subjects and predicates related to changes in Source Code repositories that are relevant from a Continuous Delivery perspective.
Source Code Control events includes the subjects and predicates related to changes in Source Code repositories that are relevant from a Continuous Delivery perspective.

## Subjects

Expand Down
2 changes: 2 additions & 0 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
---
linkTitle: "Common Metadata"
weight: 30
icon: "fas fa-info-circle"
hide_summary: true
description: >
Introduction to CDEvents and specification of common metadata
---
Expand Down
13 changes: 13 additions & 0 deletions wpaper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!--
---
linkTitle: "White Paper"
weight: 10
hide_summary: true
icon: "fa-solid fa-file-word"
description: >
CDEvents White Paper
---
-->
<!-- markdownlint-disable-file MD041 -->

{{< iframe src="../CDEvents_Whitepaper.pdf" >}}