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.

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

Closed
DazWilkin opened this issue Jan 16, 2021 · 3 comments
Closed

More fully document Akri's build process #211

DazWilkin opened this issue Jan 16, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation stale

Comments

@DazWilkin
Copy link
Contributor

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

@kate-goldenring kate-goldenring added the documentation Improvements or additions to documentation label Feb 2, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2021

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.

@github-actions github-actions bot added the stale label Sep 4, 2021
@romoh romoh added keep-alive and removed stale labels Sep 8, 2021
@kate-goldenring
Copy link
Contributor

This issue brings up a good point: Akri's development documentation could be more organized and comprehensive.
Currently Akri's main development document is: https://docs.akri.sh/development/development
We also have one focused on using our makefiles: https://docs.akri.sh/development/building
And then the additional documentation @DazWilkin provided above: https://hackmd.io/@akri/S16Xoixyd
This documentation should be brought together and reorganized and put into Akri's documentation repository

@github-actions
Copy link
Contributor

github-actions bot commented Dec 8, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation stale
Projects
Status: Done
Development

No branches or pull requests

4 participants