search

serverlessworkflow / specification

Contains the official specification for the Serverless Workflow Domain Specific Language. It provides detailed guidelines and standards for defining, executing, and managing workflows in serverless environments, ensuring consistency and interoperability across implementations.
http://serverlessworkflow.io
Apache License 2.0
730 stars 146 forks source link

Move the DSL to dedicated repository #845

Closed cdavernas closed 3 months ago

cdavernas commented 3 months ago

What would you like to be added:

Move the DSL to a dedicated repository, to avoid confusion, or rename the specification one to dsl.

For now, the repository specification contains a specification.md that defines the DSL. It's just a matter of semantics, but maybe we should take the opportunity of 1.0.0 to do so.

Why is this needed:

Lack of clarity. Not great for SEO.

Even path to specification file is confusing IMHO: https://github.com/serverlessworkflow/specification/specification.md.

ricardozanini commented 3 months ago

I think we followed the same semantics from CloudEvents Spec: https://github.com/cloudevents/spec

But seeing there repo now, I can see that's pretty different. Maybe we can use it as a reference?

DSL in a new repo would be more difficult to send PRs changing the spec, no? We would have to send two PRs. Maybe using folders to split the files?

Also a spec.md huge file is hard to maintain. I think we should consider breaking it into sections to ease contributions.

cdavernas commented 3 months ago

I'm closing, as it's irrelevant for now.

Let's reopen it in the future, once we've addressed more pressing issues, if we feel it really/still matters.

Also a spec.md huge file is hard to maintain. I think we should consider breaking it into sections to ease contributions.

I followed your suggestion and have split the docs into dsl and dsl reference. It breathes imo a little bit more.