Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Docs per SFDO-Community/declarative-lookup-rollup-summaries #1300 #71

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jlantz
Copy link

@jlantz jlantz commented Nov 2, 2024

NOTE: This PR was AI generated using GitHub Copilot Workspace. I reviewed it but don't know enough about DLRS to technically vet the content. Please review carefully!

This pull request includes documentation updates to provide additional information on how merged records are handled by the DLRS system. The changes primarily focus on explaining the creation of scheduled items for recalculating rollups when records are merged.

Documentation updates:

  • docs/Architecture/calculates.md: Added a section explaining that merged records may create scheduled items to handle recalculation at a later time due to complexity and potential conflicts during the merge process.
  • docs/Installation/configuration.md: Included information about merged records creating scheduled items to ensure accurate rollup updates without performance issues during merges.
  • docs/User Guide/scheduling_rollups_v2_21.md: Added a section detailing how merged records are managed by creating scheduled items to handle recalculations later, ensuring accuracy and avoiding performance issues.

Minor cleanup:

docs/Architecture/calculates.md

Add a new section explaining that merged records may create scheduled items and why this occurs.
docs/User Guide/scheduling_rollups_v2_21.md

Add a note about the use of scheduled items for merged records.
docs/Installation/configuration.md

Add a mention of the use of scheduled items for merged records and provide guidance on handling this scenario.
For more details, open the Copilot Workspace session.

…merged records

NOTE: This PR was AI generated using GitHub Copilot Workspace. I reviewed it but don't know enough about DLRS to technically vet the content. **Please review carefully**!

Add documentation notes about the use of scheduled items for merged records.

* **docs/Architecture/calculates.md**
  - Add a new section explaining that merged records may create scheduled items and why this occurs.

* **docs/User Guide/scheduling_rollups_v2_21.md**
  - Add a note about the use of scheduled items for merged records.

* **docs/Installation/configuration.md**
  - Add a mention of the use of scheduled items for merged records and provide guidance on handling this scenario.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/jlantz/DLRS-Documentation?shareId=XXXX-XXXX-XXXX-XXXX).
Update DLRS documentation to include notes about scheduled items for merged records
@jlantz jlantz requested a review from aheber November 2, 2024 13:02
Copy link

@aheber aheber left a comment

Choose a reason for hiding this comment

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

I think these are good additions and I was surprised at the multiple appropriate locations that it added the notes.

@aheber
Copy link

aheber commented Nov 2, 2024

@sharicarlson13 can you get someone from the docs team to review and merge this?

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.

2 participants