-
Notifications
You must be signed in to change notification settings - Fork 150
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.
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
More fully document Akri's build process #211
Comments
Issue has been automatically marked as stale due to inactivity for 45 days. Update the issue to remove label, otherwise it will be automatically closed. |
This issue brings up a good point: Akri's development documentation could be more organized and comprehensive. |
Issue has been automatically marked as stale due to inactivity for 90 days. Update the issue to remove label, otherwise it will be automatically closed. |
Is your feature request related to a problem? Please describe.
There are many, independent but necessary changes required when extending Akri.
The Development doc does a good job but it is insufficient.
The build process is quite involved.
Is your feature request related to a way you would like Akri extended? Please describe.
More fully document the steps needed to extend Akri's build process with new components.
Use these documented steps as informal unit tests when changes are made to the build process.
Consider improvements to the build process reviewing the documented steps.
E.g. the Makefiles are very repetitive and would benefit from refactoring.
Describe the solution you'd like
I took a stab at documenting extending the build process for new components since I've just done this for the Webhook:
https://hackmd.io/@akri/S16Xoixyd
Feedback very welcome.
Describe alternatives you've considered
None.
Additional context
E.g. see #206
The text was updated successfully, but these errors were encountered: