Skip to content

Commit

Permalink
Merge pull request Netflix#3686 from v1r3n/readme_update_v3
Browse files Browse the repository at this point in the history
Updates to readme with resources
  • Loading branch information
v1r3n authored Jul 7, 2023
2 parents 9c8f184 + 3c32045 commit 690968b
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
![Conductor](docs/docs/img/logo.png)

# Conductor
Conductor is a platform created by Netflix to orchestrate workflows that span across microservices.

[![Github release](https://img.shields.io/github/v/release/Netflix/conductor.svg)](https://GitHub.com/Netflix/conductor/releases)
[![CI](https://github.com/Netflix/conductor/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Netflix/conductor/actions/workflows/ci.yml)
[![License](https://img.shields.io/github/license/Netflix/conductor.svg)](http://www.apache.org/licenses/LICENSE-2.0)
Expand All @@ -12,18 +10,27 @@ Conductor is a platform created by Netflix to orchestrate workflows that span ac
[![GitHub forks](https://img.shields.io/github/forks/Netflix/conductor.svg?style=social&label=Fork&maxAge=2592000)](https://GitHub.com/Netflix/conductor/network/)


## Workflow Creation in Code
Conductor supports creating workflows using JSON and Code.
SDK support for creating workflows using code is available in multiple languages and can be found at https://github.com/conductor-sdk
Conductor is a platform created by Netflix to orchestrate workflows that span across microservices.
Conductor is maintained by Media Workflow Infrastructure team at Netflix.

For more information, see [Main Documentation Site](https://conductor.netflix.com/)

## Documentation
[Main Documentation Site](https://conductor.netflix.com/)

## Releases
The latest version is [![Github release](https://img.shields.io/github/v/release/Netflix/conductor.svg)](https://GitHub.com/Netflix/conductor/releases)

[2.31.8](https://github.com/Netflix/conductor/releases/tag/v2.31.8) is the **final** release of `2.31` branch. As of Feb 2022, `1.x` & `2.x` versions are no longer supported.

## Resources
#### [Slack Community](https://join.slack.com/t/orkes-conductor/shared_invite/zt-xyxqyseb-YZ3hwwAgHJH97bsrYRnSZg)
We have an active [community](https://join.slack.com/t/orkes-conductor/shared_invite/zt-xyxqyseb-YZ3hwwAgHJH97bsrYRnSZg) of Conductor users and contributors on the channel.
#### [Documentation Site](https://conductor.netflix.com/)
[Documentation](https://conductor.netflix.com/) and tutorial on how to use Conductor

## Workflow Creation in Code
Conductor supports creating workflows using JSON and Code.
SDK support for creating workflows using code is available in multiple languages and can be found at https://github.com/conductor-sdk

## Community Contributions
The modules contributed by the community are housed at [conductor-community](https://github.com/Netflix/conductor-community). Compatible versions of the community modules are released simultaneously with releases of the main modules.

Expand All @@ -38,7 +45,6 @@ The easiest way to get started is with Docker containers. Please follow the inst
### From Source:
Conductor Server is a [Spring Boot](https://spring.io/projects/spring-boot) project and follows all applicable conventions. See instructions [here](http://conductor.netflix.com/gettingstarted/source.html).


## Published Artifacts
Binaries are available from [Netflix OSS Maven](https://artifacts.netflix.net/netflixoss/com/netflix/conductor/) repository, or the [Maven Central Repository](https://search.maven.org/search?q=g:com.netflix.conductor).

Expand All @@ -53,6 +59,7 @@ Binaries are available from [Netflix OSS Maven](https://artifacts.netflix.net/ne
| conductor-ui | node.js based UI for Conductor |
| conductor-client | Java client for Conductor that includes helpers for running worker tasks |
| conductor-client-spring | Client starter kit for Spring |
| conductor-java-sdk | SDK for writing workflows in code |
| conductor-server | Spring Boot Web Application |
| conductor-redis-lock | Workflow execution lock implementation using Redis |
| conductor-awss3-storage | External payload storage implementation using AWS S3 |
Expand All @@ -74,7 +81,9 @@ Binaries are available from [Netflix OSS Maven](https://artifacts.netflix.net/ne
* UI requires Node 14 to build. Earlier Node versions may work but is untested.

## Get Support
Conductor is maintained by Media Workflow Infrastructure team at Netflix. Use Github issue tracking for filing issues and the [Discussion Forum](https://github.com/Netflix/conductor/discussions) for any other questions, ideas or support requests.
There are several ways to get in touch with us:
* [Slack Community](https://join.slack.com/t/orkes-conductor/shared_invite/zt-xyxqyseb-YZ3hwwAgHJH97bsrYRnSZg)
* [GitHub Discussion Forum](https://github.com/Netflix/conductor/discussions)

## Contributions
Whether it is a small documentation correction, bug fix or a new feature, contributions are highly appreciated. We just ask you to follow standard OSS guidelines. The [Discussion Forum](https://github.com/Netflix/conductor/discussions) is a good place to ask questions, discuss new features and explore ideas. Please check with us before spending too much time, only to find out later that someone else is already working on a similar feature.
Expand Down

0 comments on commit 690968b

Please sign in to comment.