Skip to content

fix: correct errors in docs#322

Open
Mesut Oezdil (mesutoezdil) wants to merge 7 commits into
agent-substrate:mainfrom
mesutoezdil:fix/doc-errors
Open

fix: correct errors in docs#322
Mesut Oezdil (mesutoezdil) wants to merge 7 commits into
agent-substrate:mainfrom
mesutoezdil:fix/doc-errors

Conversation

@mesutoezdil

@mesutoezdil Mesut Oezdil (mesutoezdil) commented Jun 26, 2026

Copy link
Copy Markdown
Contributor
  • docs/observability.md: log label keys were wrong. The code emits ate.dev/actor_id and ate.dev/actor_template_name; the doc had actor_id and actor_template. The Cloud Logging queries would return no results.
  • docs/dev/best-practices/tracing.md: container ports entry used Docker Compose syntax ("443:443"). Changed to containerPort: 443.
  • docs/dev/valkey-direct-access.md: the kubectl exec command had a line break inside --cert, making it fail on copy-paste.
  • code-of-conduct.md: linked to Contributor Covenant v1.4. Updated to v2.1.

Comment thread code-of-conduct.md Outdated
Mesut Oezdil (mesutoezdil) added a commit to mesutoezdil/substrate that referenced this pull request Jun 27, 2026
Reverts the Contributor Covenant version bump (1.4 -> 2.1) per
maintainer request in PR agent-substrate#322.
Mesut Oezdil (mesutoezdil) added a commit to mesutoezdil/substrate that referenced this pull request Jul 9, 2026
Reverts the Contributor Covenant version bump (1.4 -> 2.1) per
maintainer request in PR agent-substrate#322.
Mesut Oezdil (mesutoezdil) added a commit to mesutoezdil/substrate that referenced this pull request Jul 14, 2026
Reverts the Contributor Covenant version bump (1.4 -> 2.1) per
maintainer request in PR agent-substrate#322.
@mesutoezdil
Mesut Oezdil (mesutoezdil) force-pushed the fix/doc-errors branch 3 times, most recently from 5050678 to 3cafa77 Compare July 15, 2026 20:41
…alkey command

Actor-centric log query used ate.dev/actor_id, actual label is
ate.dev/actor_name.
@mesutoezdil

Copy link
Copy Markdown
Contributor Author

Haven Xia (@HavenXia) Another small docs fix, a quick look would be appreciated.

@HavenXia Haven Xia (HavenXia) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Could you also move #349, #359, and #323 into this PR and close them? We'd prefer to merge these small fixes as a single batch rather than as separate one-line PRs.

Comment thread docs/observability.md Outdated

To make underlying infrastructure transitions transparent, Agent Substrate establishes a standardized metadata model to identify actors across worker pods:
* `ate.dev/actor_name`: The name of the actor (e.g., `my-counter-1` or `test`).
* `ate.dev/actor_id`: The unique identifier of the actor (e.g., `my-counter-1` or `test`).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This line is correct at main, actor_name is the correct use now.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

thanks Haven Xia (@HavenXia) done!

Comment thread docs/observability.md Outdated

```bash
kubectl ate logs actors <actor-name> [--follow / -f]
kubectl ate logs actors <actor_id> [--follow / -f]

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

same as my another comment.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

done

Comment thread docs/observability.md Outdated
kubectl ate get actor -A --trace
# or
kubectl ate suspend actor <actor-name> -a <atespace> --trace
kubectl ate suspend actor <actor-id> -a <atespace> --trace

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

same as my another comment.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

done

Revert actor_id/actor_uid regression in observability.md per review.
Merge fixes from agent-substrate#349, agent-substrate#359, agent-substrate#323 into this PR.
@mesutoezdil

Copy link
Copy Markdown
Contributor Author

Could you also move #349, #359, and #323 into this PR and close them? We'd prefer to merge these small fixes as a single batch rather than as separate one-line PRs.

sure, done, thx!

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.

4 participants