Create build/deploy documentation - Githubissues

amosproj / amos2024ss08-cloud-native-llm

MIT License

7 stars 1 forks source link

Create build/deploy documentation #52

Closed dominic0df closed 3 months ago

dominic0df commented 4 months ago

User story

As a developer
I want / need to create a documentation of how my build process works
So that others will be able to easily build and run my software.

Acceptance criteria

It is documented how our software can be build (see https://github.com/amosproj/amos2024ss08-cloud-native-llm/issues/49#issue-2308787573)
It is documented how our software can be deployed (see https://github.com/orgs/amosproj/projects/57/views/2?pane=issue&itemId=62926163 and https://github.com/orgs/amosproj/projects/57/views/2?pane=issue&itemId=62582340)
It is published in our wiki
PDF of wiki pages created and uploaded to deliverables folder

Definition of done (DoD)

Bill of Materials in the planning document has been updated
All the complex logics have been tested
All feature branches have been merged and closed
New feature code has been documented
Potential new licenses have been checked
All GitHub Actions are passing
The requirement.txt is updated

DoD general criteria

Feature has been fully implemented
Feature has been merged into the mainline
All acceptance criteria were met
Product owner approved features
All tests are passing
Developers agreed to release

dominic0df commented 3 months ago

added DoD