Refactor installation instructions and bump version to 0.2.0.dev#21
Refactor installation instructions and bump version to 0.2.0.dev#21
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the installation documentation and updates the project version to prepare for development releases. The changes improve user onboarding by providing three clear installation methods with detailed examples.
- Expanded installation section with three distinct methods: pre-built Docker image, local Docker build, and pip installation
- Added dedicated environment variables section consolidating configuration requirements
- Bumped project version from 0.1.0 to 0.2.0.dev
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Restructured installation documentation with clearer methods and added environment variables section |
| pyproject.toml | Updated project version to 0.2.0.dev for development release |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| ghcr.io/codelibs/fessctl:0.1.0 ping | ||
|
|
||
| ```bash | ||
| export FESS_ACCESS_TOKEN=... | ||
| export FESS_VERSION=15.1.0 | ||
| fessctl ping | ||
| fessctl user list | ||
| fessctl webconfig create --name TestConfig --url https://test.config.com/ | ||
| docker run --rm \ | ||
| -e FESS_ENDPOINT=https://your-fess-server \ | ||
| -e FESS_ACCESS_TOKEN=your_access_token_here \ | ||
| -e FESS_VERSION=15.1.0 \ | ||
| ghcr.io/codelibs/fessctl:0.1.0 user list |
There was a problem hiding this comment.
The Docker image version is hardcoded to 0.1.0, but the project version has been bumped to 0.2.0.dev. Consider using a variable or updating to match the current version to avoid confusion.
| ghcr.io/codelibs/fessctl:0.1.0 ping | ||
|
|
||
| ```bash | ||
| export FESS_ACCESS_TOKEN=... | ||
| export FESS_VERSION=15.1.0 | ||
| fessctl ping | ||
| fessctl user list | ||
| fessctl webconfig create --name TestConfig --url https://test.config.com/ | ||
| docker run --rm \ | ||
| -e FESS_ENDPOINT=https://your-fess-server \ | ||
| -e FESS_ACCESS_TOKEN=your_access_token_here \ | ||
| -e FESS_VERSION=15.1.0 \ | ||
| ghcr.io/codelibs/fessctl:0.1.0 user list |
There was a problem hiding this comment.
The Docker image version is hardcoded to 0.1.0, but the project version has been bumped to 0.2.0.dev. Consider using a variable or updating to match the current version to avoid confusion.
This PR updates the documentation and project metadata to improve usability and clarify installation options:
This refactor improves onboarding for new users and prepares the project for upcoming development releases.