cartographer
cartographer copied to clipboard
Language on the Templates page is ambiguous
On Page: Templates
On the Templates page (https://cartographer.sh/docs/v0.3.0/reference/template/#clustersourcetemplate)
ClusterSourceTemplate
starts out with:
indicates how the supply chain could instantiate an object responsible for.....
And other resources down the page (for example, ClusterImageTemplate
start with:
instructs how the supply chain should instantiate an object responsible for
It's
could instantiate
vs
should instantiate
I read the word "could", and I think "well, are there other ways?" I read the word "should", and I think "ah, this is how the contract is fulfilled".
Honestly, I think it can be fixed by simply dropping should/could. So for example, the new language for ClusterSourceTemplate
would read:
ClusterSourceTemplate instructs the supply chain to instantiate an object responsible for providing source code.
I'm open to thoughts/discussions, though!
Hello @drawsmcgraw! Welcome to the Cartographer community and thank you for opening your first issue, we appreciate your contributions