4 ms·

thanks for the feedback here, that’s really important for us and we actually just refactored the readme a couple of days ago. any concrete action item you’d sug

thanks for the feedback here, that’s really important for us and we actually just refactored the readme a couple of days ago. any concrete action item you’d suggest?

OJFord 3y ago
Try to read it as someone approaching the whole project for the first time, particularly the 'Workflows' section, it just doesn't really make sense, kind of implies there's something special about running it in GitHub Actions (maybe it means to say that the syntax is similar?) and doesn't tell you how to actually pass the Keep workflow file to keep (which is what will parse it, not GH Actions) at all. Start with `keep run --actions-file`, then show the file format. Don't mention specific CI/CD, it's not relevant.
- shahargl 3y ago
  would "datadog workflow automation alternative" would sounds more reasonable? we did want to do that but people told us no one knows datadog workflow automation.
  - slillibri 3y ago
    Honestly it would be better to just describe what your tool is, rather than trying to describe it in relation to something else. People know what workflow automation is, and people know what monitoring is. I was initially confused at what this product had to do with Github Actions. Also, it would do well to link to your website ( https://www.keephq.dev https://www.keephq.dev ) also, rather than just something that immediately prompts me to log in. And one final thing, having a demo video with some sort of narration to explain what I am watching people click on would also be helpful. Obviously these are just my opinions, and they are worth exactly what was paid for them :)
    - shahargl 3y ago
      thanks for the feedback, appericated. We do have a demo at keephq.dev and we also dumped the youtube link on the post itself. what else would help you understand better?
      - slillibri 3y ago
        I watched that video, but my thought was it would be better with narration or subtitles explaining what is going on.
    - talboren 3y ago
      and your feedback is much appreciated! noted for next time. (i actually did the demo in a rush so it was more just showing a simple usage of the platform) we'll think about some changes to the README asap! thanks!
  - OJFord 3y ago
    You can keep a mention of another tool if you really want, but just make it clearer that you only mean it has similar syntax. Concretely: > Run a Keep workflow with `keep run --actions-file=./path/to/workflow`; or `keep run` assumes the file is called `blah` in the current working directory by default if not specified. > The actions file has the following format, which may seem familiar if you've used GitHub Actions: > ``` > ... > ``` > further actions file examples are available here and a full reference is available in the docs here.

thanks for the feedback here, that’s really important for us and we actually just refactored the readme a couple of days ago. any concrete action item you’d suggest?

OJFord 3y ago

Try to read it as someone approaching the whole project for the first time, particularly the 'Workflows' section, it just doesn't really make sense, kind of implies there's something special about running it in GitHub Actions (maybe it means to say that the syntax is similar?) and doesn't tell you how to actually pass the Keep workflow file to keep (which is what will parse it, not GH Actions) at all. Start with `keep run --actions-file`, then show the file format. Don't mention specific CI/CD, it's not relevant.

shahargl 3y ago
would "datadog workflow automation alternative" would sounds more reasonable? we did want to do that but people told us no one knows datadog workflow automation.
- slillibri 3y ago
  Honestly it would be better to just describe what your tool is, rather than trying to describe it in relation to something else. People know what workflow automation is, and people know what monitoring is. I was initially confused at what this product had to do with Github Actions. Also, it would do well to link to your website ( https://www.keephq.dev https://www.keephq.dev ) also, rather than just something that immediately prompts me to log in. And one final thing, having a demo video with some sort of narration to explain what I am watching people click on would also be helpful. Obviously these are just my opinions, and they are worth exactly what was paid for them :)
  - shahargl 3y ago
    thanks for the feedback, appericated. We do have a demo at keephq.dev and we also dumped the youtube link on the post itself. what else would help you understand better?
    - slillibri 3y ago
      I watched that video, but my thought was it would be better with narration or subtitles explaining what is going on.
  - talboren 3y ago
    and your feedback is much appreciated! noted for next time. (i actually did the demo in a rush so it was more just showing a simple usage of the platform) we'll think about some changes to the README asap! thanks!
- OJFord 3y ago
  You can keep a mention of another tool if you really want, but just make it clearer that you only mean it has similar syntax. Concretely: > Run a Keep workflow with `keep run --actions-file=./path/to/workflow`; or `keep run` assumes the file is called `blah` in the current working directory by default if not specified. > The actions file has the following format, which may seem familiar if you've used GitHub Actions: > ``` > ... > ``` > further actions file examples are available here and a full reference is available in the docs here.