GithubHelp home page GithubHelp logo

Comments (3)

jasoanderson avatar jasoanderson commented on June 11, 2024

I want to reiterate this. I ran into this same issue last Friday, the documentation wasn't clear what was considered base parameters. I was working creating an action of type remote command line. I kept getting a mapping issue, because I was trying to specify that the host parameter was needed. I was able to get help through slack on this issue, but after rereading the documentation, I believe the documentation needs to be made more clear on what parameters are always there, and what are additional ones we can add. Maybe even with an example.

from st2docs.

LindsayHill avatar LindsayHill commented on June 11, 2024

Can you create a PR with the sort of example you want to see in the docs?

This page: https://docs.stackstorm.com/reference/runners.html should have all the parameters for runners. Are there some missing from there, or do you want this information included/linked from elsewhere in the docs?

Which section of the docs do you want to see updated?

from st2docs.

blag avatar blag commented on June 11, 2024

The timeout parameter is not listed on the Actions page.

There is a link to the Runners section of the Reference page, but it's buried in the middle of a lot of text.

At the very least we should make sure to list all runner parameters in the action runners section of the actions page.

from st2docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.