docs: Add How Tos in docs (#402)

docs/faq/how-to/application-deployment.md

@@ -0,0 +1,49 @@
+# Category: Application Deployment
+
+This page contains that are mostly related to application deployment procedure.
+
+## How to Define Deploy and Clean Pipelines for a Specific Environment?
+
+To define a custom deploy/clean pipeline, you need to create [TriggerTemplate](https://github.com/epam/edp-tekton/blob/master/charts/pipelines-library/templates/triggers/cd/clean.yaml), [Pipeline](https://github.com/epam/edp-tekton/blob/master/charts/pipelines-library/templates/pipelines/cd/clean.yaml), and [Task](https://github.com/epam/edp-tekton/blob/master/charts/pipelines-library/templates/tasks/cd/clean.yaml).
+
+More details are provided in the [Customize Environment Cleanup](../../operator-guide/cd/customize-environment-deletion.md) and [Customize Deploy Pipeline](../../operator-guide/cd/customize-deploy-pipeline.md) pages.
+
+## How to Deploy a Specific Version of an Application?
+
+When deploying an application, select the specific application version in the **Deployed version** field. For more details, read the [Manage Deployment Flows](../../user-guide/manage-environments.md#deploy-application) page.
+
+## How to Change Variables for an Environment and Redeploy with Updated Variables?
+
+KubeRocketCI leverages Helm charts for application deployments, with each application repository including a Helm chart located in the `deploy-templates` folder. This chart defines the default parameters used during deployment.
+
+To customize parameters for a specific environment, a `values.yaml` file is utilized. This file provides flexibility by allowing environment-specific configurations without altering the default settings. Instead of modifying parameters directly within the `deploy-templates` directory, which we strongly discourage, a structured approach is followed by managing the `values.yaml` file in the `krci-gitops` repository. This ensures a clean and maintainable configuration process for Helm chart deployments.
+
+:::note
+Do not store sensitive information (e.g., passwords, API keys) in the `values.yaml` file. Instead, use a secret management tool like **External Secret Operator** or **Vault by HashiCorp** to handle sensitive data securely.
+:::
+
+Redefining Helm chart configuration using the **Values Override** option is described in the [Deploying Feature Branches with KubeRocketCI](../../use-cases/deploy-application-from-feature-branch.md) page.
+
+## How to Restart an Application?
+
+To restart an application, follow these steps:
+
+1. Navigate to the desired environment.
+2. On the environment details page, click the **Argo CD** button:
+
+    ![Open application in Argo CD](../../assets/faq/open-in-argo-cd.png "Open application in Argo CD")
+
+3. Select the application you want to restart:
+
+    ![Select application](../../assets/faq/select-argo-cd-application.png "Select application")
+
+4. Click the actions button in the deployment block and select restart:
+
+    ![Restart deployment](../../assets/faq/restart-application.png "Restart deployment")
+
+5. Once the restart process is complete, ensure that the **Argo CD application status** is **Synced** and **Healthy** to confirm the new version is running successfully.
+
+## How to Enable Local Access to an Environment Located in Kubernetes?
+
+Use `kubectl` and `kubelogin` with a valid `kubeconfig` file.
+

docs/faq/how-to/developer.md

@@ -0,0 +1,115 @@
+# Category: Developer
+
+This page contains that are mostly asked by developers.
+
+## How to Add and Manage Applications?
+
+The [Add Application](../../user-guide/add-application.md) explains the process of adding applications, whereas the [Manage Applications](../../user-guide/application.md) page clarifies how to manage them effectively.
+
+## What Types of Pipelines Are Available in the Platform, and What Are Their Purposes?
+
+The platform supports review, build, deploy, and clean pipeline types. Review pipeline assesses application's code quality using linters and SonarQube. Build pipelines create a new application image. Deploy pipelines serve to deploy an application to the dedicated environment. Clean pipelines execute custom application cleanup logic when you delete an application from the environment. More details are provided in the corresponding [documentation](../../user-guide/tekton-pipelines.md).
+
+## How to Define Review and Build Pipelines for a Specific Project Branch?
+
+You can define custom review and build pipelines using either a [branch-specific approach](../../use-cases/custom-pipelines-flow.md) or using a [custom build tool or framework](../../use-cases/tekton-custom-pipelines.md).
+
+## How Do I Create a New Pipeline/Task/Trigger Template on the Platform?
+
+Directly create new resources in the cluster, and after testing, apply them in the pipelines repository and synchronize them in the Argo CD application. More details are provided in the [Use Case](../../use-cases/custom-pipelines-flow.md).
+
+## How to Trigger a Pipeline for a Patch?
+
+A review pipeline is automatically triggered once a new pull request is created in Version Control System. For more details, please refer to the [KubeRocketCI: Tekton Overview](../../user-guide/tekton-pipelines.md) page.
+
+## How to Re-Trigger a Failed Review Pipeline for a Patch?
+
+Use the `/recheck` or `/ok-to-test` comment in a pull request. Alternative methods are described in the [KubeRocketCI: Tekton Overview](../../user-guide/tekton-pipelines.md#review-pipeline) page.
+
+## How to Debug a Failed Review Pipeline for a Patch?
+
+To debug a failed review pipeline, enter the pipeline details and then enter the failed pipeline task to see the error message. To learn more how to inspect pipelines, read the [Pipelines Overview](../../user-guide/pipelines.md) page.
+
+## When I Create a Pull Request, the Review Pipeline Does Not Appear. How Can I Trigger the Review Pipeline?
+
+If the pipeline does not appear, please use the `/recheck`or `/ok-to-test` comment in the pull request. For more details, read the [KubeRocketCI: Tekton Overview](../../user-guide/tekton-pipelines.md#review-pipeline) page.
+
+## How to Verify the Inclusion of My Changes in a Deployment Version Within KubeRocketCI
+
+To ensure that your changes are included into the deployment version, follow the steps below:
+
+1. In KubeRocketCI portal, navigate to the application details page.
+2. Open the application source code by clicking the **Git** button.
+3. In the Version Control System, search the application tag that represents the application version you deployed.
+4. View the commits included into the application tag.
+
+## How to Automate Deployment of Changes From Feature Branches?
+
+Strategies for streamlining feature branch deployments are described in the [Deployment Strategies Overview](../../operator-guide/cd/auto-stable-trigger-type.md) page.
+
+## How to Tell if the Application Changes Are Built and Ready for Deployment?
+
+A simplified approach to verify a successful merge and deployment preparedness. Check the build pipeline status and tag in Bitbucket.
+
+## What Actions Do I Take When a Build Pipeline Fails?
+
+To debug a failed build pipeline, enter the pipeline details and then enter the failed pipeline task to see the error message. To learn more how to inspect pipelines, read the [Pipelines Overview](../../user-guide/pipelines.md) page.
+
+## How to (Re)Deploy an Application?
+
+The process of deploying an application is described in the [Manage Deployment Flows](../../user-guide/manage-environments.md#deploy-application) page. These guidelines apply to the redeploying procedure as well.
+
+## How to Remove Applications or Perform Environment Cleanup?
+
+To remove an application from an environment or perform its cleanup, please refer to the [Manage Deployment Flows](../../user-guide/manage-environments.md#deploy-application) page.
+Note that the optimal environment cleanup can be performed only when you [Customize Environment Cleanup](../../operator-guide/cd/customize-environment-deletion.md).
+
+## Understanding the Deployment Flow and Its Relation to Environments?
+
+Deployment Flow is a business entity that manages the delivery process of the selected application set via environments. For more information about Deployment Flows and Environments in KubeRocketCI, read the [Add Deployment Flow](../../user-guide/add-cd-pipeline.md) page.
+
+## How Can I Access Application Logs?
+
+There are two options to view application logs:
+
+1. **Using KubeRocketCI portal**: Navigate to the environment details page and click the **Show logs** button in front of the application whose logs you want to view. More information is provided in the [Manage Deployment Flows](../../user-guide/manage-environments.md#troubleshoot-application). This method is preferable when your application is deployed in the same cluster as the platform.
+2. **Using a pod's logs window in Argo CD**: This method implies using Argo CD to view the application logs. It is preferable when the application is deployed into a [remote cluster](../../user-guide/add-cluster.md).
+
+To view application logs via Argo CD, follow the steps below:
+
+1. On the environment details page, click the **Argo CD** button.
+2. Enter the application whose logs you want to view.
+3. Click the pod block to view its details:
+
+    ![Open pod](../../assets/faq/logs-application-pod.png "Open pod")
+
+4. Navigate to the **Logs** tab to view the application logs:
+
+    ![Application logs in Argo CD](../../assets/faq/view-application-logs.png "Application logs in Argo CD")
+
+## How Can I Open the Application Terminal?
+
+There are two options to view application logs:
+
+1. **Using KubeRocketCI portal**: Navigate to the environment details page and click the **Show terminal** button in front of the application whose terminal you want to open. More information is provided in the [Manage Deployment Flows](../../user-guide/manage-environments.md#troubleshoot-application). This method is preferable when your application is deployed in the same cluster as the platform.
+2. **Using a pod's terminal window in Argo CD**: This method implies using Argo CD to view the application terminal. It is preferable when the application is deployed into a [remote cluster](../../user-guide/add-cluster.md).
+
+To open application terminal via Argo CD, follow the steps below:
+
+1. On the environment details page, click the **Argo CD** button.
+2. Enter the application whose terminal you want to open.
+3. Click the pod block to view its details:
+
+    ![Open pod](../../assets/faq/logs-application-pod.png "Open pod")
+
+4. Navigate to the **Terminal** tab to view the application terminal:
+
+    ![Application terminal in Argo CD](../../assets/faq/application-terminal.png "Application terminal in Argo CD")
+
+## How Can I Access Pipeline Logs?
+
+To learn how to read pipeline logs, read the [Pipelines Overview](../../user-guide/pipelines.md) page.
+
+## How to Check Application Metrics?
+
+Application metrics are displayed on the application details page via DependencyTrack and SonarQube widgets. To view the widgets, navigate to the Components section, enter the component by clicking its name and select the **Overview** tab.

docs/faq/how-to/devops.md

@@ -0,0 +1,19 @@
+# Category: DevOps
+
+This page contains that are mostly asked by DevOps engineers.
+
+## How to Integrate Git Servers With KubeRocketCI?
+
+To integrate a Git Server with KubeRocketCI, read the [Add Git Server](../../user-guide/add-git-server.md) page.
+
+## How to apply changes in KubeRocketCI deployment configuration?
+
+To change the deployment configuration, use the **Values Override** option when deploying an application. For more information, please refer to the [Manage GitOps](../../user-guide/gitops.md) page.
+
+## How to Access Kubernetes Using the CLI (kubectl) Command?
+
+Use `kubectl` and `kubelogin` with a valid kubeconfig file.
+
+## How to manage access to KubeRocketCI/Kubernetes?
+
+KubeRocketCI offers a set of default roles that come with KubeRocketCI out of the box. To learn more about these roles and their permissions, read the [Authentication and Authorization: Overview](../../operator-guide/auth/platform-auth-model.md#roles) page.

docs/faq/how-to/index.md

@@ -0,0 +1,9 @@
+# How To
+
+This section represents a collection of short answers to frequently asked question related on platform operation. Use this section as a manual for tasks you may encounter.
+
+There are three sections that contain answers to questions that are related to general issues:
+
+* [Developer](./developer.md)
+* [Application Deployment](./application-deployment.md)
+* [DevOps](./devops.md)

versioned_docs/version-3.10/faq/how-to/application-deployment.md

@@ -0,0 +1,49 @@
+# Category: Application Deployment
+
+This page contains that are mostly related to application deployment procedure.
+
+## How to Define Deploy and Clean Pipelines for a Specific Environment?
+
+To define a custom deploy/clean pipeline, you need to create [TriggerTemplate](https://github.com/epam/edp-tekton/blob/master/charts/pipelines-library/templates/triggers/cd/clean.yaml), [Pipeline](https://github.com/epam/edp-tekton/blob/master/charts/pipelines-library/templates/pipelines/cd/clean.yaml), and [Task](https://github.com/epam/edp-tekton/blob/master/charts/pipelines-library/templates/tasks/cd/clean.yaml).
+
+More details are provided in the [Customize Environment Cleanup](../../operator-guide/cd/customize-environment-deletion.md) and [Customize Deploy Pipeline](../../operator-guide/cd/customize-deploy-pipeline.md) pages.
+
+## How to Deploy a Specific Version of an Application?
+
+When deploying an application, select the specific application version in the **Deployed version** field. For more details, read the [Manage Deployment Flows](../../user-guide/manage-environments.md#deploy-application) page.
+
+## How to Change Variables for an Environment and Redeploy with Updated Variables?
+
+KubeRocketCI leverages Helm charts for application deployments, with each application repository including a Helm chart located in the `deploy-templates` folder. This chart defines the default parameters used during deployment.
+
+To customize parameters for a specific environment, a `values.yaml` file is utilized. This file provides flexibility by allowing environment-specific configurations without altering the default settings. Instead of modifying parameters directly within the `deploy-templates` directory, which we strongly discourage, a structured approach is followed by managing the `values.yaml` file in the `krci-gitops` repository. This ensures a clean and maintainable configuration process for Helm chart deployments.
+
+:::note
+Do not store sensitive information (e.g., passwords, API keys) in the `values.yaml` file. Instead, use a secret management tool like **External Secret Operator** or **Vault by HashiCorp** to handle sensitive data securely.
+:::
+
+Redefining Helm chart configuration using the **Values Override** option is described in the [Deploying Feature Branches with KubeRocketCI](../../use-cases/deploy-application-from-feature-branch.md) page.
+
+## How to Restart an Application?
+
+To restart an application, follow these steps:
+
+1. Navigate to the desired environment.
+2. On the environment details page, click the **Argo CD** button:
+
+    ![Open application in Argo CD](../../assets/faq/open-in-argo-cd.png "Open application in Argo CD")
+
+3. Select the application you want to restart:
+
+    ![Select application](../../assets/faq/select-argo-cd-application.png "Select application")
+
+4. Click the actions button in the deployment block and select restart:
+
+    ![Restart deployment](../../assets/faq/restart-application.png "Restart deployment")
+
+5. Once the restart process is complete, ensure that the **Argo CD application status** is **Synced** and **Healthy** to confirm the new version is running successfully.
+
+## How to Enable Local Access to an Environment Located in Kubernetes?
+
+Use `kubectl` and `kubelogin` with a valid `kubeconfig` file.
+