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

Revise documentation #37

Merged
merged 5 commits into from
Mar 7, 2024
Merged

Revise documentation #37

merged 5 commits into from
Mar 7, 2024

Conversation

trevorbonas
Copy link
Contributor

@trevorbonas trevorbonas commented Mar 7, 2024

Issue #, if available: N/A

Description of changes:

README and serverless/DEVELOPER_README have been edited and now stress one-click deployment as the best way to deploy the connector.

Additionally, various grammatical, spelling, whitespace, and markdown formatting issues have been fixed. British English has been favoured. An outdated image was also changed.

GETTING_STARTED has been removed and its verification section has been moved to README.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

trevorbonas and others added 5 commits January 4, 2024 12:33
"Prometheus Connector," and the version of the Prometheus connector, has been added to the User-Agent header, before the current value in the User-Agent header, which is the AWS SDK and its version.

Example from logs with DEBUG log-level:

```
User-Agent: Prometheus Connector/1.1.0 aws-sdk-go/1.35.7 (go1.21.1; darwin; arm64)
```

Also, details on what the `User-Agent` header value is for the Prometheus Connector has been added to the README.
README and serverless/DEVELOPER_README have been edited and now stress one-click deployment as the best way to deploy the connector.

Additionally, various grammatical, spelling, whitespace, and markdown formatting issues have been fixed. British English has been favoured. An outdated image was also changed.

GETTING_STARTED has been removed and its verification section has been moved to README.
@forestmvey forestmvey self-requested a review March 7, 2024 17:40
Copy link
Contributor

@forestmvey forestmvey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am approving and merging this with one failing CI as there are no functional changes in this PR, and the CI is only related to python code. I will address the failing CI in a follow up PR.

@forestmvey forestmvey merged commit 9be0f79 into awslabs:main Mar 7, 2024
6 of 7 checks passed
@forestmvey forestmvey deleted the integration branch March 7, 2024 19:15
forestmvey pushed a commit to forestmvey/amazon-timestream-connector-prometheus that referenced this pull request May 7, 2024
* Add User-Agent documentation to README

* Add User-Agent header value

* Revise documentation

README and serverless/DEVELOPER_README have been edited and now stress one-click deployment as the best way to deploy the connector.

Additionally, various grammatical, spelling, whitespace, and markdown formatting issues have been fixed. British English has been favoured. An outdated image was also changed.

GETTING_STARTED has been removed and its verification section has been moved to README.
forestmvey pushed a commit to forestmvey/amazon-timestream-connector-prometheus that referenced this pull request May 7, 2024
* Add User-Agent documentation to README

* Add User-Agent header value

* Revise documentation

README and serverless/DEVELOPER_README have been edited and now stress one-click deployment as the best way to deploy the connector.

Additionally, various grammatical, spelling, whitespace, and markdown formatting issues have been fixed. British English has been favoured. An outdated image was also changed.

GETTING_STARTED has been removed and its verification section has been moved to README.
forestmvey pushed a commit to forestmvey/amazon-timestream-connector-prometheus that referenced this pull request May 7, 2024
* Add User-Agent documentation to README

* Add User-Agent header value

* Revise documentation

README and serverless/DEVELOPER_README have been edited and now stress one-click deployment as the best way to deploy the connector.

Additionally, various grammatical, spelling, whitespace, and markdown formatting issues have been fixed. British English has been favoured. An outdated image was also changed.

GETTING_STARTED has been removed and its verification section has been moved to README.
forestmvey pushed a commit to forestmvey/amazon-timestream-connector-prometheus that referenced this pull request May 7, 2024
* Add User-Agent documentation to README

* Add User-Agent header value

* Revise documentation

README and serverless/DEVELOPER_README have been edited and now stress one-click deployment as the best way to deploy the connector.

Additionally, various grammatical, spelling, whitespace, and markdown formatting issues have been fixed. British English has been favoured. An outdated image was also changed.

GETTING_STARTED has been removed and its verification section has been moved to README.
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.

2 participants