Skip to content

Commit

Permalink
Add SPDX tags (#28)
Browse files Browse the repository at this point in the history
  • Loading branch information
marbre authored Oct 11, 2023
1 parent 5e7fc59 commit 68ab87a
Show file tree
Hide file tree
Showing 25 changed files with 100 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
<div align="center">

Production Flow Description Language
Expand Down
4 changes: 4 additions & 0 deletions docs/examples/concurrency_and_synchronization.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Concurrency and Synchronization

As already stated in the [parallel](../pfdl/parallel.md) section, there is no keyword for the synchronization. The next statement after a parallel block is only started if all concurrently running tasks are finished.
Expand Down
4 changes: 4 additions & 0 deletions docs/examples/control_structures.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Control structures

## Condition
Expand Down
4 changes: 4 additions & 0 deletions docs/examples/introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Introduction

In this section complete PFDL programs are presented to give a better understanding.
Expand Down
4 changes: 4 additions & 0 deletions docs/examples/task_input_and_output.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Task input and output

Tasks can define an Input and an Output to pass data when calling each other.
Expand Down
4 changes: 4 additions & 0 deletions docs/getting_started/architecture.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
<style>
.figure{
width: 100%;
Expand Down
4 changes: 4 additions & 0 deletions docs/getting_started/ci_cd.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
<style>
.figure{
width: 80%;
Expand Down
4 changes: 4 additions & 0 deletions docs/getting_started/glossary.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Glossary

## Data Life Cycle Object (DLCO)
Expand Down
4 changes: 4 additions & 0 deletions docs/getting_started/installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
<style>
.figure{
width: 70%;
Expand Down
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
---
hide:
- navigation
Expand Down
4 changes: 4 additions & 0 deletions docs/pfdl/comments.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Comments

A comment starts with a hash character (`#`) that is not part of a string literal, and ends at the end of the physical line.
Expand Down
4 changes: 4 additions & 0 deletions docs/pfdl/condition.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Condition
Because some production steps needs to fulfill conditions sometimes there is a control structure `Condition` for this specific case.
The `Condition` block consists of a `Condition` which includes a boolean expression, a `Passed` block in which instructions are given for the case that the boolean expression evaluates to True.
Expand Down
4 changes: 4 additions & 0 deletions docs/pfdl/introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
<style>
.figure_1{
width: 60%;
Expand Down
4 changes: 4 additions & 0 deletions docs/pfdl/loop.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Loop
To execute statements for a specified number of repetitions, the usage of the `Loop` keyword is required.
There are two types of loops available: Counting Loops and While Loops.
Expand Down
4 changes: 4 additions & 0 deletions docs/pfdl/parallel.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Parallel
To exexute Tasks in parallel the `Parallel` keyword is used.
All Tasks within a Parallel block will be executed concurrently by the Scheduler.
Expand Down
4 changes: 4 additions & 0 deletions docs/pfdl/service.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Service

A Service in the PFDL corresponds to a service in a service oriented architecture.
Expand Down
4 changes: 4 additions & 0 deletions docs/pfdl/struct.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Structs

A struct is a collection of variables.
Expand Down
4 changes: 4 additions & 0 deletions docs/pfdl/task.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Task
A Task is an executable unit which executes the statements within sequentially.
The name of the Task should be a [lowercase string](../#allowed-characters).
Expand Down
4 changes: 4 additions & 0 deletions docs/scheduler/api.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# PFDL Scheduler API

In this section further information about the functions that can be used from the PFDL Scheduler is given.
Expand Down
4 changes: 4 additions & 0 deletions docs/scheduler/dashboard.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
<swagger-ui src="../../api_spec/http-rest-api.yml"/>
4 changes: 4 additions & 0 deletions docs/scheduler/developer_reference.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Developer Reference

::: pfdl_scheduler
Expand Down
4 changes: 4 additions & 0 deletions docs/scheduler/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Using the PFDL scheduler

This section can be used as a reference while developing software with the PFDL Scheduler.
Expand Down
4 changes: 4 additions & 0 deletions docs/scheduler/model_classes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# Model classes

This page provides an overview over the model classes which are extracted from the parsed PFDL file. For an overview visit the [architecture section](../getting_started/architecture.md#model-creation-and-validation).
Expand Down
4 changes: 4 additions & 0 deletions docs/scheduler/scheduler_class.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
-->
# The Scheduler class

The PFDL scheduler is the interface between the PFDL core (model, petri net) and the outside world. If you want to receive the current state of the Production Order or push it further by sending status updates of the services you can register callback functions and fire events.
Expand Down
4 changes: 4 additions & 0 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/*
SPDX-FileCopyrightText: The PFDL Contributors
SPDX-License-Identifier: MIT
*/
:root > * {
--md-primary-fg-color: #1f82c0;
--md-primary-fg-color--light: #ECB7B7;
Expand Down

0 comments on commit 68ab87a

Please sign in to comment.