Add faas-cli diag documentation to troubleshooting page

[welteki]

Description

Add documentation for the faas-cli diag tool to the troubleshooting page. The section covers installation, configuration, and running diagnostics. An asciinema recording is embedded to demonstrate the tool in action.

Motivation and Context

Add a dedicated section to the troubleshooting page for the new faas-cli diag plugin.

• I have raised an issue to propose this change (required)

How Has This Been Tested?

The site has been run locally with docker and verified everything is displayed correctly.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I've read the CONTRIBUTION guide
• I have signed-off my commits with git commit -s

[reviewfn]

AI Pull Request Overview

Summary

• Adds documentation for the new faas-cli diag tool in the troubleshooting page
• Replaces the existing "Config Checker" section with a new "Diagnostics with faas-cli diag" section
• Includes installation and usage instructions for the diag plugin
• Embeds an asciinema recording demonstrating the tool
• Provides details on what diagnostic data is collected and how to access the output

Approval rating (1-10)

3

Summary per file

Summary per file

File path	Summary
docs/deployment/troubleshooting.md	Adds new diagnostics section replacing config checker, includes usage examples and embedded demo

Overall Assessment

The PR introduces documentation for a new diagnostic tool but contains a critical error with an incomplete sentence. The replacement of the config checker section without clear migration guidance raises concerns about user disruption. The embedded asciinema with autoplay may negatively impact user experience.

Detailed Review

Detailed Review

Incomplete sentence in new section

• Line 44 ends with "For e" which appears to be an incomplete sentence fragment. This needs to be completed or removed to ensure clarity.

Replacement of config checker

• The PR removes the entire "Config Checker" section without any mention of deprecation, migration, or relationship to the new tool. If this is intended as a replacement, clear guidance should be provided for users familiar with the old tool.

asciinema embedding concerns

• The embedded asciinema script has data-autoplay="true" and data-loop="true", which will automatically play and loop the recording. This could be distracting or annoying for users reading the documentation. Consider removing autoplay or providing a manual play option.

Potential security implications

• The tool collects sensitive diagnostic data including deployment YAMLs, container logs, and Prometheus metrics. The documentation should emphasize security considerations for sharing the generated tar.gz file, especially in production environments.

Consistency with existing documentation

• The new section uses a different style for code examples compared to surrounding sections. Ensure consistent formatting, such as using backticks for inline commands where appropriate.

Missing error handling guidance

• While the documentation covers basic usage, it lacks guidance on what to do if the tool fails or encounters permission issues in restricted clusters.

Date format in example

• The example output path uses a date format that may not match all systems. Consider using a more generic placeholder or noting potential variations.

AI agent details.

Agent processing time: 42.181s
Environment preparation time: 6.181s
Total time from webhook: 52.108s