search

cylc / cylc-doc

Documentation (User Guide, Cheat Sheets, etc.) for the Cylc Workflow Engine.
https://cylc.github.io/cylc-doc/
GNU General Public License v3.0
9 stars 19 forks source link

Add documentation for xtriggers entry_point #671

Closed ColemanTom closed 8 months ago

ColemanTom commented 10 months ago

Requirements check-list

I've attempted to add documentation for new functionality provided by https://github.com/cylc/cylc-flow/pull/5831. I hope it works properly. I think there should be a link between the external triggers documentation and the plugin documentation, but I'm not sure how to do that. Very specific advice would be appreciated.

When I tried to build this as myself I had issues and have not had time to try and debug, so I'm not sure how it renders (or if it is even valid).

ColemanTom commented 9 months ago

test failure is casued by openbsd website being down. Nothing I can do to fix that. It could change to the freebsd version of the ssh_config documentation, which may be a more reliable website given its customers?

MetRonnie commented 8 months ago

Could you add src/plugins/xtriggers/built-in to .gitignore please (autodoc generates files into this directory)

ColemanTom commented 8 months ago

Could you add src/plugins/xtriggers/built-in to .gitignore please (autodoc generates files into this directory)

Done

MetRonnie commented 8 months ago

@oliver-sanders Are you happy with my single review or did you want to re-review?