Skip to content
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

Stop using the README as long description in the various setup.py #507

Open
4 tasks
jrobinAV opened this issue Nov 29, 2023 · 2 comments · May be fixed by #1284
Open
4 tasks

Stop using the README as long description in the various setup.py #507

jrobinAV opened this issue Nov 29, 2023 · 2 comments · May be fixed by #1284
Assignees
Labels
🖧 Devops Operations, monitoring, maintenance, deployment, packaging 📄 Documentation Internal or public documentation 📈 Improvement Improvement of a feature. 🟧 Priority: High Must be addressed as soon
Milestone

Comments

@jrobinAV
Copy link
Member

In all the setup.py files (config, gui, core, rest, taipy, templates), the long_description is populated with the README.md content.
This is NOT a good practice since the long description represents a description of the package built. It is used in Pypi to describe the package. The readme is also exposed as the landing page of the repo and used as instructions on how to use the code base. These have different purposes and different lifecycles. The content should be different.

The general idea is to split the use cases:

  • Propose for each setup.py a new long description content stored directly in the setup.py. The version could be dynamically injected if needed.
  • Include the update of the long descriptions in the release process
  • Use the readme.md for each package (config, GUI, core, rest, templates,) as an introduction page for contributors it should be related to a specific taipy version.
  • Use the global taipy readme.md as a landing page on the github repo independent from the taipy versions.
@jrobinAV jrobinAV added Core Related to Taipy Core 📈 Improvement Improvement of a feature. 🖧 Devops Operations, monitoring, maintenance, deployment, packaging 🖰 GUI Related to GUI 🟨 Priority: Medium Not blocking but should be addressed labels Nov 29, 2023
dinhlongviolin1 pushed a commit that referenced this issue Dec 4, 2023
dinhlongviolin1 pushed a commit that referenced this issue Dec 4, 2023
@jrobinAV jrobinAV added 🆘 Help wanted Open to participation from the community 🟧 Priority: High Must be addressed as soon and removed 🟨 Priority: Medium Not blocking but should be addressed labels May 3, 2024
@trgiangdo trgiangdo added this to the Community 3.2 milestone May 8, 2024
@trgiangdo trgiangdo self-assigned this May 10, 2024
@trgiangdo trgiangdo added 📄 Documentation Internal or public documentation and removed Core Related to Taipy Core 🖰 GUI Related to GUI 🆘 Help wanted Open to participation from the community labels May 10, 2024
Copy link
Contributor

This issue has been labelled as "🥶Waiting for contributor" because it has been inactive for more than 14 days. If you would like to continue working on this issue, please add another comment or create a PR that links to this issue. If a PR has already been created which refers to this issue, then you should explicitly mention this issue in the relevant PR. Otherwise, you will be unassigned in 14 days. For more information please refer to the contributing guidelines.

@github-actions github-actions bot added the 🥶Waiting for contributor Issues or PRs waiting for a long time label May 25, 2024
@trgiangdo
Copy link
Member

This issue is under review

@github-actions github-actions bot removed the 🥶Waiting for contributor Issues or PRs waiting for a long time label May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🖧 Devops Operations, monitoring, maintenance, deployment, packaging 📄 Documentation Internal or public documentation 📈 Improvement Improvement of a feature. 🟧 Priority: High Must be addressed as soon
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants