Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document development aspects of Duffy #253

Open
6 tasks done
nphilipp opened this issue Feb 28, 2022 · 4 comments
Open
6 tasks done

Document development aspects of Duffy #253

nphilipp opened this issue Feb 28, 2022 · 4 comments
Assignees
@nphilipp
Labels
docs

Comments

@nphilipp
Copy link
Collaborator

nphilipp commented Feb 28, 2022 •
edited
Loading

Story

As a developer working on Duffy,
I want to have detailed information concerning technical aspects of it,
so I can contribute with little to no hassle.

Acceptance Criteria

  • Easily accessible documentation exists that describes
    • the technology stack used for Duffy (Python >= 3.8, FastAPI, SQLAlchemy, Celery) and how it's glued together
    • what different components exist (API app server, Celery task worker, legacy metaclient) and how they interact with each other (developer view)
    • workflows (sessions: node reservation, contextualization, retirement; pools: provisioning to fill up to level)
    • the state changes of a node object
    • how to run the test suite
@nphilipp nphilipp added the docs label Feb 28, 2022
@nphilipp nphilipp self-assigned this Mar 14, 2022
@nphilipp
Copy link
Collaborator Author

nphilipp commented Jun 22, 2022 •
edited
Loading

@nphilipp
Copy link
Collaborator Author

https://github.com/CentOS/duffy/wiki/Dev:-Workflows

@nphilipp
Copy link
Collaborator Author

How to run the test suite: https://github.com/CentOS/duffy/wiki/Dev:-Contributing#how-to-set-up-the-development-environment

@nphilipp
Copy link
Collaborator Author

State changes etc: #462

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nphilipp nphilipp

Labels
docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nphilipp