Skip to content

Commit

Permalink
doc: add items to the roadmap.
Browse files Browse the repository at this point in the history
  • Loading branch information
sfermigier committed Nov 28, 2024
1 parent f216a1e commit b5bdc1e
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,7 @@ vagrant ssh
- [x] Add support for local development with **Vagrant**.
- [x] Enable easy integration and deployment with **Heroku**.
- [x] Implement a basic CLI for interacting with the SMO API.
- [x] Generate a SBOM.

### Roadmap / Started

Expand All @@ -221,14 +222,24 @@ vagrant ssh
- [ ] feature: Implement a proper configuration management.
- [ ] feature: Implement a dependency injection mechanism.
- [ ] feature: Implement an extension mechanism (e.g. `pluggy` or similar).
- [ ] refact: Replace the Gurobi Optimizer with an [open-source alternative](https://lab.abilian.com/Tech/Programming%20Techniques/Optimization/) (and/or make the optimizer pluggable).
- [ ] refact: Replace the Gurobi Optimizer with an [open-source alternative](https://lab.abilian.com/Tech/Programming%20Techniques/Optimization/)
- [ ] lint: Fix / suppress all linting issues (ruff, flake8).
- [ ] lint: Resolve all type-checking issues (mypy, pyright, typeguard, beartype).
- [ ] doc: Introduce a Changelog (and tools to manage it, like `towncryer` or similar).
- [ ] doc: Create a proper documentation site using Portray or MkDocs (cf. <https://lab.abilian.com/Tech/Python/Tooling/Documentation/>)
- [ ] doc: Describe python API using a formalized format (cf. <https://lab.abilian.com/Tech/Python/Tooling/Documenting%20a%20Python%20API/>)
- [ ] chore: Add a license compliance report (and double-check REUSE config).

### Roadmap / Long-term

- [ ] refact: make the optimizer pluggable.
- [ ] feat: make the orchestration backend-end (current, Kubernetes) pluggable.
- [ ] refact: make the orchestrator pluggable.
- [ ] feat: create plugins for other orchestrators: Nomad, Docker Swarm, OpenNebula, Hop3 (when it's ready), etc.
- [ ] feat: Make a Web UI.
- [ ] refact: Make the optimisation algorithm pluggable.
- [ ] feat: Create and benchmark alternative optimisation algorithms.
- ...

## Contributing

Expand Down

0 comments on commit b5bdc1e

Please sign in to comment.