Create Troubleshooting Guide for BI

[LakshanWeerasinghe]

Description

Currently, we don’t have proper documentation to help users resolve issues that may occur when installing or using BI. The goal of this documentation is to make it easier for anyone to isolate issues, attempt fixes themselves, or report problems with more specific details.

This troubleshooting guide should cover:

1. Installation

   • Step-by-step installation instructions for BI.
   • Common installation errors and how to fix them.

2. Key Artifacts and File Locations

   • Where to find important BI artifacts (e.g., .ballerina folder, cache, logs).
   • Explanation of their purpose and how they help in troubleshooting.

3. Logs and Debugging

   • How to enable logs.
   • From where the users can find the logs.

4. Configuring BI

   • How to point to custom LS backends.
   • How to update configurations when BI is not working as expected.

5. Common Issues and Fixes

   • Known issues (e.g., startup failures, cache corruption, connectivity issues).
   • How to reinitialize BI if it’s stuck.

6. Reporting Issues

   • What information to collect before raising an issue (logs, config details, environment info).
   • Where and how to report issues.

7. Environment & Compatibility

   • Supported OS and prerequisites.
   • How to verify environment setup (Java version, Ballerina version, dependencies).

Version

No response

[wso2-engineering-bot]

@wso2-engineering-bot create a PR for this issue following repo conventions

[Sachindu-Nethmin]

@wso2-engineering-bot