De-duplicate event-sourcing.md and immudb-integration.md #66
Labels
No labels
Blocked
Duplicate
MoSCoW/Could Have
MoSCoW/Must Have
MoSCoW/Should Have
Points/1
Points/13
Points/2
Points/21
Points/3
Points/5
Points/8
Priority/Backlog
Priority/Critical
Priority/High
Priority/Low
Priority/Medium
State/Completed
State/In progress
State/In review
State/Paused
State/Unverified
State/Verified
State/Wont Do
Type/Bug
Type/Epic
Type/Feature
Type/Legendary
Type/Task
Type/Testing
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Blocks
#30 Epic: Clean up event sourcing documentation
aethyr/Aethyr
Reference: aethyr/Aethyr#66
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Metadata
docs(site): de-duplicate event sourcing docsfeature/m3-docs-es-cleanupBackground and Context
event-sourcing.mdduplicates its own sections after line 378.immudb-integration.mdhas 3 copies of the "Why ImmuDB?" section. Additionally, there is overlapping content betweendocs/developer/event-sourcing-api.mdandevent_sourcing_documentation.mdthat should be cross-referenced rather than duplicated.Expected Behavior
Both
event-sourcing.mdandimmudb-integration.mdhave no internal self-duplication. Overlapping content between event sourcing documents is replaced with cross-references. All documents build correctly.Acceptance Criteria
event-sourcing.md: repeated sections after line ~378 removedimmudb-integration.md: 2 redundant "Why ImmuDB?" copies removedbundle exec rake documentationSubtasks
docs/developer/event-sourcing-api.mdwithevent_sourcing_documentation.md, remove overlapping content, add cross-referencesdocs/server/event-sourcing.mdto remove repeated sections after line ~378docs/server/immudb-integration.mdto remove 2 redundant "Why ImmuDB?" copiestests/unit/docs_es_dedup.featurecovering document deduplication validation.tests/integration/for event sourcing documentation build.bundle exec rake unit_profileand verify no performance regressions for documentation generation.bundle exec rake unit. If coverage is <85% then review the current unit test coverage report atbuild/tests/unit/coverage/and use it to write new Cucumber based unit tests to improve code coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerunbundle exec rake unitto verify all tests pass and coverage is above >=85%. Only mark this as complete once coverage is >=85%, if not repeat this task as many times as is needed until coverage reaches >=85%.bundle exec rake(default task: unit tests with coverage) andbundle exec rake integration, fix any errors if needed ensuring both pass across entire code base, do not ignore any failure even if it seems unrelated to this commit, fix it.Definition of Done
This issue is complete when:
master, reviewed, and merged before this issue is marked done.