remove iii prefix from all workers except iii-directory#1969
Open
anthonyiscoding wants to merge 2 commits into
Open
remove iii prefix from all workers except iii-directory#1969anthonyiscoding wants to merge 2 commits into
anthonyiscoding wants to merge 2 commits into
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📝 WalkthroughWalkthroughThis documentation-only change replaces legacy ChangesWorker naming documentation
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
skill-check — docs32 verified, 662 skipped. 7 warnings across the verified workers.
Caution 32 in-scope rendered artifact(s) are out of date — sources this PR touches changed without re-rendering.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
|
||
| ```bash | ||
| iii worker add iii-worker-manager | ||
| iii worker add worker-manager |
Contributor
There was a problem hiding this comment.
this one is still iii-worker-manager, this worker will be deleted after DX work, it is being replaced by rbac-proxy
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/next/tutorials/linkly/observability.mdx (1)
43-43: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueFormat the worker name consistently.
Consider wrapping
observabilityin backticks for formatting consistency, especially since it starts the sentence.♻️ Proposed formatting
- **observability emits OpenTelemetry.** Its traces, metrics, and logs are emitted as OTel, so + **`observability` emits OpenTelemetry.** Its traces, metrics, and logs are emitted as OTel, so🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/next/tutorials/linkly/observability.mdx` at line 43, Update the opening observability statement to wrap the worker name “observability” in backticks, preserving the existing sentence and wording.docs/next/understanding-iii/index.mdx (1)
142-144: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueFormat worker names consistently.
For consistency with other references in the documentation, consider wrapping
http,cron, andstateworker names in backticks.♻️ Proposed formatting
-trigger types alongside their configuration schemas. The http Worker provides the `http` trigger -type. The cron Worker provides the `cron` trigger type. The state Worker provides the +trigger types alongside their configuration schemas. The `http` Worker provides the `http` trigger +type. The `cron` Worker provides the `cron` trigger type. The `state` Worker provides the `state` trigger type. A Trigger of a given type can only be registered while a Worker advertising🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/next/understanding-iii/index.mdx` around lines 142 - 144, Format the worker names `http`, `cron`, and `state` as inline code in the trigger-type documentation sentence, while leaving the surrounding wording unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/next/creating-workers/http.mdx`:
- Around line 3-17: Update the historical references in docs/changelog/index.mdx
to replace legacy worker IDs, configuration filenames, and config.yaml entries
with the new bare worker slugs, while preserving iii-directory references
unchanged.
---
Nitpick comments:
In `@docs/next/tutorials/linkly/observability.mdx`:
- Line 43: Update the opening observability statement to wrap the worker name
“observability” in backticks, preserving the existing sentence and wording.
In `@docs/next/understanding-iii/index.mdx`:
- Around line 142-144: Format the worker names `http`, `cron`, and `state` as
inline code in the trigger-type documentation sentence, while leaving the
surrounding wording unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: f5de3f76-2d49-4da0-88d8-0616c4d17cf0
📒 Files selected for processing (32)
docs/next/cli-reference/index.mdxdocs/next/creating-workers/functions.mdxdocs/next/creating-workers/http.mdxdocs/next/creating-workers/observability.mdxdocs/next/creating-workers/queues.mdxdocs/next/creating-workers/sandboxes.mdxdocs/next/creating-workers/triggers.mdxdocs/next/creating-workers/worker-manager.mdxdocs/next/creating-workers/worker-manifest.mdxdocs/next/creating-workers/workers.mdxdocs/next/how-to/schedule-cron-task.mdxdocs/next/quickstart.mdxdocs/next/reference/engine-protocol.mdxdocs/next/reference/sdk-browser.mdxdocs/next/reference/sdk-node.mdxdocs/next/reference/sdk-rust.mdxdocs/next/tutorials/linkly/durable-execution.mdxdocs/next/tutorials/linkly/foundations.mdxdocs/next/tutorials/linkly/frontend.mdxdocs/next/tutorials/linkly/observability.mdxdocs/next/tutorials/linkly/overview.mdxdocs/next/tutorials/linkly/persistence.mdxdocs/next/tutorials/linkly/streaming.mdxdocs/next/understanding-iii/engine.mdxdocs/next/understanding-iii/index.mdxdocs/next/using-iii/configuration.mdxdocs/next/using-iii/console.mdxdocs/next/using-iii/engine.mdxdocs/next/using-iii/functions.mdxdocs/next/using-iii/triggers.mdxdocs/next/using-iii/workers-registry.mdxdocs/next/using-iii/workers.mdx
Comment on lines
+3
to
+17
| description: "Expose functions as HTTP endpoints with the http worker." | ||
| owner: "devrel" | ||
| type: "how-to" | ||
| --- | ||
|
|
||
| The `iii-http` worker exposes your functions as HTTP endpoints, turning a function into a REST route | ||
| The `http` worker exposes your functions as HTTP endpoints, turning a function into a REST route | ||
| without standing up a separate web server. | ||
|
|
||
| ```bash | ||
| iii worker add iii-http | ||
| iii worker add http | ||
| ``` | ||
|
|
||
| <Note> | ||
| This page is a quick tour. For path patterns, methods, headers, and response handling, see the | ||
| [iii-http worker docs](https://workers.iii.dev/workers/iii-http). The worker's server settings | ||
| [http worker docs](https://workers.iii.dev/workers/http). The worker's server settings |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Update the historical changelog references for this rename.
The worker rename also requires docs/changelog/index.mdx to replace legacy worker IDs, config filenames, and config.yaml entries with the new bare slugs (while preserving iii-directory). Otherwise the documentation set remains inconsistent.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/next/creating-workers/http.mdx` around lines 3 - 17, Update the
historical references in docs/changelog/index.mdx to replace legacy worker IDs,
configuration filenames, and config.yaml entries with the new bare worker slugs,
while preserving iii-directory references unchanged.
Source: Path instructions
Contributor
|
Hey @anthonyiscoding we only migrated the http, cron, queue, state e pubsub, the rest still as builtin. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Remove iii- prefix from iii workers in the docs (except iii-directory)
Why
We're dropping the prefix and docs need to match
Notes
Summary by CodeRabbit