Updates for publishing

[alhambrav]

Ticket reference or full description of what's in the PR

Update project tools publishing for 5.0

craftercms/craftercms#7769
craftercms/craftercms#6766

[coderabbitai]

Warning

Rate limit exceeded

@alhambrav has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 3 minutes and 18 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Walkthrough

Docs updated for version 5.0.0: terminology changed to "Project Tools", UI field names standardized (Package Title, Submission Comment, Publishing Target), publishing workflows and images revised, unlock-publishing flow removed, and the Publishing Queue/status taxonomy expanded with more granular states.

Changes

Cohort / File(s)	Summary
Documentation source/by-role/common/project-tools/publishing-and-status.rst	Version bumped to 5.0.0. Terminology changed from “

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

• sumerjabri

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Updates for publishing' is related to the changeset but is quite generic and vague, failing to convey specific details about the version bump, UI terminology changes, or expanded status definitions.	Consider a more specific title such as 'Update project tools publishing documentation for 5.0' to better reflect the scope and nature of the changes.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description follows the template structure with a ticket reference and issue links, providing adequate context about the update being for version 5.0.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into master

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

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 | 🟡 Minor

Typo: 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 | 🟡 Minor

Add 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?

[coderabbitai]

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 | 🟡 Minor

Fix 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 | 🟡 Minor

Grammar: “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.

[coderabbitai]

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