new updates on mkdocs #128
Conversation
|
@Moses-Mk can you please go through your PR and try to fix some issues? I think there are some assumptions in the documentation which are not a part of mlinfra tool. |
docs/code/aws/cloud_vm.md
Outdated
| @@ -1,75 +1,500 @@ | |||
| `cloud_vm` deploys MLOps `stack` on top of Cloud provider VMs. | |||
There was a problem hiding this comment.
This inline before the main heading doesn't look very nice.
docs/code/aws/cloud_vm.md
Outdated
| @@ -1,75 +1,500 @@ | |||
| `cloud_vm` deploys MLOps `stack` on top of Cloud provider VMs. | |||
| # ☁️ Cloud Infrastructure Examples | |||
There was a problem hiding this comment.
Can you rename this from Cloud Infrastructure to Cloud VM examples?
docs/code/aws/cloud_vm.md
Outdated
|
|
||
| Welcome to the **Cloud Infrastructure** examples! This section contains ready-to-use configurations to help you deploy scalable MLOps stacks on cloud platforms like AWS. Each example is designed to showcase a different tool or workflow, making it easier for you to find and deploy the infrastructure that fits your needs. |
There was a problem hiding this comment.
Same comment for the cloud infrastructure here.
docs/code/aws/cloud_vm.md
Outdated
| 3. **Choose an Example**: | ||
| Navigate to the example you want to deploy: | ||
| ```bash | ||
| cd examples/cloud_infra/dagster |
There was a problem hiding this comment.
There is no cloud_infra folder in examples path. Can you update this?
There was a problem hiding this comment.
ooh I apologize i had created that path temporarily and forgot to update it here, I will surely work on these
docs/code/aws/cloud_vm.md
Outdated
| ``` | ||
|
|
||
| 4. **Configure AWS Credentials**: | ||
| Modify the `terraform.tfvars` file to update your AWS account details. Make sure your AWS credentials are correctly configured. |
There was a problem hiding this comment.
Wait, why are you mentioning this terraform.tfvars file? This file is not necessary when you're deploying via mlinfra
I have made the corrections as per your review. Please specify the assumptions anything specific so that I can correct it. Thanks |
This new updates has considered the proper arrangement of the files addressing the previous issue in our commit where by the files where not appearing on the browser after running mkdocs serve.
please try again this time. Thanks