-
-
Notifications
You must be signed in to change notification settings - Fork 739
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
Fixed typo and version mismatch in upgrade guide Volto 17 #5703
Conversation
✅ Deploy Preview for volto ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for plone-components canceled.
|
First @ksuess is correct to update this discrepancy. But I have to ask, is there a better way that reduces maintenance of the docs and gives developers an easier way to update their code? Why, yes, there is. I chatted with @ichim-david in Discord. I think it's too much work to maintain dependencies as diffs in documentation every time we update the deps in Volto. Additionally copy-pasting a diff into one's It is easier to go to the source file in the repo for that branch, copy-paste that into your Select "Copy lines" from the stoplight menu, and paste into my I'd suggest we remove the diffs, and instead point to the source code in the repo and add text, such as the following. Dependencies in Volto 17.x.x will continue to be updated after this change note is published. |
@stevepiercy the upgrade guide ones are correct, and since the docs are "frozen" in time, they are correct. They are not going to change overtime without another breaking. The others (the ones in the typescript.md) it's arguable they should point to the current latest stable generator, which is tested per version right now, so I guess it's ok. |
@sneridagh do you mean that @ksuess should revert the changes she made to
OK, so @ksuess should replace the diff in |
@stevepiercy yes, if possible. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You want me to revert these two changes in upgrade guide?
https://6.docs.plone.org/volto/upgrade-guide/index.html#upgraded-linters-eslint-prettier-and-stylelint
@@ -148,10 +148,10 @@ Edit your {file}`package.json`: | |||
|
|||
```diff | |||
"devDependencies": { | |||
+ "@plone/scripts": ^3.0.0, | |||
+ "@plone/scripts": "^3.0.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quotation marks are missing.
+ "@typescript-eslint/eslint-plugin": "6.7.0", | ||
+ "@typescript-eslint/parser": "6.7.0", | ||
+ "stylelint-prettier": "1.1.2", | ||
+ "stylelint-prettier": "4.0.2", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"stylelint-prettier" version has been raised in the former diff to 4.x
@stevepiercy I'm +1 to proceed from now on that way, pointing people to code instead of diffing in docs, let's do it for next contributions, ok? @ksuess PR is fine, as long as I can see and I'd merge it as it is. |
Fix #5702