Description

The navbar (on left) has a lot of icons which aren't required. The indentation of nav items is sufficient to give idea about various sections/pages.

The theme doesn't allow navigating to list pages. The existing Kluctl documentation has lots of content in list pages.

Tasks

• Remove icons
• Convert list page buttons to links, so that a visitor can navigate to list pages
• Decrease the height of navbar items
• Decrease the width of the navbar if possible

Operating system

MacOS

Browser

ChomeOS

Bug description

The tutorials explain how to deploy the examples, but not how to delete them when done.

Steps to reproduce

Please update the tutorials https://kluctl.io/docs/kluctl/get-started/ to describe to users how they can clean up the examples the tutorials have us perform via kluctl deploy -t

❯ kluctl delete -t local
✓ Your kluctl version is up-to-date
✓ Loading kluctl project
✓ Initializing k8s client
✓ Rendering templates
✓ Rendering Helm Charts
✓ Building kustomize objects
✓ Postprocessing objects
✗ deletion without a discriminator is not supported

Relevant log output

No response

Description

Improve legibility of code blocks.

Tasks

• Increase font size
• Increase line height

Operating system

N/A

Browser

N/A

Bug description

Url for install script from documentation https://kluctl.io/install.sh doesn't serve installation script.

For the others who experiencing same problem could be temporarily used direct URL: https://raw.githubusercontent.com/kluctl/kluctl/main/install/kluctl.sh

Steps to reproduce

No response

Relevant log output

No response

Operating system

NixOS 23.11

Browser

Firefox 122.0

Bug description

The website exclusively renders using serif fonts, which looks weird.

A closer inspection of the CSS values reveals that a specific list of fonts without a fallback is being used, and I have none of the fonts:

Steps to reproduce

Open the website on a device without any of the fonts specified in the CSS.

Relevant log output

No response

Replace the theme favicons with Kluctl favicons.

Description

• The current landing page does not posses a professional look.

• Showing 13 features at once can be overwhelming for a visitor

• Regarding the Kluctl demo video on the hompage:

  • The video with two different windows can be quite confusing for a visitor initially
  • Loading ~ 19 MB video in the above the fold can be a bad UX
  • Ensure that there is no video content above the fold on the website; prioritize static elements for the initial user experience
  • Either relocate it to a later section on the homepage or use a GIF if necessary

Tasks

• Design a new layout for homepage in Figma
• Preserve the current website structure, links
• Add a recent blog section on the homepage to show latest updates/developments
• Add a GitHub icon in the header - visitor can checkout GitHub link immediately

Operating system

N/A

Browser

N/A

Bug description

The docs for deployment.yaml path-based includes currently contain the following text:

Only directories that are part of the kluctl project are allowed.

This is also the behavior that occurs in a simple kluctl project, i.e. path-based includes referencing directories anywhere else will not work (e.g. ../).
However, as per this thread in Slack this behavior changes when the project is inside of a git repository, in which case all paths inside the git repository are allowed.
This means that in a git repository containing two projects side-by-side one of them can include the other one with a ../other-project include.
This special behavior for includes inside git repositories should be documented.

Steps to reproduce

No response

Relevant log output

No response

Description

We need to display the current heading (active item) in the table of content in a different way. But changing the background color for the active item is quite distracting. Changing only left border should be enough.

The ToC is too wide currently.

Tasks

• Change only left border for active item in ToC
• Reduce width of ToC

What is the name of your company?

Billrush

What does your company do and how do you use kluctl?

Bill Rush – From Bill To Bank is a New Zealand fintech start-up established in 2019. The Bill Rush team have been quietly working away for the past three years on developing a next generation customer billing and settlement system that we believe will become a core business technology around which organisations can build better businesses that are more resilient, robust and easier to operate and grow .

Our Stack is based heavily on Microk8s, primarily using Open Source Technologies. We have two primary Products, our Billing Stack and our Cluster Management Stack. We use Kluctl as a core deployment tool with components that we love being the Helm Integration, Secrets Transformer, Deployment Diffs, flexible Deployment Targets and the Templating with Jinja Vars Substitution.

http://billrush.co.nz

URL to your company logo

https://billrush.co.nz/wp-content/uploads/2022/06/cropped-400X100_Bill_Rush-Logo-White-1-1.png

authorization

• I agree to the statement above.

Please provide the name of your company with am optional and very short description of what you do.

For example, "Super Duper Corp, your consultancy buddy"

SITA is the world’s leading specialist in air transport communications and information technology.

Provide an optional URL to link to. The link will be used on the company name and logo.

https://www.sita.aero/

Provide an URL to your company logo. It will be part of the adopters list.

Please use a logo that works well on white background (check the existing adopters list).

https://www.sita.aero/static/images/logo.svg

Please provide a short testimonial describing how and why Kluctl solves something for you.

Check the existing list of adopters for real world examples.

Thanks to Kluctl, we successfully transitioned our non-cloud-native applications onto Kubernetes using GitOps. Its templating engine facilitated the creation of essential configurations for our applications.

What is your name and title at your company? This will be shown in the adopters section.

Example: "John Doe, CTO at Super Duper Corp."

Robert Zeppik, Senior Lead Cloud Engineer at SITA

Optionally describe what your company does and maybe how you found out about Kluctl.

This will not be part of the adopters list, but helps us a lot to understand where adopters come from and why
they ended up using Kluctl.

We don’t just connect the global aviation industry. We apply decades of experience and expertise to address almost every core business, operational, baggage, and passenger process in air transport.

SITA at Airports:
Solutions and services for airlines, airports, ground handlers operating at the airport spanning operational and business processes, baggage and passenger management.
SITA at Borders:
We ensure that governments can strike a balance between critical security measures, and safer, easier travel.
SITA at Aircraft:
We’re powering a digital shift through our airplane solutions that will reinvent the operations of aircraft, flight, and on-board experience for the benefit of all stakeholders.

Kluctl is at present used in SITA at Airport portfolio to deploy AMS (Airport Management System).

authorization

• I agree to the statement above.

Description

The current documentation theme docsy is a good choice.

While Docsy has a great set of features for a documentation website, it is worth considering a change to a theme with a more visually appealing design.

The Hugo community has a variety of documentation themes that not only maintain functionality but also provide a more aesthetically pleasing and engaging developer experience. We should explore these alternatives to enhance the overall look and feel of the documentation website.

Please provide the name of your company with am optional and very short description of what you do.

For example, "Super Duper Corp, your consultancy buddy"

E3DC, a Hagerenergy GmbH company, the all-in-one energy storage solution

Provide an optional URL to link to. The link will be used on the company name and logo.

https://e3dc.com

Provide an URL to your company logo. It will be part of the adopters list.

Please use a logo that works well on white background (check the existing adopters list).

https://www.e3dc.com/wp-content/uploads/2022/09/E3DC_logo-22.svg?x79385

Please provide a short testimonial describing how and why Kluctl solves something for you.

Check the existing list of adopters for real world examples.

Easy and straight forward kubernetes deployments which makes our live in the GitOps and DevOps daily business much more easy and reliable.

Optionally describe what your company does and maybe how you found out about Kluctl.

This will not be part of the adopters list, but helps us a lot to understand where adopters come from and why
they ended up using Kluctl.

We worked together in the past and I was there, when kluctl was founded :-).

authorization

• I agree to the statement above.

Operating system

Fedora 38

Browser

Firefox

Bug description

Pasting the website link into slack shows the following as the summary:

I'm reasonably sure this is not correct ;)

I took a quick peek through the site config, but couldn't see it set incorrectly anywheres, but figured you may want to be aware of this!

Steps to reproduce

Paste the link into slack. (Latest client being used here, FWIW.)

Relevant log output

No response

What is the name of your company?

KGS Software GmbH

What does your company do and how do you use kluctl?

KGS Software was founded in 2000 and creates an archive middleware with certified connections via SAP ArchiveLink, SAP ILM, SAP CMIS or for any other application via REST API. We rewrote the software to be cloud-centered with Kubernetes as a core technology stack.

KGS Software GmbH was in a hybrid position where some applications needed in the daily works were already in a k8s-environment while others were in a local, containerized context. Before integrating kluctl, the process of deploying applications was heavily dependent on manual work and maintaining test-environments was a labor-intense task. Setting up new environments or helping colleges entering the k8s-world was more about learning processes, rather than technology. With the ability of templating helm-values or k8s-yamls we were able to deploy new clusters faster and reduced the work in labor on the task and understanding the process immensely, while gaining a lot of technical insight from the diff-features.
Providing test-environments and getting used to the new context was made easier for the DevOps and more accessible and understandable for the Software Engineers, Consultants and Supporters.

URL to your company logo

https://jochen-saalfeld.de/logo-kgs-secondary-fullcolor-positive.png

authorization

• I agree to the statement above.

Description

By default the theme logo appears in the documentation website. This should be replaced with Kluctl SVG.

Please provide the name of your company with am optional and very short description of what you do.

For example, "Super Duper Corp, your consultancy buddy"

Hellmann Worldwide Logistics, one of the largest international logistics providers

Provide an optional URL to link to. The link will be used on the company name and logo.

https://www.hellmann.com/

Provide an URL to your company logo. It will be part of the adopters list.

Please use a logo that works well on white background (check the existing adopters list).

https://upload.wikimedia.org/wikipedia/commons/e/e0/Logo_Hellmann_Worldwide_Logistics_RGB.jpg

Please provide a short testimonial describing how and why Kluctl solves something for you.

Check the existing list of adopters for real world examples.

We use Kluctl for configuration management and GitOps, beginning with the management of clusters themselves using ClusterAPI across various cluster environments. These environments are utilized in a broad spectrum of customer and employee-facing products. Kluctl aids us by integrating user-friendly templating, Helm charts, Kustomize, and GitOps with the controller from development through to production. This ensures we maintain oversight and enables us to provide blueprints for teams. Consequently, it plays a crucial role in our internal developer platform.

What is your name and title at your company? This will be shown in the adopters section.

Example: "John Doe, CTO at Super Duper Corp."

Mathias Gebbe, Team Lead Developer Experience Platform Team at Hellmann Worldwide Logistics

Optionally describe what your company does and maybe how you found out about Kluctl.

This will not be part of the adopters list, but helps us a lot to understand where adopters come from and why
they ended up using Kluctl.

No response

authorization

• I agree to the statement above.

Description

Change the documentation accent colors to suit Kluctl brand colors.

The theme has a predefined set of accent colors, which are: blue (default), green, red, yellow, emerald, cardinal, magenta, cyan.

Emerald is pretty close to Kluctl brand colors.

Tasks

• Start with emerald & see if it is a good fit
• Modify the color variables if required
• Check colors for dark mode
• Check color compliance with accessibility standards

Resources

• https://hslpicker.com/ - HSL color picker
• https://colourcontrast.cc/ - Given two colors (background & foreground) this website shows AA Large, AAA Large, AA Normal AAA Normal accessibility compliance.

Notes

• How HSL works: pick a Hue from 0 to 360 and with saturation at 100 and luminosity at 50 and you'll have the purest form of that color. Reduce the saturation and you move towards gray. Increasing the luminosity moves you towards white, decreasing it moves you towards black.
• The colors must pass all accessibility levels, both for light & dark mode.

Summary

The footer for the docs section is almost empty. Use the same footer that is used for the landing page here.

Tasks

• Consistent footer - use the same footer on all pages (home, docs, blog etc.).
• Remove CTA section from footer - it's primarily developers who browse the docs section

We need to add documentation for the new kluctl-controller metrics. This is a follow-up task for kluctl/flux-kluctl-controller#90.