-
-
Notifications
You must be signed in to change notification settings - Fork 8
Ensure references to the repository url are consistent across all templates #223
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
Conversation
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.
I have not tested it, but the direction makes sense.
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/frontend/README.md
Outdated
Show resolved
Hide resolved
templates/add-ons/backend/{{ cookiecutter.__folder_name }}/README.md
Outdated
Show resolved
Hide resolved
templates/add-ons/backend/{{ cookiecutter.__folder_name }}/README.md
Outdated
Show resolved
Hide resolved
templates/add-ons/documentation_starter/{{ cookiecutter.__folder_name }}/README.md
Outdated
Show resolved
Hide resolved
templates/add-ons/frontend/{{ cookiecutter.__folder_name }}/README.md
Outdated
Show resolved
Hide resolved
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/backend/README.md
Outdated
Show resolved
Hide resolved
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/frontend/README.md
Outdated
Show resolved
Hide resolved
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/frontend/README.md
Outdated
Show resolved
Hide resolved
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/frontend/README.md
Outdated
Show resolved
Hide resolved
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/frontend/README.md
Outdated
Show resolved
Hide resolved
Tested project generation, docs with |
Yes, for now a new Volto add-on comes with zero tests. |
Co-authored-by: Steve Piercy <[email protected]>
Co-authored-by: Steve Piercy <[email protected]>
Co-authored-by: Steve Piercy <[email protected]>
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.
I'm concerned that the instructions to install the add-on for both Volto 17 and 18 do not align with official documentation. See:
@sneridagh and I recently revised that document. Let's make sure he does a thorough review of this. I'm OK with keeping the customized instructions where the project name gets substituted, but let's make sure they are correct and aligned with official docs.
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/backend/README.md
Outdated
Show resolved
Hide resolved
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/frontend/README.md
Outdated
Show resolved
Hide resolved
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/frontend/README.md
Outdated
Show resolved
Hide resolved
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/frontend/README.md
Outdated
Show resolved
Hide resolved
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/frontend/README.md
Outdated
Show resolved
Hide resolved
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/frontend/README.md
Outdated
Show resolved
Hide resolved
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/frontend/README.md
Outdated
Show resolved
Hide resolved
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/frontend/README.md
Outdated
Show resolved
Hide resolved
The development of this add-on is done in isolation using pnpm workspaces, the latest `mrs-developer`, and other Volto core improvements. | ||
For these reasons, it only works with pnpm and Volto 18. |
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.
This doesn't make sense. We have instructions for both Volto 17 and 18, but then say development of the add-on can be done only in Volto 18. I'm not sure what to do here.
Do we actually support Volto 17 with this Cookieplone template?
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.
Add-ons developed with Cookieplone could work with Volto 17
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.
Then we should remove this section, right? We can't say both it works only for 18, then it also could work for 17. Maybe we just refer to the official docs?
@sneridagh @davisagli what do you think?
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.
Let's open a other issue to review all the README files?
The original goal of this PR was to make sure all references to the repository url were consistent within a project, but now we are trying to address all the other issues we have in docs :-)
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/frontend/README.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Steve Piercy <[email protected]>
templates/sub/project_settings/{{ cookiecutter.__folder_name }}/backend/README.md
Show resolved
Hide resolved
The development of this add-on is done in isolation using pnpm workspaces, the latest `mrs-developer`, and other Volto core improvements. | ||
For these reasons, it only works with pnpm and Volto 18. |
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.
Then we should remove this section, right? We can't say both it works only for 18, then it also could work for 17. Maybe we just refer to the official docs?
@sneridagh @davisagli what do you think?
…}/backend/README.md Co-authored-by: Steve Piercy <[email protected]>
Co-authored-by: Steve Piercy <[email protected]>
I'm trying to make sure every reference to the repository url is consistent when we create a project.
I also fixed an issue with the backend towncrier template
Fixes #221