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: create pre/post-deploy getting started #1362

Merged
merged 15 commits into from
May 22, 2023
Merged

docs: create pre/post-deploy getting started #1362

merged 15 commits into from
May 22, 2023

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented May 4, 2023

Replaces #1337, #1336, and other corrupted PRs.

Satisfies #1302

Getting started guide for the orchestrate pre/post-deployment checks use case, based on Andi's demo video

Comments welcome but this still needs some writing

@StackScribe StackScribe added the documentation Improvements or additions to documentation label May 4, 2023
@StackScribe StackScribe requested review from a team as code owners May 4, 2023 02:34
@StackScribe StackScribe self-assigned this May 4, 2023
@netlify
Copy link

netlify bot commented May 4, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 6202375
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/646b3b13c1cde100080ab17b
😎 Deploy Preview https://deploy-preview-1362--keptn-lifecycle-toolkit.netlify.app/docs/getting-started/observability
📱 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 settings.

@agardnerIT
Copy link
Contributor

@aepfli markdown checks seem to be failing (from what I interpret) because /docs/readme.md contains a link to localhost.

  1. This PR doesn't touch docs/readme.md - is there a way for MDLint to only run on changed files during PRs? This might speed up checks too.
  2. The link to localhost in docs/readme is actually necessary and thus valid. Can we ignore that file + link combination in MDLint?

@aepfli
Copy link
Member

aepfli commented May 15, 2023

1. This PR doesn't touch [docs/readme.md ](https://github.com/keptn/lifecycle-toolkit/blob/main/docs/README.md)- is there a way for MDLint to only run on changed files during PRs? This might speed up checks too.

The checks only needs one minute, and most of the time it is actually the setup rather than the test itself, i do not see a lot of benefit in improving this. the investments vs the gain will be little

2. The link to localhost in `docs/readme` is actually necessary and thus valid. Can we ignore that file + link combination in MDLint?

the markdown link check fails due to:

 ERROR: 1 dead links found!
[✖] ../../implementing/integrate.md → Status: 400

in: FILE: docs/content/en/docs/getting-started/observability/_index.md

There is a bad markdown link within the file referencing another. localhost already has an exception as seen here

"ignorePatterns": [
{
"pattern": "^http://localhost"
},
{
"pattern": "^/images/why-keptn"
}
],

StackScribe and others added 6 commits May 15, 2023 11:55
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Simon Schrottner <[email protected]>
Signed-off-by: Simon Schrottner <[email protected]>
@aepfli
Copy link
Member

aepfli commented May 15, 2023

Rebased and fixed issues, pr is green.

Additional note regarding running changes only for the files changed. Especially a link checker is a good example for such a test because we also want to check the "incoming" links from other readmes. Detecting if an internal link changed, or a file is suddenly not available anymore etc. is not such a trivial topic.

StackScribe and others added 7 commits May 16, 2023 05:06
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Giovanni Liva <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Giovanni Liva <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Giovanni Liva <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Giovanni Liva <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Adam Gardner <[email protected]>
Signed-off-by: Adam Gardner <[email protected]>
@StackScribe StackScribe marked this pull request as ready for review May 18, 2023 21:52
StackScribe and others added 2 commits May 22, 2023 02:46
Signed-off-by: Meg McRoberts [email protected]

Signed-off-by: Meg McRoberts <[email protected]>
@sonarcloud
Copy link

sonarcloud bot commented May 22, 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
0.0% 0.0% Duplication

Copy link
Member

@thisthat thisthat left a comment

Choose a reason for hiding this comment

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

Follow-ups can be tackle in #1444

@StackScribe StackScribe merged commit d602115 into keptn:main May 22, 2023
@StackScribe StackScribe deleted the 0503-observe-access-good branch May 22, 2023 11:02
@keptn-bot keptn-bot mentioned this pull request May 22, 2023
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.

5 participants