Skip to content

Commit a41dc32

Browse files
committed
Update documentation, remove outdated docs
Signed-off-by: Sreekanth <prsreekanth920@gmail.com>
1 parent b1c2911 commit a41dc32

3 files changed

Lines changed: 3 additions & 234 deletions

File tree

development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document explains the development process for the Numaflow Python SDK.
44

55
### Testing
66

7-
1. Install [Poetry](https://python-poetry.org/docs/) before starting your test. Make sure you have the correct Python version
7+
1. Install [uv](https://docs.astral.sh/uv/getting-started/installation/) before starting your test. Make sure you have the correct Python version. Run `make setup` from `packages/pynumaflow/` to install all dependencies
88
2. Make your SDK changes
99
3. Update the `example.py` file inside the desired example directory if needed
1010
4. Run `make image TAG=<tag>` inside the same example directory to build your image with an appropriate tag

docs/DOCKER_OPTIMIZATION.md

Lines changed: 0 additions & 229 deletions
This file was deleted.

releases.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@ This document explains the release process for the Python SDK. You can find the
55
### Before Release
66

77
1. Before releasing a new SDK version, make sure to update all references from the old version to the new one. For example,
8-
the version in the root `pyproject.toml` should be updated (for [reference](https://github.com/numaproj/numaflow-python/commit/6a720e7c56121a45b94aa929c6b720312dd9340a))
9-
- The version in the root `pyproject.toml` can be updated by running `poetry version <version-bump-rule | PEP440-string>`. e.g., `poetry version 0.8.0`
10-
The version bump rules that can be provided and their corresponding effects can be found [here](https://python-poetry.org/docs/cli/#version),
11-
in the `Poetry` documentation. A version number can also be directly specified instead, but it must follow the [PEP 440](https://peps.python.org/pep-0440/) specification
8+
the version in `packages/pynumaflow/pyproject.toml` should be updated (for [reference](https://github.com/numaproj/numaflow-python/commit/6a720e7c56121a45b94aa929c6b720312dd9340a))
9+
- Edit the `version` field in `packages/pynumaflow/pyproject.toml` directly (e.g., change `version = "0.12.0"` to `version = "0.12.1"`). The version must follow the [PEP 440](https://peps.python.org/pep-0440/) specification
1210
2. If the version to be released has backwards incompatible changes, i.e. it does not support older versions of the Numaflow platform,
1311
you must update the `MINIMUM_NUMAFLOW_VERSION` constant in the `pynumaflow/info/types.py` file to the minimum Numaflow version that is supported by your new SDK version.
1412
3. After making these changes, create a PR and merge it.

0 commit comments

Comments
 (0)