Enhance local development documentation (#2162)

Author: pjsharath28

docs/book/src/developer/e2e.md

@@ -4,7 +4,7 @@
 
 * The end-to-end tests for `VPC` and `PowerVS` run on an internal prow cluster on IBM Cloud.
 * Resource management is handled via [boskos](https://github.com/kubernetes-sigs/boskos) which is an efficient way to lease infra and clean up after every run.
-* The E2E tests use the Cluster API test framework. For more information on developing E2E tests, refer [here](https://cluster-api.sigs.k8s.io/developer/e2e).
+* The E2E tests use the Cluster API test framework. For more information on developing E2E tests, refer [here](https://cluster-api.sigs.k8s.io/developer/core/e2e).
 
 ### Jobs
 

docs/book/src/developer/tilt.md

@@ -75,7 +75,7 @@ Next, create a `tilt-settings.yaml` file and place it in your local copy of `clu
 Make sure to set a valid API key for the field `IBMCLOUD_API_KEY`.
 
 ```yaml
-default_registry: "gcr.io/you-project-name-here"
+default_registry: "localhost:5001"
 provider_repos:
 - ../cluster-api-provider-ibmcloud
 enable_providers:
@@ -104,7 +104,7 @@ extra_args:
 To deploy workload cluster with [clusterclass-template](/topics/powervs/clusterclass-cluster.html), enable the feature gates `EXP_CLUSTER_RESOURCE_SET` and `CLUSTER_TOPOLOGY` to `true` under kustomize_substitutions.
 
 ```yaml
-default_registry: "gcr.io/you-project-name-here"
+default_registry: "localhost:5001"
 provider_repos:
 - ../cluster-api-provider-ibmcloud
 enable_providers:
@@ -121,7 +121,7 @@ kustomize_substitutions:
 
 To deploy workload cluster with Custom Service Endpoint, Set `SERVICE_ENDPOINT` environmental variable in semi-colon separated format: `${ServiceRegion}:${ServiceID1}=${URL1},${ServiceID2}=${URL2...}`
 ```yaml
-default_registry: "gcr.io/you-project-name-here"
+default_registry: "localhost:5001"
 provider_repos:
 - ../cluster-api-provider-ibmcloud
 enable_providers:
@@ -136,10 +136,10 @@ kustomize_substitutions:
 
 ### 3.  Configuration to use observability tools
 
-- cluster-api provides support for deploying observability tools, More information about it is available in cluster-api [book](https://cluster-api.sigs.k8s.io/developer/logging#developing-and-testing-logs).
+- cluster-api provides support for deploying observability tools, More information about it is available in cluster-api [book](https://cluster-api.sigs.k8s.io/developer/core/logging#developing-and-testing-logs).
 
 ```yaml
-default_registry: "gcr.io/you-project-name-here"
+default_registry: "localhost:5001"
 deploy_observability:
    - promtail
    - loki
@@ -169,7 +169,7 @@ extra_args:
       - "--logging-format=json"
 ```
 
-**NOTE**: For information about all the fields that can be used in the `tilt-settings.yaml` file, check them [here](https://cluster-api.sigs.k8s.io/developer/tilt.html#tilt-settings-fields).
+**NOTE**: For information about all the fields that can be used in the `tilt-settings.yaml` file, check them [here](https://cluster-api.sigs.k8s.io/developer/core/tilt.html#tilt-settings-fields).
 
 ## Run Tilt
 

docs/book/src/topics/powervs/creating-a-cluster.md

@@ -40,6 +40,7 @@ following the steps below.
     > **Note:**
     > - Set `EXP_CLUSTER_RESOURCE_SET` to `true` as the cluster will be deployed with external cloud provider which will create the resources to run the cloud controller manager.
     > - The `IBMPOWERVS_IMAGE_NAME` value below should reflect the name of the custom image and the `kubernetes-version` value below should reflect the kubernetes version of the custom image.
+    > - While working with unreleased versions like from main branch, instead of `--flavor=powervs` use `--from=./templates/cluster-template-powervs.yaml`.
 
     ```console
     IBMPOWERVS_SSHKEY_NAME="my-pub-key" \
@@ -139,6 +140,8 @@ following the steps below.
 #### Prerequisites: 
 - Already existing infrasturcture resources can be used for cluster creation by setting either the ID or name in spec. If neither are specified, the cluster name will be used for constructing the resource name. For example, if cluster name is `capi-powervs`, PowerVS workspace will be created with name `capi-powervs-serviceInstance`.
 
+**Note:** While working with unreleased versions like from main branch, instead of `--flavor=powervs-create-infra` use `--from=./templates/cluster-template-powervs-create-infra.yaml`.
+
   ```
     IBMCLOUD_API_KEY=XXXXXXXXXXXX \
     IBMPOWERVS_SSHKEY_NAME="my-ssh-key" \
@@ -163,6 +166,8 @@ following the steps below.
 #### Prerequisites:
 - To deploy a cluster using [ClusterClass](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-class/index.html), set `CLUSTER_TOPOLOGY` environment variable to `true`.
 
+**Note:** While working with unreleased versions like from main branch, instead of `--flavor=powervs-clusterclass` use `--from=./templates/cluster-template-powervs-clusterclass.yaml`.
+
   ```
   IBMPOWERVS_CLUSTER_CLASS_NAME="powervs-cc" \
   IBMPOWERVS_SSHKEY_NAME="my-pub-key" \

docs/book/src/topics/vpc/creating-a-cluster.md

@@ -12,8 +12,9 @@ following the steps below.
 
 1. Using clusterctl, render the yaml through templates and deploy the cluster
 
-
-    **Note:** the `IBMVPC_IMAGE_NAME` value below should reflect the name of the custom qcow2 image
+    > **Note:**
+    > - The `IBMVPC_IMAGE_NAME` value below should reflect the name of the custom qcow2 image.
+    > - While working with unreleased versions like from main branch, instead of `--flavor=vpc-clusterclass` use `--from ./templates/cluster-template-vpc-clusterclass.yaml`.
 
     ```console
     IBMCLOUD_API_KEY="XXXXXXXXXXXXXXXXXX" \

docs/book/src/user/troubleshooting.md

@@ -52,3 +52,7 @@
     ```
    ssh -J root@<public_ip> root@<dhcp_ip>
    ```
+
+### 3. Failed to apply a cluster template with release not found error
+
+While trying to apply a cluster template from unreleased version like from main branch, we will run into error like `release not found for version vX.XX.XX`. In that case, instead of `--flavor` we need to use `--from=<path_to_cluster_template>`.