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: readability tweaks to "Install" page #2419

Closed
wants to merge 22 commits into from

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented Nov 6, 2023

DO NOT MERGE!

Summary

Improve the readability of the Install page (revised for umbrella charts). We did a quick merge of the basic material, knowing that it needed to be tweaked a bit.

While this PR was written, Mo created an abbreviated document that is much more appropriate. This version is going to be used for some usability testing but should not be merged. Instead, the plan is for me to create a separate "Installation tips and tricks" page that includes the content from this page that is not in the abbreviated installation doc. When that is done, this PR will be closed.

Checks

  • [n/a] My PR fulfills the Definition of Done of the corresponding issue and not more (or parts if the issue is separated
    into multiple PRs)
  • I used descriptive commit messages to help reviewers understand my thought process
  • [ x I signed off all my commits according to the Developer Certificate of Origin (DCO)(
    see Contribution Guide)
  • My PR title is formatted according to the semantic PR conventions described in
    the Contribution Guide
  • My content follows the style guidelines of this project (YAMLLint, markdown-lint)
  • [n/a] I regenerated the auto-generated docs for Helm and the CRD documentation (if applicable)
  • I have performed a self-review of my content including grammar and typo errors and also checked the rendered page
    from the Netlify deploy preview
  • My changes result in all-green PR checks (first-time contributors need to ask a maintainer to approve their test runs)

Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe StackScribe added the documentation Improvements or additions to documentation label Nov 6, 2023
@StackScribe StackScribe added this to the 0.9 milestone Nov 6, 2023
@StackScribe StackScribe self-assigned this Nov 6, 2023
@StackScribe StackScribe requested review from a team as code owners November 6, 2023 08:55
Copy link

netlify bot commented Nov 6, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 9641c89
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/654a0e046faa5b0008759ee7
😎 Deploy Preview https://deploy-preview-2419--keptn-lifecycle-toolkit.netlify.app/docs/install/reqs
📱 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.

Copy link
Contributor

@odubajDT odubajDT left a comment

Choose a reason for hiding this comment

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

Please fix the failing html test

Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: odubajDT <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
StackScribe and others added 3 commits November 6, 2023 01:22
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: odubajDT <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
docs/content/en/docs/implementing/.integrate.md.swp Outdated Show resolved Hide resolved
docs/content/en/docs/implementing/integrate.md Outdated Show resolved Hide resolved
docs/content/en/docs/install/install.md Outdated Show resolved Hide resolved
docs/content/en/docs/install/install.md Outdated Show resolved Hide resolved
docs/content/en/docs/install/install.md Outdated Show resolved Hide resolved
docs/content/en/docs/install/install.md Outdated Show resolved Hide resolved
docs/content/en/docs/install/install.md Show resolved Hide resolved
docs/content/en/docs/install/install.md Outdated Show resolved Hide resolved
docs/content/en/docs/install/install.md Show resolved Hide resolved
docs/content/en/docs/install/install.md Outdated Show resolved Hide resolved
StackScribe and others added 6 commits November 6, 2023 03:26
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
StackScribe and others added 5 commits November 6, 2023 03:52
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@mowies mowies modified the milestones: 0.9, 0.10 Nov 6, 2023
@StackScribe StackScribe mentioned this pull request Nov 6, 2023
6 tasks
@thisthat thisthat dismissed odubajDT’s stale review November 7, 2023 07:55

HTML tests fixed

Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe StackScribe marked this pull request as draft November 7, 2023 09:58
Signed-off-by: Meg McRoberts <[email protected]>
Copy link

sonarqubecloud bot commented Nov 7, 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
Copy link
Contributor Author

This PR is no longer relevant -- the useful bits were put in other PRs and I am closing this.

@StackScribe StackScribe closed this Nov 9, 2023
@StackScribe StackScribe deleted the 1103-umbrella branch November 9, 2023 09:21
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.

4 participants