tailwarden / docs.komiser.io Goto Github PK

It leads to github.com/tailwarden/komiser/docs instead of tailwarden/docs.komiser.io/docs

I was going through the community.md file when I came across multiple grammatical errors such as spelling mistakes.

I followed the documentation to connect my AWS account as per the below:
https://docs.komiser.io/docs/cloud-providers/aws#local-komiser-cli

And I was confused that:

1. Do I need to add an AWS section in my config.toml
2. In what format should I?
3. The docs said in a different section on the same page in the form of:

[[aws]]
name="sandbox"
source="CREDENTIALS_FILE"
path=./path/to/credentials/file
profile="default

I tried the same and kept on getting the following error:

WARN[2023-04-15T12:09:19+05:30] [shubham-test][AWS] operation error Lambda: ListFunctions, failed to sign request: failed to retrieve credentials: failed to refresh cached credentials, no EC2 IMDS role found, operation error ec2imds: GetMetadata, request canceled, context deadline exceeded

Which on further debugging and hit and trials, I managed to get it working by setting the following in my config.toml:

[[aws]]
name="shubham-test"
source="CREDENTIALS_FILE"

Since it's in the default path ie the path suggested in the docs, we do not need to pass the path parameter (this is also mentioned in the docs in the configuring credentials section: https://docs.komiser.io/docs/cloud-providers/aws#configuring-credentials).

My suggestion is that most users won't read the documentation so thoroughly hence adding a step of config.toml won't harm in any way and will improve the UX

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

We would like to add Algolia DocSearch functionalities to our docs. We have already applied got the required licence (and API key)
Instructions here. Reach out to @jakepage91 to get the apiKey needed for this integreation.

This calls for a celebration 🍾

At the following page ⬇️
https://docs.komiser.io/docs/cloud-providers/aws#credentials-file, I believe the correct sentence should be "It Is not recommended to add your AWS Access and Secret Access key in the credentials file."