add private locations changelog #120
Conversation
…logs and references of changes)
thebiglabasky
left a comment
thebiglabasky
left a comment
There was a problem hiding this comment.
Made some minor suggestions. I wonder about the consistency between past tense or present tense (Added feature X / Add feature X) since we use both interchangeably. I'd stick to one or the other.
Co-authored-by: Hervé Labas <431257+thebiglabasky@users.noreply.github.com>
Co-authored-by: Hervé Labas <431257+thebiglabasky@users.noreply.github.com>
|
@thebiglabasky ready for re-review! |
thebiglabasky
left a comment
thebiglabasky
left a comment
There was a problem hiding this comment.
There are still some past and some present tense, but I think it's not important enough to warrant changes. That reads fine! LGTM
There was a problem hiding this comment.
This will be super helpful for support/solutions and customers to have 🙂 I left several comments! Let me know if you want help with these changes, and I can try to find some time this week to make edits.
I agree with Hervé about the past/present tense inconsistency, but that's probably fine for now.
|
|
||
| ## Available Changelogs | ||
|
|
||
| <CardGroup cols={2}> |
There was a problem hiding this comment.
Did we want to add the other changelogs? 👀 Doesn't need to be with this PR, I can create a separate ticket
- Checkly CLI - https://github.com/checkly/checkly-cli/releases
- Terraform provider - https://github.com/checkly/terraform-provider-checkly/releases
- Pulumi provider - https://github.com/checkly/pulumi-checkly/releases
|
|
||
| - View logs with `docker logs <container-id>` | ||
| - Enable debug mode for detailed diagnostics | ||
| - Join the global [developer community](https://www.checklyhq.com/slack/) discussions |
There was a problem hiding this comment.
I think we should be clearer about what this links to. I would this to say "Join the Checkly Slack community" or similar
| - View logs with `docker logs <container-id>` | ||
| - Enable debug mode for detailed diagnostics | ||
| - Join the global [developer community](https://www.checklyhq.com/slack/) discussions | ||
| - [Contact the support team](https://app.checklyhq.com/?support=true) for help |
There was a problem hiding this comment.
Could we change this to the support@checklyhq.com email?
Users who aren't logged in will get sent to a login page, and I don't want anyone to think they need to log in for support
| ## Getting help | ||
|
|
||
| - View logs with `docker logs <container-id>` | ||
| - Enable debug mode for detailed diagnostics |
There was a problem hiding this comment.
What's "debug mode" referring to?
| description: Release history for the Checkly Private Locations Agent | ||
| --- | ||
|
|
||
| Release history for the Checkly Private Locations Agent. For setup instructions, see the [Private Locations documentation](/platform/private-locations/overview). |
There was a problem hiding this comment.
Nit: this is repeated, so it reads a bit weirdly. I would remove the second occurrence of "Release history for the Checkly Private Locations Agent"
|
|
||
| **Features** | ||
|
|
||
| - Add support for secret detection on runtime for browser and MS checks (behind the Feature Flag `RUNTIME_SECRET_DETECTION`) |
There was a problem hiding this comment.
| - Add support for secret detection on runtime for browser and MS checks (behind the Feature Flag `RUNTIME_SECRET_DETECTION`) | |
| - Add support for secret detection on runtime for Browser and Multistep checks for certain accounts |
We should probably outright mention feature flags -- it won't make sense for most users
| **Bug fixes** | ||
|
|
||
| - Use lower case environment variables for cURL | ||
| - Pass both headers | ||
| - Allow proxy to forward requests to minio | ||
| - Use xit | ||
|
|
||
| **Features** | ||
|
|
||
| - Create new hash |
There was a problem hiding this comment.
What does this mean? This might be too much in the implementation detail weeds for users to understand.
| ## Version history | ||
|
|
||
| - **Summary**: [Product changelog](https://feedback.checklyhq.com/changelog?c=Checkly+Agent) | ||
| - **Latest versions published**: [Docker Hub tags](https://hub.docker.com/r/checkly/agent/tags) |
There was a problem hiding this comment.
This section is pretty small, and we already link the Product Changelog at the beginning of the page.
Would it be better to remove this section and also link the Docker Hub tags at the beginning of the page?
| ## Compatibility matrix | ||
|
|
||
| | Agent version | Docker minimum | Supported runtimes | Node.js | | ||
| |--------------|----------------|-------------------|---------| | ||
| | 6.x | 20.10 | [2025.04](/platform/runtimes/runtime-specification#202504), [2024.09](/platform/runtimes/runtime-specification#202409) | v22.11.0 | | ||
| | 5.x | 19.03 | [2025.04](/platform/runtimes/runtime-specification#202504) | v22.11.0 | | ||
| | 4.x | 19.03 | [2024.09](/platform/runtimes/runtime-specification#202409) | v18 | | ||
| | 3.x | 19.03 | [2023.09](/platform/runtimes/runtime-specification#202309) | v18 | |
There was a problem hiding this comment.
I think we should remove the "Supported runtimes" column and link to /platform/private-locations/agent-configuration#agent-version-and-runtimes instead (the other page is more precise)
| ## Update checklist | ||
|
|
||
| When [updating to the latest agent](/platform/private-locations/agent-configuration), ensure: | ||
|
|
||
| 1. Confirm Docker version compatibility | ||
| 2. Review breaking changes like Node.js supported version. | ||
| 3. Test in staging environment | ||
| 4. Update configuration files | ||
| 5. Deploy changes |
There was a problem hiding this comment.
I think we should remove this section. This seems too generic and vague to be helpful.
Instead, we can link to /platform/private-locations/agent-configuration/#updating-the-agent-container somewhere else on this page.
Also includes a changelog space for all change logs.