Readme update related to pypi #65
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kaapstorm
reviewed
Oct 8, 2024
apache-superset.md
Outdated
Comment on lines
318
to
322
| > Note: <ul><li>pypi package follows the versioning scheme as described [here](https://packaging.python.org/en/latest/discussions/versioning/). | ||
| We make any initial customizations on top of apache upstream version and | ||
| then make a release to pypi with the same version number. For e.g. customizations were made on the upstream version `3.1.0` and this was released to dimagi-superset pypi as `3.1.0`.<li>If any additional customizations are needed on top of initial versions, we are using the post release for numbering | ||
| i.e. `.post<>` as the suffix with N as an incrementing integer. | ||
| It is acknowledged that using the post release is not the best way, however it was chosen to keep the version in sync to the upstream apache-superset version.</ul> |
There was a problem hiding this comment.
You don't need to use <ul><li> tags in Markdown.
The following will be rendered the same way, and is more readable in plaintext.
Suggested change
| > Note: <ul><li>pypi package follows the versioning scheme as described [here](https://packaging.python.org/en/latest/discussions/versioning/). | |
| We make any initial customizations on top of apache upstream version and | |
| then make a release to pypi with the same version number. For e.g. customizations were made on the upstream version `3.1.0` and this was released to dimagi-superset pypi as `3.1.0`.<li>If any additional customizations are needed on top of initial versions, we are using the post release for numbering | |
| i.e. `.post<>` as the suffix with N as an incrementing integer. | |
| It is acknowledged that using the post release is not the best way, however it was chosen to keep the version in sync to the upstream apache-superset version.</ul> | |
| > Note: | |
| > | |
| > * PyPI package follows the versioning scheme as described | |
| > [here](https://packaging.python.org/en/latest/discussions/versioning/). | |
| > We make any initial customizations on top of Apache upstream version | |
| > and then make a release to PyPI with the same version number. e.g. | |
| > customizations were made on the upstream version `3.1.0` and this | |
| > was released to dimagi-superset PyPI as `3.1.0`. | |
| > | |
| > * If any additional customizations are needed on top of initial | |
| > versions, we are using the post release for numbering i.e. | |
| > `.post<>` as the suffix with N as an incrementing integer. It is | |
| > acknowledged that using the post release is not the best way, | |
| > however it was chosen to keep the version in sync with the upstream | |
| > apache-superset version. |
There was a problem hiding this comment.
Looks much better. Addressed in c600d5e
kaapstorm
approved these changes
Oct 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Minor readme updates regarding using version numbers for PyPi