Draft
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughDocumentation updated to v5.0.0: "Project Tools" terminology applied; publishing UI labels standardized to Package Title, Submission Comment, Publishing Target; unlock-publish flow removed; publish workflows, images, and Publishing Queue/status taxonomy expanded; small workflow/staging wording adjustments. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
source/by-role/common/project-tools/publishing-and-status.rst (2)
91-91:⚠️ Potential issue | 🟡 MinorTypo: file extension should be
.xml.The path shows
index.xm, which will confuse users.🛠️ Suggested fix
-- Edit the Home page (/site/website/index.xm) from the command line or anywhere other than Studio +- Edit the Home page (/site/website/index.xml) from the command line or anywhere other than Studio
151-151:⚠️ Potential issue | 🟡 MinorAdd missing space in “items(publishing packages)”.
This reads like a typo in the rendered docs.
🛠️ Suggested fix
-The **Publishing Queue** tab allows the user to see the items(publishing packages) that are in the queue for publishing. +The **Publishing Queue** tab allows the user to see the items (publishing packages) that are in the queue for publishing.
🤖 Fix all issues with AI agents
In `@source/by-role/common/project-tools/publishing-and-status.rst`:
- Around line 159-163: Fix the subject/verb agreement in the heading sentence
that currently reads "Publishing packages contains the following
information:"—change it to "Publishing packages contain the following
information:"; edit the literal phrase in the text block containing "Package
Title", "Publishing Target", and "Submitter" so the plural subject "Publishing
packages" matches the plural verb "contain".
🧹 Nitpick comments (2)
source/by-role/common/project-tools/publishing-and-status.rst (2)
77-77: Fix “commit ids” capitalization.Use “commit IDs” for standard capitalization in docs.
✏️ Suggested edit
-The **Publish changes made via direct git actions against the repository or pulled from a remote repository** allows the user to publish by tags or commits ids +The **Publish changes made via direct git actions against the repository or pulled from a remote repository** allows the user to publish by tags or commit IDs
178-178: Remove or convert the “UPDATE NEEDED” note into a tracked task.Inline TODOs in published docs are easy to miss and may ship to users.
Do you want me to draft a short tracked issue/placeholder note that won’t ship, or convert this into a proper “pending update” admonition block?
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
source/by-role/common/project-tools/publishing-and-status.rst (2)
151-152:⚠️ Potential issue | 🟡 MinorFix missing space in “items(publishing packages)”.
Insert a space after “items” for readability.
📝 Proposed fix
-The **Publishing Queue** tab allows the user to see the items(publishing packages) that are in the queue for publishing. +The **Publishing Queue** tab allows the user to see the items (publishing packages) that are in the queue for publishing.
77-78:⚠️ Potential issue | 🟡 MinorGrammar: “commits ids” → “commit IDs”.
Standardize the plural form.
📝 Proposed fix
-The **Publish changes made via direct git actions against the repository or pulled from a remote repository** allows the user to publish by tags or commits ids +The **Publish changes made via direct git actions against the repository or pulled from a remote repository** allows the user to publish by tags or commit IDs
🤖 Fix all issues with AI agents
In `@source/by-role/common/project-tools/publishing-and-status.rst`:
- Around line 164-165: Update the text token "Submission comment" to match the
project's capitalization and punctuation by changing it to "Submission Comment:"
so it aligns with other labels; locate the occurrence of the exact string
"Submission comment" (near the adjacent "Status" line) and replace it with
"Submission Comment:" ensuring the capital C and trailing colon are added.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@source/by-role/common/project-tools/publishing-and-status.rst`:
- Line 162: The description for the glossary entry "Publishing Target" is
awkward and uses a slash with a missing article; update the entry for
``Publishing Target`` (the bullet line "* ``Publishing Target``: where package
is published to/to be published") to a clear, grammatically correct phrase such
as "the location where the package is published" or "the target repository or
registry where the package is published" so the intent is unambiguous.
- Line 136: Replace the awkward sentence "Remember to click on the checkbox that
you understand that the entire site will be published" with a clearer, concise
instruction such as: "Please check the box to confirm you understand that
publishing will make the entire site public." Locate the sentence in the
publishing-and-status.rst content where the phrase "click on the checkbox that
you understand that the entire site will be published" appears and substitute
the suggested wording (or a similar concise variant) to improve clarity and
tone.
🧹 Nitpick comments (1)
source/by-role/common/project-tools/publishing-and-status.rst (1)
163-163: Fix inconsistent spacing after colon.There are two spaces after the colon in the Submitter field description, while other fields use one space.
🔧 Proposed fix
-* ``Submitter``: user that sent/requested publishing package +* ``Submitter``: user that sent/requested publishing package
…te-project-tools-publishing
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@source/by-role/common/project-tools/publishing-and-status.rst`:
- Line 198: The bullet "* **Staging Failed**: The package failed to be published
to stage target" uses "stage" instead of the document-preferred "staging";
update that phrase to "staging target" so the line reads "* **Staging Failed**:
The package failed to be published to staging target" and scan nearby bullets
for any other occurrences to ensure consistent use of "staging" throughout the
section.
- Line 171: Update the line that currently reads "* ``Submitted On`` /
``Scheduled For``: schedule for publishing the package" to separate and
correctly describe the two fields: make one entry for "Submitted On" that states
it is the submission timestamp and a separate entry for "Scheduled For" that
states it is the scheduled publish time; reference the exact field names
"Submitted On" and "Scheduled For" when editing the sentence so the meanings are
unambiguous.
- Line 120: The sentence repeats "commit id" — simplify the instruction to
reference the previous step once; replace "Paste the commit id from the step
where we got the commit id, fill in the ``Package Title`` and ``Submission
Comment``, then select the ``Publishing Target``, finally, click on the
``Publish`` button" with a shorter line such as "Paste the commit id from the
previous step, fill in the ``Package Title`` and ``Submission Comment``, select
the ``Publishing Target``, then click the ``Publish`` button" to remove the
duplication while preserving meaning.
In `@source/by-role/common/project-tools/setting-workflow-states.rst`:
- Line 21: Split the long instruction sentence that starts "A dialog will launch
prompting you to set the state for your selection, by clicking on the slider
next to the state you want to set, then click on the ``Confirm`` button" into
two clearer actions: one sentence that tells the user to choose the desired
state by clicking the slider next to it, and a second sentence that tells the
user to click the ``Confirm`` button to apply the change.
In `@source/by-role/common/staging.rst`:
- Line 11: Revise the awkward sentence in source/by-role/common/staging.rst so
it reads more concisely; replace "select to which publishing target to publish
to" with a tighter phrase such as "select the publishing target" (or "select
which publishing target to publish to") to remove the redundancy and improve
readability.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 369192f5-80f2-41c6-86a9-1d9db963bd5b
📒 Files selected for processing (13)
source/_static/images/page/page-workflows-request-publish-later.webpsource/_static/images/page/page-workflows-request-publish.webpsource/_static/images/page/page-workflows-submitted-view-packages-option.webpsource/_static/images/page/page-workflows-view-packages-dialog.webpsource/_static/images/page/page-workflows.webpsource/_static/images/site-admin/project-config-select-state-dialog.webpsource/_static/images/site-admin/project-tools-publishing-package.webpsource/_static/images/site-admin/project-tools-workflow-states.webpsource/_static/images/system-admin/staging-publish-option.webpsource/by-role/author/index.rstsource/by-role/common/project-tools/publishing-and-status.rstsource/by-role/common/project-tools/setting-workflow-states.rstsource/by-role/common/staging.rst
✅ Files skipped from review due to trivial changes (1)
- source/by-role/author/index.rst
source/by-role/common/project-tools/setting-workflow-states.rst
Outdated
Show resolved
Hide resolved
Member
Author
|
commit 20bd691: add/edit screens and text for publishing package craftercms/craftercms#7580 |
There was a problem hiding this comment.
🧹 Nitpick comments (3)
source/by-role/common/project-tools/setting-workflow-states.rst (1)
21-21: Simplify the instruction flow.The sentence is improved but still somewhat awkward. The phrase "by clicking on the slider next to the state you want to change" creates a long dependent clause, and there's inconsistency between "choose the state" and "the state you want to change."
✏️ Suggested improvement
-A dialog will launch prompting you to choose the state for your selection, by clicking on the slider next to the state you want to change. Click on the ``Confirm`` button to set the state. +A dialog will launch prompting you to set the state for your selection. Click the slider next to the desired state, then click the ``Confirm`` button.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/by-role/common/project-tools/setting-workflow-states.rst` at line 21, Replace the awkward single sentence "A dialog will launch prompting you to choose the state for your selection, by clicking on the slider next to the state you want to change. Click on the ``Confirm`` button to set the state." with a simpler, consistent two‑step instruction: state that a dialog will open, instruct the user to select the desired state by clicking the slider next to that state, and then tell them to click the "Confirm" button to apply the change (use "select" consistently instead of mixing "choose" and "change").source/by-role/common/staging.rst (1)
11-11: Tighten the sentence and fix "setup" → "set up".The sentence still has minor issues:
- "setup" should be "set up" (compound verb form)
- "to publish to" has a redundant trailing preposition
- The phrasing remains somewhat verbose
✏️ Suggested improvements
-When staging is setup, the **Publish** dialog gives the user the option to select which publishing target to publish to: +When staging is set up, the **Publish** dialog lets the user select the publishing target:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/by-role/common/staging.rst` at line 11, The sentence "When staging is setup, the **Publish** dialog gives the user the option to select which publishing target to publish to:" should be tightened and corrected: change "setup" to "set up", remove the redundant trailing preposition and shorten the phrasing — for example replace that sentence with "When staging is set up, the **Publish** dialog lets the user select a publishing target." Locate the sentence by searching for the original fragment "When staging is setup, the **Publish** dialog gives the user the option to select which publishing target to publish to:" and update it accordingly.source/by-role/common/project-tools/publishing-and-status.rst (1)
120-120: Consider tightening the instruction sequence.The sentence is improved but "finally" with a comma before the last action makes it slightly awkward. The past review suggested smoother flow.
✏️ Minor refinement
-Paste the commit id from the earlier step, fill in the ``Package Title`` and ``Submission Comment``, then select the ``Publishing Target``, finally, click on the ``Publish`` button +Paste the commit id from the earlier step, fill in the ``Package Title`` and ``Submission Comment``, select the ``Publishing Target``, then click the ``Publish`` button🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/by-role/common/project-tools/publishing-and-status.rst` at line 120, The sentence "Paste the commit id from the earlier step, fill in the ``Package Title`` and ``Submission Comment``, then select the ``Publishing Target``, finally, click on the ``Publish`` button" reads awkwardly; replace the tail with a smoother sequence such as: "Paste the commit id from the earlier step, fill in the ``Package Title`` and ``Submission Comment``, select the ``Publishing Target``, and click the ``Publish`` button" (remove the commaed "finally" clause and join the final action with "and" for better flow).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@source/by-role/common/project-tools/publishing-and-status.rst`:
- Line 120: The sentence "Paste the commit id from the earlier step, fill in the
``Package Title`` and ``Submission Comment``, then select the ``Publishing
Target``, finally, click on the ``Publish`` button" reads awkwardly; replace the
tail with a smoother sequence such as: "Paste the commit id from the earlier
step, fill in the ``Package Title`` and ``Submission Comment``, select the
``Publishing Target``, and click the ``Publish`` button" (remove the commaed
"finally" clause and join the final action with "and" for better flow).
In `@source/by-role/common/project-tools/setting-workflow-states.rst`:
- Line 21: Replace the awkward single sentence "A dialog will launch prompting
you to choose the state for your selection, by clicking on the slider next to
the state you want to change. Click on the ``Confirm`` button to set the state."
with a simpler, consistent two‑step instruction: state that a dialog will open,
instruct the user to select the desired state by clicking the slider next to
that state, and then tell them to click the "Confirm" button to apply the change
(use "select" consistently instead of mixing "choose" and "change").
In `@source/by-role/common/staging.rst`:
- Line 11: The sentence "When staging is setup, the **Publish** dialog gives the
user the option to select which publishing target to publish to:" should be
tightened and corrected: change "setup" to "set up", remove the redundant
trailing preposition and shorten the phrasing — for example replace that
sentence with "When staging is set up, the **Publish** dialog lets the user
select a publishing target." Locate the sentence by searching for the original
fragment "When staging is setup, the **Publish** dialog gives the user the
option to select which publishing target to publish to:" and update it
accordingly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 834bde82-46c9-48fd-b9b6-a7ce48e6354d
📒 Files selected for processing (3)
source/by-role/common/project-tools/publishing-and-status.rstsource/by-role/common/project-tools/setting-workflow-states.rstsource/by-role/common/staging.rst
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
2 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.
Ticket reference or full description of what's in the PR
Update project tools publishing for 5.0
craftercms/craftercms#7769
craftercms/craftercms#6766