Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: syntax issue in README #429

Merged
merged 1 commit into from
Apr 30, 2024
Merged

Conversation

billabongrob
Copy link
Contributor

πŸ“‘ Description

There was a misplaced details block causing the Bedrock section not to function as expected.

βœ… Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed

β„Ή Additional Information

There was a misplaced details block causing the Bedrock section not to function as expected.

Signed-off-by: Rob Heckel <billabongrob@gmail.com>
@billabongrob billabongrob requested review from a team as code owners April 30, 2024 02:58
@AlexsJones
Copy link
Member

Thanks @billabongrob I think the issue is the details are the wrong way around
Do you want to make the below changes?

</details>  <---- SHOULD be <details>
1. Install the operator from the [Installation](#installation) section.

2. Create secret:
```sh 
kubectl create secret generic bedrock-sample-secret --from-literal=AWS_ACCESS_KEY_ID="$(echo $AWS_ACCESS_KEY_ID)" --from-literal=AWS_SECRET_ACCESS_KEY="$(echo $AWS_SECRET_ACCESS_KEY)" -n k8sgpt-operator-system
  1. Apply the K8sGPT configuration object:
kubectl apply -f - << EOF
apiVersion: core.k8sgpt.ai/v1alpha1
kind: K8sGPT
metadata:
  name: k8sgpt-sample
  namespace: k8sgpt-operator-system
spec:
  ai:
    enabled: true
    secret:
      name: bedrock-sample-secret
    model: anthropic.claude-v2
    region: eu-central-1
    backend: amazonbedrock
  noCache: false
  repository: ghcr.io/k8sgpt-ai/k8sgpt
  version: v0.3.29
EOF
. <---- SHOULD be
```

@JuHyung-Son
Copy link
Contributor

This fix is correct.
Currently, bedrock

does not contain yaml, so it is not possible to use the triangle point.

CleanShot 2024-04-30 at 17 02 16@2x

@AlexsJones AlexsJones merged commit 1c41fe6 into k8sgpt-ai:main Apr 30, 2024
3 checks passed
@billabongrob billabongrob deleted the patch-1 branch April 30, 2024 12:29
MateSousa pushed a commit to MateSousa/k8sgpt-operator that referenced this pull request May 2, 2024
There was a misplaced details block causing the Bedrock section not to function as expected.

Signed-off-by: Rob Heckel <billabongrob@gmail.com>
Signed-off-by: Matheus Sousa <matessousa@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants