docs: restructure content

[thisthat]

Fixes #2490

[netlify]

✅ Deploy Preview for keptn-lifecycle-toolkit ready!

Name	Link
🔨 Latest commit	1a3b9a2
🔍 Latest deploy log	https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/655c9ef0214408000827ba21
😎 Deploy Preview	https://deploy-preview-2522--keptn-lifecycle-toolkit.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[codecov]

Codecov Report

Merging #2522 (1a3b9a2) into main (a7322bd) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2522   +/-   ##
=======================================
  Coverage   85.51%   85.51%           
=======================================
  Files         155      155           
  Lines       10177    10177           
=======================================
  Hits         8703     8703           
  Misses       1196     1196           
  Partials      278      278           

Flag	Coverage Δ
certificate-operator	67.43% <ø> (ø)
component-tests	57.09% <ø> (ø)
lifecycle-operator	84.44% <ø> (ø)
metrics-operator	87.43% <ø> (ø)
scheduler	36.53% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

[StackScribe]

I reset the weights for the implementing folder. This spreads the range of numbers used, assigns a unique weight to each file, and groups the pages into general (0xx), metrics-operator (2xx), and lifecycle-operator (3xx)

[StackScribe]

Why is API Reference at the top level whereas the CRD Reference is buried two clicks down? I was skeptical about combining the architectural info with the CRE Reference and I really don't like how it looks now. The Architectural info should be somewhat esoteric information for sophisticated and curious users whereas the CRD Reference is material that regular users will use daily, once they are familiar with Keptn and not needing to look through the guides.

[StackScribe]

Why are the "Scheduler and Scheduling Gates" pages under metrics-operator in Components?

[mowies]

Why is API Reference at the top level whereas the CRD Reference is buried two clicks down? I was skeptical about combining the architectural info with the CRE Reference and I really don't like how it looks now. The Architectural info should be somewhat esoteric information for sophisticated and curious users whereas the CRD Reference is material that regular users will use daily, once they are familiar with Keptn and not needing to look through the guides.

@StackScribe moving the API reference into the component sections will be done in #2494

[mowies]

Why are the "Scheduler and Scheduling Gates" pages under metrics-operator in Components?

@StackScribe @thisthat that looks like a mistake to me and should be fixed

EDIT: no looking at the preview, it seems fine. the 2 most important components at the top (metrics, lifecycle operator), then scheduler and cert operator

[StackScribe]

Why are the "Scheduler and Scheduling Gates" pages under metrics-operator in Components?

@StackScribe @thisthat that looks like a mistake to me and should be fixed

EDIT: no looking at the preview, it seems fine. the 2 most important components at the top (metrics, lifecycle operator), then scheduler and cert operator

Ah, in the left frame, it looks like scheduling and cert-manager are under metrics-operator but it's just because top-level pages with no subsections are being rendered differently in the left fram TOC.

[StackScribe]

I still really dislike having the reference pages buried so they don't show on the top level. Would you consider a top-leve header of "Reference pages" with subsections for the components and then the CRD and API ref pages under those?

[mowies]

ok then let's try out a top level section called "reference" and put the api and crd reference inside that. i'll do that now

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication