Skip to content
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

docs: adapt goals of Keptn in README #3293

Merged
merged 1 commit into from
Mar 20, 2024
Merged

docs: adapt goals of Keptn in README #3293

merged 1 commit into from
Mar 20, 2024

Conversation

odubajDT
Copy link
Contributor

Fixes: #3208

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 19, 2024
@odubajDT odubajDT marked this pull request as ready for review March 19, 2024 11:18
@odubajDT odubajDT requested a review from a team as a code owner March 19, 2024 11:18
Copy link
Member

@mowies mowies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this seems a bit short and undescriptive IMHO...
did you check the comments on the issue for this?

Copy link
Contributor

@StackScribe StackScribe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it! I might propose adding a line 20: "and the ability to promote the deployment to the next stage." And I might just lose the "## Core concepts" header -- and let this just be part of the introductory section.

If we add more descriptive information, we end up with replicated information between the README and the core-concepts in the docs and that quickly becomes a maintenance headache.

Copy link

sonarcloud bot commented Mar 20, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@odubajDT odubajDT merged commit d4cf6d0 into keptn:main Mar 20, 2024
9 checks passed
Vickysomtee pushed a commit to Vickysomtee/keptn-lifecycle-toolkit that referenced this pull request Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Review and update "Goals" section of README file
3 participants