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: rewrite README file #1862

Merged
merged 4 commits into from
Aug 25, 2023
Merged

docs: rewrite README file #1862

merged 4 commits into from
Aug 25, 2023

Conversation

StackScribe
Copy link
Contributor

This is a proposed rewrite of the main KLT README file. It strips out information that is now included in the main doc set, adds some headers, etc. I also implemented the new product naming conventions -- please verify that they are done correctly.

Please consider whether this is the appropriate information to have in the README file, remembering that we want to minimize the duplication of information that must be maintained as the product evolves.

I did not strip out the Architecture section. That should be removed when the relevant information has been merged into the Architecture section of the documentation.

Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe StackScribe added the documentation Improvements or additions to documentation label Aug 9, 2023
@StackScribe StackScribe added this to the 0.9 milestone Aug 9, 2023
@StackScribe StackScribe self-assigned this Aug 9, 2023
@StackScribe StackScribe requested a review from a team as a code owner August 9, 2023 05:51
@netlify
Copy link

netlify bot commented Aug 9, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit edaca99
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/64d3295e7fd473000735e957
😎 Deploy Preview https://deploy-preview-1862--keptn-lifecycle-toolkit.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@agardnerIT agardnerIT self-requested a review August 10, 2023 01:00
agardnerIT
agardnerIT previously approved these changes Aug 10, 2023
README.md Outdated Show resolved Hide resolved
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
README.md Outdated Show resolved Hide resolved
Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Adam Gardner <26523841+agardnerIT@users.noreply.github.com>
@sonarcloud
Copy link

sonarcloud bot commented Aug 24, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@StackScribe StackScribe merged commit e304969 into keptn:main Aug 25, 2023
15 checks passed
@StackScribe StackScribe deleted the 0808-readme branch August 25, 2023 05:44
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.

None yet

5 participants