structurizr / dsl

Structurizr DSL
https://docs.structurizr.com/dsl
Apache License 2.0
1.41k stars 266 forks source link

Please allow to provide a description to the deploymentEnvironment #186

Closed dgutson closed 1 year ago

dgutson commented 1 year ago

Please allow this:

workspace {
    model {
        deploymentEnvironment singleNode {
            description "This is the case when the X and Y live in the same node"
         }
    }
}

and, equivalently, in the same declaration line:

workspace {
    model {
        deploymentEnvironment singleNode "This is the case when the X and Y live in the same node" {

         }
    }
}

BTW, it would be good if tags would also be supported as well.

dgutson commented 1 year ago

Ping

simonbrowndotje commented 1 year ago

"deployment environment" is just a string field in the underlying Java object model -> https://github.com/structurizr/java/blob/master/structurizr-core/src/com/structurizr/model/DeploymentElement.java#L38 ... for reasons of backwards compatibility with earlier versions of the Java library. If I was designing the object model again, I'd certainly make deployment environment a first class citizen so it could support things like descriptions and properties. But it's not a straightforward change unfortunately. If you'd like to sponsor this from a financial point of view, please do let me know and I'll fast-track it.

dgutson commented 1 year ago

Let me see if @qequ can do it.

dgutson commented 1 year ago

Sorry, just checked. It extends Element which already has the description attribute. Why it can't be used?

simonbrowndotje commented 1 year ago

Let me see if @qequ can do it.

Sure, no problem ... closing this issue then.

dgutson commented 1 year ago

Could you pls leave this open and assign to @jukMR? Julian is an intern that is working on structurizr & plantUML interop.

JukMR commented 1 year ago

Hi! I confirm that I'm willing to work on this and solve this issue