Skip to content

Commit 391fa43

Browse files
authored
Merge pull request #314 from jeffbulltech/update-readme-11-29-24
Update README.md 11-19-24
2 parents c83ce9b + 094c402 commit 391fa43

File tree

1 file changed

+36
-18
lines changed

1 file changed

+36
-18
lines changed

README.md

+36-18
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,27 @@
1414

1515

1616

17-
Conductor is a platform _originally_ created at **Netflix** to orchestrate microservices and events.
18-
[Conductor OSS](https://conductor-oss.org) is maintained by the team of developers at [Orkes.io](https://orkes.io/) along with members of the open source community.
17+
Conductor is a platform _originally_ created at **Netflix** to orchestrate microservices and events. [Conductor OSS](https://conductor-oss.org) is maintained by the team of developers at [Orkes.io](https://orkes.io/) along with members of the open source community.
18+
19+
20+
[![conductor_oss_getting_started](https://github.com/user-attachments/assets/6153aa58-8ad1-4ec5-93d1-38ba1b83e3f4)](https://youtu.be/4azDdDlx27M)
1921

2022
- - -
2123
# Table of Contents
2224
1. [What is Conductor?](#what-is-conductor)
2325
* [Key benefits](#key-benefits)
2426
* [Features](#features)
25-
2. [Requirements](#requirements)
26-
3. [Conductor Roadmap](#conductor-oss-roadmap)
27-
4. [How to Contribute](#contributors)
28-
5. [Additional Resources](#resources)
29-
6. [Community & Support](#slack-community)
27+
2. [Getting Started](#getting-started)
28+
* [Requirements](#requirements)
29+
* [Quick Start](#quick-start-guide)
30+
* [Create your first workflow](#create-your-first-workflow)
31+
3. [Documentation](#documentation)
32+
4. [Database Specifications](#database-specifications)
33+
5. [Deployment Options](#deployment-options)
34+
6. [Conductor Roadmap](#conductor-oss-roadmap)
35+
7. [How to Contribute](#contributors)
36+
8. [Additional Resources](#resources)
37+
9. [Community & Support](#slack-community)
3038

3139
# What is Conductor?
3240
Conductor (or [Netflix Conductor](https://netflixtechblog.com/netflix-conductor-a-microservices-orchestrator-2e8d4771bf40)) is a microservices orchestration engine for distributed and asynchronous workflows. It empowers developers to create workflows that define interactions between services, databases, and other external systems.
@@ -53,6 +61,7 @@ Conductor is designed to enable flexible, resilient, and scalable workflows. It
5361
* Install Java (JDK) 17 or newer
5462
* Node 14 for the UI to build
5563
* _Earlier versions may work, but are untested_
64+
5665

5766
## Quick Start Guide
5867

@@ -82,12 +91,15 @@ docker compose -f docker/docker-compose.yaml up
8291
##### Or use the REST API with your preferred HTTP client
8392
* http://localhost:8080
8493

85-
## Database Requirements
86-
94+
# Documentation
95+
Check-out the [Conductor OSS docs](https://github.com/conductor-oss/conductor/tree/main/docs) for additional details
96+
- - -
97+
# Database Specifications
8798
* The default persistence used is Redis
8899
* The indexing backend is [Elasticsearch](https://www.elastic.co/) (7.x)
89100

90-
## Configuration for various database backends
101+
102+
### Configuration for various database backends
91103

92104
| Backend | Configuration |
93105
|----------------|---------------------------------------------------------------------------------------|
@@ -97,7 +109,6 @@ docker compose -f docker/docker-compose.yaml up
97109
| MySQL + ES7 | [config-mysql.properties](docker/server/config/config-mysql.properties) |
98110

99111

100-
- - -
101112
# Deployment Options
102113
In addition to the Docker Compose setup, Netflix Conductor supports several other deployment methods to suit various environments:
103114

@@ -114,19 +125,26 @@ Conductor provides several SDKs for interacting with the API and creating custom
114125

115126
Each SDK is maintained as part of the Conductor project, providing examples and comprehensive API documentation.
116127

117-
# Documentation and Community
118-
* **Official Documentation:** [Conductor documentation](https://docs.conductor-oss.org/index.html) contains detailed explanations of workflow concepts, API reference, and guides.
119-
* **Conductor Slack:** [Join the Conductor Slack](https://join.slack.com/t/orkes-conductor/shared_invite/zt-2hmxn0i3n-_W~a9rWMbvMoYmlJo3Y15g) channel for community discussions and support.
120-
* **Orkes Community Discourse:** [Hosted by Orkes.io](https://community.orkes.io) on Discourse, you can engage the Conductor & Orkes community, ask questions, and contribute ideas.
121-
122-
123128
# Conductor OSS Roadmap
124129
[See the roadmap for the Conductor](ROADMAP.md)
125-
126130
If you would like to participate in the roadmap and development, [please reach out](https://forms.gle/P2i1xHrxPQLrjzTB7).
127131

132+
# Documentation and Community
133+
* **Official Documentation:** [Conductor documentation](https://docs.conductor-oss.org/index.html) contains detailed explanations of workflow concepts, API reference, and guides.
134+
* **Conductor Slack:** [Join the Conductor Slack](https://join.slack.com/t/orkes-conductor/shared_invite/zt-2hmxn0i3n-_W~a9rWMbvMoYmlJo3Y15g) channel for community discussions and support.
135+
* **Orkes Community Discourse:** [Hosted by Orkes.io](https://community.orkes.io) on Discourse, you can engage the Conductor & Orkes community, ask questions, and contribute ideas.
136+
- - -
128137
# License
129138
Conductor is licensed under the Apache 2.0 License © [Conductor Open-source](https://conductor-oss.org/)
139+
- - -
140+
# Contributing
141+
142+
We welcome contributions from everyone!
143+
144+
- **Report Issues:** Found a bug or have a feature request? Open an [issue on GitHub](https://github.com/conductor-oss/conductor/issues).
145+
- **Contribute Code:** Check out our [Contribution Guide](https://github.com/conductor-oss/conductor/blob/main/CONTRIBUTING.md) for initial guidelines, and explore our [good first issues](https://github.com/conductor-oss/conductor/labels/good%20first%20issue) for beginner-friendly tasks to tackle first.
146+
- **Build a Conductor SDK:** Need an SDK not included with Conductor? Build your own using the [Swagger API](http://localhost:8080) included with your local deployment.
147+
- **Contribute to our Docs:** Contribute edits or updates to keep our [documentation](https://github.com/conductor-oss/conductor/tree/main/docs) in great shape for the community.
130148

131149
## Contributors
132150

0 commit comments

Comments
 (0)