samples-java icon indicating copy to clipboard operation
samples-java copied to clipboard

Improve references to workflow definition files

Open jverce opened this issue 3 years ago • 3 comments

What was changed

  • Update extension of referenced files to match the currently existing ones
  • Transform the file references into an enumerated list with links to the corresponding files

Why?

While reading these docs, I had a hard time understanding the references to the workflow files that were made in the introduction section. I spent some time going through the repo until I found those files, and I'd like future readers to have an easier time.

Checklist

  1. Any docs updates needed?
  • src/main/java/io/temporal/samples/dsl/README.md

jverce avatar Aug 05 '22 20:08 jverce

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Aug 05 '22 20:08 CLAassistant

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

CLAassistant avatar Aug 05 '22 20:08 CLAassistant

@tsurdilo does this change make sense? Thanks!

jverce avatar Aug 17 '22 18:08 jverce

@jverce thanks for the pr!

tsurdilo avatar Sep 06 '22 16:09 tsurdilo