Skip to content
This repository has been archived by the owner on Jan 19, 2024. It is now read-only.

Restructure README to clarify what this integration is meant for #306

Open
christian-kreuzberger-dtx opened this issue Jul 6, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@christian-kreuzberger-dtx
Copy link
Contributor

Original Conversation: https://keptn.slack.com/archives/C017T4KUAG3/p1657031728882659

Goal: Job-executor-service needs to better advertise itself as a customization/extension option for Keptn, especially if you're new to Keptn.

Tasks

  • Describe on top of README what Job-Executor-Service allows you to do (and not how or why), e.g., subscribe to any Keptn Cloud Event (sh.keptn.event.test.triggered) and run any container/command as a response to this
  • Add screenshots, an animated GIF or a YouTube video that quickly show-cases job-executor-service
  • This initial pitch should be followed by the quickstart section to get the user started quickly, with a link to detailed installation instructions in docs/INSTALL.md
  • Refactor Motivations table into prose and describe some of the capabilities of Job-Executor
@christian-kreuzberger-dtx christian-kreuzberger-dtx added the documentation Improvements or additions to documentation label Jul 6, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant