Update docs #10
Update docs #10
Conversation
kelkawi-a
requested review from
gtato,
onurmus,
mertalpt,
kian99,
AmberCharitos and
maabujayyab
| These tests validate extensive linting and formatting rules. Before creating a | ||
| PR, please run `tox` to ensure proper formatting and linting is performed. | ||
|
|
||
| ### Deploy |
There was a problem hiding this comment.
suggestion (if-minor): I would love to replace these type of instructions with the use of multipass and the charm-dev image.
On the other hand I guess these can be taken to be a reference than a tutorial. I can link the Airbyte developer guide doc for the steps if you want the multipass route.
There was a problem hiding this comment.
We could mention the use of multipass as an option, but I'm not sure how that would work when it comes to working with ingress.
| juju debug-log | ||
| ``` | ||
|
|
||
| #### Deploy Charm |
There was a problem hiding this comment.
thought: I wonder if we could put a Terraform plan into the repository to automate this section of local deployments.
There was a problem hiding this comment.
Including a Terraform plan is a great idea, but I don't think it should replace this section as it helps figure out if something went wrong at each step.
| This charm is used to deploy Airbyte server in a k8s cluster. For a local | ||
| deployment, follow the following steps: | ||
|
|
||
| #### Install Microk8s |
There was a problem hiding this comment.
Another idea for docs, I'm still hazy on what the recommended approach is for charm docs. Some charms like observability and identity team have their docs on charmhub. But the company read-the-docs is really nice as it lets you write docs in a dedicated repo with better syntax and formatting support, better CI/CD dedicated to docs, etc.
There was a problem hiding this comment.
The docs here will eventually follow a similar path to the Temporal charm docs and live on Charmhub.
There was a problem hiding this comment.
I wonder if the deploy section shouldn't be moved into a separate docs folder, it reads like a how-to / tutorial. Fine for now
There was a problem hiding this comment.
Same comment as above, these will eventually be refactored to the tune of the diataxis framework.
This PR updates the charm's documentation and deployment instructions.
Note: Until the charm is published on Charmhub, the instructions in the
README.mdmay not be fully functional.