lifecycle-toolkit icon indicating copy to clipboard operation
lifecycle-toolkit copied to clipboard

docs: new landing page

Open thisisobate opened this issue 1 year ago • 1 comments

Description

Please include a short summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

How to test

Please describe how to run the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also provide information about any automatic tests that you added.

  • [ ] Manual Test A
  • [ ] Unit Test B
  • [ ] Integration Test C

Checklist

  • [ ] 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
  • [ ] 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 code follows the style guidelines of this project (golangci-lint passes, YAMLLint passes)
  • [ ] I regenerated the auto-generated docs for Helm and the CRD documentation (if applicable)
  • [ ] I have performed a self-review of my code
  • [ ] I have made corresponding changes to the documentation (if needed)
  • [ ] My changes result in all-green PR checks (first-time contributors need to ask a maintainer to approve their test runs)
  • [ ] New and existing unit and integration tests pass locally with my changes

Summary

Please include a short summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Checks

  • [ ] 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
  • [ ] 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)
  • [ ] 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)

thisisobate avatar Sep 23 '24 20:09 thisisobate

@mowies

thisisobate avatar Oct 04 '24 04:10 thisisobate

@thisisobate please check how you like the new graphics :) also dark mode definitely still needs some work

mowies avatar Oct 07 '24 11:10 mowies

mobile version also needs some work still 😅

mowies avatar Oct 07 '24 11:10 mowies

could we change the text at the top, gradient on gradient is hard to read

oh yes, @mowies is taking a look at this. please note that this issue only applies to dark theme

thisisobate avatar Oct 16 '24 17:10 thisisobate

@thisisobate @nate-double-u we made some updates to dark mode, pls have a look one more time. We are happy with it now :)

mowies avatar Oct 17 '24 09:10 mowies

@thisisobate one more thing on mobile: it would be better to always have the text first and then have the picture below that. right now, it's always picture first, and then text

mowies avatar Oct 17 '24 09:10 mowies

I'm intrigued by your CI -- does the deploy preview automatically refresh? (I'm not seeing some of the changes that I'd expect to see based on the commits)

nate-double-u avatar Oct 17 '24 14:10 nate-double-u

(for instance, the CNCF logo still looks like the original one instead of the colour one that Uche updated)

nate-double-u avatar Oct 17 '24 14:10 nate-double-u

(for instance, the CNCF logo still looks like the original one instead of the colour one that Uche updated)

did you try disabling the cache?

odubajDT avatar Oct 17 '24 14:10 odubajDT

I'll try that -- but some things did update 😅

nate-double-u avatar Oct 17 '24 14:10 nate-double-u

I see the updates now.

I'm not sure about the AI generated images we're introducing. I don't think that they hold to the nautical theme that the project has historically had (I understand potentially wanting to move away from it, but if that's the case we're only partly moving away from it).

  • The metrics image doesn't speak to metrics (and I'm not sure i understand the cat being there)
  • The deployment checks doesn't really speak to what's happening (it reads more like checking a developer than checking a deployment)

The lighthouse theming and icons on kptn.sh are pretty strong, I'd be hesitant to move away from them.

Could we hold for a more thorough design review before merging this?

nate-double-u avatar Oct 17 '24 15:10 nate-double-u

@nate-double-u I'd be glad to have better images! This is the best we could come up with as engineers 😅 If we get some design support and maybe therefore better graphics, I'm all for it!

mowies avatar Oct 21 '24 06:10 mowies

I do like the looks of this! Thanks so much! I guess I don't really understand how the graphic for Metrics and Orchestrate relate to the theme but they are attractive and I, personally, like the cat ;-)

A couple verbage and content-flow questions for your consideration. None of these are show-stoppers:

  • For the "Deployment Observability" block:
    • The second bullet is a verb whereas the first and third bullets are nouns. Perhaps reword the second bullet to be "Troubleshooting assistance for failed deployments" but that might be too long. I guess just "Troubleshooting failed deployments" works although it is less precise.
    • Shouldn't these items spell out "OpenTelemetry" rather than using "OTel"? I googled "OTel" and it does eventually get one to the OpenTelemetry page but the first hits are to various hotel booking pages. I'm not sure what the rules are for using the "OTel" string and the cognoscenti will no what we mean but it seems that our landing page should use the official name
  • When the user clicks on "Get Started", they go into the "Get started" section of the docs. This makes some sense but it would be better if they read the "Core Concepts piece before they dig into the tutorials -- it kind of paints the big picture of what Keptn can do and all. I see two options:
    • Make "Get Started" link to "Core Concepts". Each subsection of the latter doc links to the "Get started" exercise for that component
    • Add a sentence like the following to the "Get started" landing page: "Before attempting these tutorials, we recommend that you read the "Core Concepts[link]" section
    • Yes, this is outside the scope of this PR. I created https://github.com/keptn/lifecycle-toolkit/issues/3867 for it
  • Under "Learn from the Community", the "Discover More" button takes me to the Keptn youtube channel, which is still kind of a mess. The three videos that I see without scrolling are "Migrating experience from Spinnaker to Keptn", the "Keptn New Contributor" meeting from Sept 11 2023 -- which is the one where Ondrej walks through the process of setting up a development environment so useful but perhaps should be re-titled or at least annotated, and a "Keptn in Google Summer of Code" from April 2022.
    • Yes, the mess that is the youtube channel is beyond the scope of this PR unless we want to curate the videos that get top billing
  • Should we have a link to the blogs? Yes, they have a tab in the Documentation so I don't know...

StackScribe avatar Nov 13 '24 10:11 StackScribe

A bunch of those WARNINGs in the htmltest log sound ominous... You can search for "WARNING" in the log to see them quickly

StackScribe avatar Nov 13 '24 10:11 StackScribe

Hi @StackScribe I'm actually working on a new design of the website. Will open another PR soon

thisisobate avatar Nov 13 '24 10:11 thisisobate

@thisisobate shall we close this one in the meantime?

mowies avatar Nov 13 '24 11:11 mowies

sure...feel free

thisisobate avatar Nov 13 '24 14:11 thisisobate