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

Docs updates #14

Merged
merged 15 commits into from
Jun 20, 2024
61 changes: 40 additions & 21 deletions profile/README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,43 @@
# Arcalot

<img align="right" width="200px" style="padding-left: 2em;" alt="Arcalot logo showing a shield with the Arcalot inscription on a hill with the silhouette of a castle in the background" src="https://github.com/arcalot/.github/raw/main/branding/arcalot.png">

The Arcalot community develops tools, plugins, and libraries that you can use either standalone as a library, and/or via a user interface or CLI. You can run the tools locally, remotely, or as part of a bigger system. Arcalot:

* Helps you create workflows with **normalized input and output schemas**
* Provides you with **assisted and automated root cause analysis** for the workflows you create as well as CI and other log systems
* Provides **stable plugins for several workloads**
# <a href="https://arcalot.io">Arcalot</a>
dbutenhof marked this conversation as resolved.
Show resolved Hide resolved
<a href="https://arcalot.io"><img align="right" width="200px" style="padding-left: 2em;"
alt="Arcalot logo showing a shield with the Arcalot inscription on a hill with the
silhouette of a castle in the background"
src="https://github.com/arcalot/.github/raw/main/branding/arcalot.png"></a>

The Arcalot community is dedicated to developing modular tools, plugins, and libraries
with flexible implementations independently or as complete end-to-end solutions. We
webbnh marked this conversation as resolved.
Show resolved Hide resolved
believe in enabling the automation and portability of complex tasks and in
pre-validating actions to avoid costly re-runs due to late failures and incompatible
webbnh marked this conversation as resolved.
Show resolved Hide resolved
data.

<br clear="right"/>

## Arcaflow
## <a href="https://arcalot.io/arcaflow">Arcaflow</a>

<img align="left" width="200px" style="padding-right: 2em;" alt="Arcaflow logo showing a waterfall and a river with 3 trees symbolizing the various plugins" src="https://github.com/arcalot/.github/raw/main/branding/arcaflow.png">
<a href="https://arcalot.io/arcaflow"><img align="left" width="200px" style="padding-right: 2em;" alt="Arcaflow logo showing a waterfall and a river with 3 trees symbolizing the various plugins" src="https://github.com/arcalot/.github/raw/main/branding/arcaflow.png"></a>

Arcaflow is a workflow engine consisting of three main components:
Arcaflow is a workflow system consisting of three main components:
dbutenhof marked this conversation as resolved.
Show resolved Hide resolved

* Core engine
* UI
* Plugins (including SDKs for Go and Python to write your own plugins)
* A core engine, statically-compiled and platform-portable, written in Go
dbutenhof marked this conversation as resolved.
Show resolved Hide resolved
* Plugins, written in various languages and delivered as Linux containers or modules
dbutenhof marked this conversation as resolved.
Show resolved Hide resolved
* Workflow definitions, written in YAML, tieing together plugins and their data

webbnh marked this conversation as resolved.
Show resolved Hide resolved
It allows you to click and drag plugins into a workflow for your systems and, if needed, feed the resulting data back into the UI for further analysis. You can also use it just to generate a workflow with parallel and subsequent tasks via the command line. There is a range of supported plugins, written either in Go or Python.
It allows you create workflows with parallel and serial tasks, passing data between the
webbnh marked this conversation as resolved.
Show resolved Hide resolved
tasks to achieve simple or complex pipelines of actions that result in machine-readable
outputs. The community supports an ever-growing variety of plugins, and we provide SDKs
in Go and Python to aid the user in developing their own custom plugins.
webbnh marked this conversation as resolved.
Show resolved Hide resolved

Arcaflow allows you to encapsulate and version-control expertise, making potentially
very complex workflows easily portable among environments and automation systems. With
an Arcaflow workflow, you can carefully craft a pipeline of actions that serves your
direct needs, and share that worflow virtually unchanged for others to run in different
environments and CI/CD systems.
webbnh marked this conversation as resolved.
Show resolved Hide resolved

<br clear="left"/>

webbnh marked this conversation as resolved.
Show resolved Hide resolved
## Arcalog
## <a href="https://arcalot.io/arcalog/">Arcalog</a>

<img align="right" width="200px" style="padding-left: 2em;" alt="Arcalog logo showing an ark floating on a blue scroll symbolizing the many logs it is scrolling through" src="https://github.com/arcalot/.github/raw/main/branding/arcalog.png">
<a href="https://arcalot.io/arcalog/"><img align="right" width="200px" style="padding-left: 2em;" alt="Arcalog logo showing an ark floating on a blue scroll symbolizing the many logs it is scrolling through" src="https://github.com/arcalot/.github/raw/main/branding/arcalog.png"></a>
dbutenhof marked this conversation as resolved.
Show resolved Hide resolved

Arcalog can assist you with or automate your root cause analysis in CI or other log systems either as a standalone tool or by embedding it into your applications.
webbnh marked this conversation as resolved.
Show resolved Hide resolved

Expand All @@ -36,6 +47,14 @@ It also provides additional tooling to download jobs from various log systems or

# Community

You can find our general community health files like our code of conduct and contribution guidelines in the [.github repository](https://github.com/arcalot/.github). If you have any questions or suggestions, please use the issues in the respective repository or contribute to the [discussions](https://github.com/orgs/arcalot/discussions).

If you would like to contribute, check out the issues in the individual repositories, our [project boards](https://github.com/orgs/arcalot/projects) where we organize our work, and our [Arcalot Round Table](https://github.com/arcalot/arcalot-round-table).
You can find our general community health files like our code of conduct and
dbutenhof marked this conversation as resolved.
Show resolved Hide resolved
contribution guidelines in the [.github repository](https://github.com/arcalot/.github).
If you have any questions or suggestions, please use the issues in the respective
dbutenhof marked this conversation as resolved.
Show resolved Hide resolved
repository.

We invite you to contribute! Check out the issues in the individual repositories for
ideas on where to get involved, or consider contributing a new plugin by starting with
our [python plugin template repository](https://github.com/arcalot/arcaflow-plugin-template-python).
Outside contributions and pull requests are of course welcome, and if you want to get
more involved you can join the
[Arcalot Round Table](https://github.com/arcalot/arcalot-round-table).