Skip to content

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

Merged
merged 12 commits into from
Apr 20, 2025

Conversation

ericof
Copy link
Member

@ericof ericof commented Apr 18, 2025

I'm trying to make sure every reference to the repository url is consistent when we create a project.

  • README.md
  • backend/README.md
  • backend/pyproject.toml
  • frontend/README.md
  • frontend/packages/<>/package.json
  • frontend/packages/<>/towncrier.toml

I also fixed an issue with the backend towncrier template

Fixes #221

@ericof ericof requested a review from stevepiercy April 18, 2025 17:04
Copy link
Member

@davisagli davisagli left a 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.

@stevepiercy
Copy link
Contributor

Tested project generation, docs with make test, project with make install, started up servers, able to browse both Classic UI and Volto, all good. Tried make test, and only tests for backend were found and all passed. Are there zero tests for Volto?

@ericof
Copy link
Member Author

ericof commented Apr 19, 2025

Tested project generation, docs with make test, project with make install, started up servers, able to browse both Classic UI and Volto, all good. Tried make test, and only tests for backend were found and all passed. Are there zero tests for Volto?

Yes, for now a new Volto add-on comes with zero tests.

@ericof ericof changed the title Ensure references to the repository url are consistent across all templaets Ensure references to the repository url are consistent across all templates Apr 19, 2025
@ericof ericof mentioned this pull request Apr 19, 2025
2 tasks
@ericof ericof requested a review from stevepiercy April 19, 2025 17:24
Copy link
Contributor

@stevepiercy stevepiercy left a 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.

Comment on lines +82 to +83
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.
Copy link
Contributor

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?

Copy link
Member Author

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

Copy link
Contributor

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?

Develop Volto add-ons

@sneridagh @davisagli what do you think?

Copy link
Member Author

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 :-)

@ericof ericof requested a review from stevepiercy April 20, 2025 19:45
Comment on lines +82 to +83
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.
Copy link
Contributor

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?

Develop Volto add-ons

@sneridagh @davisagli what do you think?

@ericof ericof merged commit aa5fdea into main Apr 20, 2025
34 checks passed
@ericof ericof deleted the issue-221 branch April 20, 2025 21:16
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.

Fix path to repository on package.json, pyproject.toml and README files
3 participants