Docs issue report from "features/collaboration/track-changes/track-changes-integration.html"

[Anamon]

Origin URL

https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/track-changes/track-changes-integration.html

Project version

39.0.2

Is the information outdated? How?

The integration documentation pages for the Comments and Track Changes plugins instruct to install the respective packages as dev dependencies:

npm install --save-dev @ckeditor/ckeditor5-comments npm install --save-dev @ckeditor/ckeditor5-track-changes

If following the integration guide further (changes to ckeditor.ts), the pre-commit linting then goes on to request that these dependencies should be added as production dependencies instead:

[STARTED] Preparing lint-staged...
[SUCCESS] Preparing lint-staged...
[STARTED] Running tasks for staged files...
[STARTED] package.json — 2 files
[STARTED] **/*.{js,ts} — 1 file
[STARTED] **/*.css — 0 file
[STARTED] **/(*.{js,ts,css}|package.json) — 2 files
[SKIPPED] **/*.css — no files
[STARTED] eslint --quiet
[STARTED] ckeditor5-dev-dependency-checker --quiet
[SUCCESS] eslint --quiet
[SUCCESS] **/*.{js,ts} — 1 file
[FAILED] ckeditor5-dev-dependency-checker --quiet [FAILED]
[FAILED] ckeditor5-dev-dependency-checker --quiet [FAILED]
[SUCCESS] Running tasks for staged files...
[STARTED] Applying modifications from tasks...
[SKIPPED] Skipped because of errors from tasks.
[STARTED] Reverting to original state because of errors...
[SUCCESS] Reverting to original state because of errors...
[STARTED] Cleaning up temporary files...
[SUCCESS] Cleaning up temporary files...
✖ ckeditor5-dev-dependency-checker --quiet:
� Found some issue with dependencies in @redacted/ckeditor5-build-redacted.

❌ Misplaced dependencies (`dependencies` or `devDependencies`):

The following packages are used in the source and should be moved to `dependencies`
- @ckeditor/ckeditor5-comments
- @ckeditor/ckeditor5-track-changes

error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
husky - pre-commit hook exited with code 1 (error)

I think these two documentation pages should be changed to instruct adding these packages as non-dev dependencies:

npm install --save @ckeditor/ckeditor5-comments npm install --save @ckeditor/ckeditor5-track-changes

Is there something missing in the guide? What is it?

No response

Is there anything else you would like to add?

No response

User agent

Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/117.0

[Witoso]

Thanks for the report!

[CKEditorBot]

There has been no activity on this issue for the past year. We've marked it as stale and will close it in 30 days. We understand it may still be relevant, so if you're interested in the solution, leave a comment or reaction under this issue.