Skip to content

Add note about automatic phase changes and manual management#259

Merged
andreslucena merged 2 commits into
developfrom
docs/process-automated-phase-change
May 14, 2026
Merged

Add note about automatic phase changes and manual management#259
andreslucena merged 2 commits into
developfrom
docs/process-automated-phase-change

Conversation

@andreslucena
Copy link
Copy Markdown
Member

@andreslucena andreslucena commented May 12, 2026

@larsUE commented in the Matrix chat room that the automatic phase change feature isn't documented.

This PR tries to solve this issue.

See decidim/decidim#9026
And https://matrix.to/#/!fNaHElxpfwZENasNbv:matrix.org/$mOSPwqzAht0cxg9yNVWXpmisEs11ddsHIczbKhyAbXQ?via=matrix.org&via=osp.cat&via=privchat.eu

Summary by CodeRabbit

  • Documentation
    • Enhanced phases documentation with detailed information on automatic phase changes triggered by scheduled task configuration and implications for manual management processes.
    • Updated example section placeholders to improve documentation completeness.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 12, 2026

Warning

Rate limit exceeded

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

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ 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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3e58d6e6-d2a9-4d21-8ae7-7105604dfade

📥 Commits

Reviewing files that changed from the base of the PR and between 6bfaea0 and 3876878.

📒 Files selected for processing (1)
  • docs/en/modules/admin/pages/spaces/processes/phases.adoc
📝 Walkthrough

Walkthrough

Documentation for participatory process phases was updated to clarify that phase transitions occur automatically when the decidim_participatory_processes:change_active_step scheduled task is configured, and to explain that manual management requires disabling this task server-side. A placeholder in the Examples section was also updated.

Changes

Phases documentation clarification

Layer / File(s) Summary
Phase scheduling clarification and examples update
docs/en/modules/admin/pages/spaces/processes/phases.adoc
A NOTE block explains automatic phase changes via scheduled task configuration and server-side task disabling for manual management. The Examples section placeholder is updated to "TBD".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A phase shift occurs, both planned and on time,
The scheduler dances, a rhythm sublime,
One note clarifies the automated way,
While examples wait for their proper day. 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title clearly and specifically summarizes the main change: adding documentation about automatic phase changes and their relationship to manual management.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/process-automated-phase-change

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

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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/en/modules/admin/pages/spaces/processes/phases.adoc`:
- Line 32: Update the NOTE sentence "If you want to manage them manually, then
the implementer/operator of the installation need to disable this scheduled task
server-side." to fix subject–verb agreement: change "need" to "needs" (or
alternatively make the subject plural, e.g., "implementers/operators ... need")
so the sentence reads correctly (e.g., "... the implementer/operator of the
installation needs to disable ...").
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: c65a4e92-1c49-4538-90bd-39ca60dd1030

📥 Commits

Reviewing files that changed from the base of the PR and between 963512d and 6bfaea0.

📒 Files selected for processing (1)
  • docs/en/modules/admin/pages/spaces/processes/phases.adoc

Comment thread docs/en/modules/admin/pages/spaces/processes/phases.adoc Outdated
Comment thread docs/en/modules/admin/pages/spaces/processes/phases.adoc Outdated
Co-authored-by: Andrés Pereira de Lucena <andreslucena@users.noreply.github.com>
@andreslucena andreslucena merged commit 5203245 into develop May 14, 2026
2 of 6 checks passed
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.

1 participant