fix: making docs better

2023-10-19 18:43:52 +05:30
parent ce543ceafb
commit 5d0b7c217e
1 changed files with 3 additions and 1 deletions
@@ -2,7 +2,7 @@

 ### Prerequisites:
 -	Clone the https://github.com/shuffle/shuffle repository using Git then, navigate to the functions/kubernetes directory, which contains all the necessary Kubernetes configuration files for deployment.
-	[Running a Kubernetes cluster](https://kubernetes.io/docs/setup/). You can do that with either minikube or run the cluster locally. If you're running on minikube and you can't access the ports 30007-30008, you can use ```kubectl port-forward svc/frontend 3000:80 -n shuffle``` to access the frontend on port 3000
+-	[Running a Kubernetes cluster](https://kubernetes.io/docs/setup/). You can do that with either minikube or run the cluster locally.
 - Ensure you have a local Docker registry set up to store and manage Docker images for applications built with Shuffle. While the registry is crucial for handling custom-built apps, you’ll still be able to run workflows without it. To setup a docker registry, if you have docker installed on one of your node run following commands.
  ```
  chmod +x generate_certs.sh
@@ -28,3 +28,5 @@ Step 2: Open the ```all-in-one.yaml``` file and review the configuration values.

 Now, open ```https://<YOUR_NODE_IP>:30008``` or ```http://<YOUR_NODE_IP>:30007```. You should be seeing a signup page. NODE_IP should be where the frontend is deployed.

+If you're running on minikube and you can't access the ports 30007-30008, you can use ```kubectl port-forward svc/frontend 3001:80 -n shuffle``` to access the frontend on port 3000
+