-
-
Notifications
You must be signed in to change notification settings - Fork 170
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
Removal of st2mistral from basic chapter of docs #1011
Conversation
Couple of points:
|
Looks good considering @amanda11 s recent comment. |
name: <% $.name %> | ||
ip: <% $.ip %> | ||
|
||
The sections below contain additional YAQL examples of how to work with lists and dictionaries, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a lot of useful general info here on YAQL. In the Orquesta pages the approach seems to have been to just point to the YAQL and Jinja projects themselves?
Are we happy to remove the pages and just refer to the YAQL/Jinja projects or want to put a page together for Orquesta/YAQL and Orquesta/Jinja?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would vote for a page for Orquesta/YAQL and Orquesta/Jinja. But this shouldn't be a blocker for this PR imho.
required: true | ||
type: string | ||
default: Stanley | ||
notify: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the example used in the unit-tests, but I couldn't get notify in Orquesta working in my setup - but I may be missing something. In the Orquesta pages we just mention there is a notify parameter that we can ignore for now...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I got Orquesta notifications working but I also had to add on a notify section as well as the notify parameters, e.g. I also had:
notify:
on-complete:
routes:
- slack
message: "Succeeded"
so that it had the details of route etc.
Do we think the documentation as is is ok, or
- should I add in the notify section into the example
- Should I add in a preceding sentence along following lines:
The method for specify the route and conditions for when tasks in an Orquesta workflow is the same as ActionChain. You have a notify section in the action meta when registering.
and should I put in a notify section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@LindsayHill @armab Having got notifications working in Orquesta now, I'm wondering if more needs to go into this
section on the chatops page. Or alternatively I was mis-understanding something.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@LindsayHill @armab Having got notifications working in Orquesta now, I'm wondering if more needs to go into this
section on the chatops page. Or alternatively I was mis-understanding something.
So as not to confuse things, I will merge this PR. And generate a new PR with enhancements that I think will make Orquesta notifications even clearer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 step by step
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this work. Made a few small changes. Looks good.
@amanda11 now as you have Github repo permissions, as PR author feel free to merge it when you see the fit. |
Removal of st2mistral from the Basic chapter.
Addresses part of the st2docs section of StackStorm/st2#4762