Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

link to WDL spec v 1 rather than development version? #40

Open
jayoung opened this issue Jan 13, 2023 · 2 comments
Open

link to WDL spec v 1 rather than development version? #40

jayoung opened this issue Jan 13, 2023 · 2 comments
Labels
bug Something isn't working

Comments

@jayoung
Copy link
Contributor

jayoung commented Jan 13, 2023

in this section you provide a link to the spec page for the development version of WDL:
"Also, there is some useful, though very detailed, information in the openWDL GitHub repo for the specification itself where you can learn more."

but perhaps for this purpose it's better to link to the version 1 spec, not the development version (here - https://github.com/openwdl/wdl/blob/main/versions/1.0/SPEC.md)

@jayoung jayoung added the bug Something isn't working label Jan 13, 2023
@jayoung
Copy link
Contributor Author

jayoung commented Jan 13, 2023

actually, it's kind of weird that these two sentences:
There is emerging documentation about the WDL specification itself being generated by the openWDL community here. Also, there is some useful, though very detailed, information in the openWDL GitHub repo for the specification itself where you can learn more.

are even in the 'Get Test Workflows' section at all. They belong more in the Summary and Next Steps section. If you were to say anything at all here about syntax perhaps it's simply 'don't worry about it right now, it's explained later' or the readthedocs only - the spec is definitely beyond what's needed here

@jayoung
Copy link
Contributor Author

jayoung commented Jan 13, 2023

same link comment does apply to section "6.2.1 openWDL specification" - it currently links to the devel spec, and version 1 seems more appropriate

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant