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

Docs update on OCI image building from current Python/Docker boefjes #2827

Merged
merged 7 commits into from
May 2, 2024

Conversation

Donnype
Copy link
Contributor

@Donnype Donnype commented Apr 11, 2024

Rename technical_design to installation_and_deployment because that's the title and contents.
Add considerations on image building.

Changes

Documentation update including one url change. Not sure if there are external sources pointing to the url though. But I do think this is a better name as I keep getting confused looking for the place I need to add docs.

Issue link

Closes #2756

Demo

image


Code Checklist

  • All the commits in this PR are properly PGP-signed and verified.
  • This PR only contains functionality relevant to the issue; tickets have been created for newly discovered issues.
  • I have written unit tests for the changes or fixes I made.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have performed a self-review of my code and refactored it to the best of my abilities.

Communication

  • I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
  • I have made corresponding changes to the documentation, if necessary.
  • I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.


Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

Rename technical_design to installation_and_deployment because that's the title and contents

Signed-off-by: Donny Peeters <[email protected]>
@Donnype Donnype requested a review from a team as a code owner April 11, 2024 12:44
@Donnype Donnype changed the title V1 docs update on OCI image building from current boefjes Docs update on OCI image building from current Python/Docker boefjes Apr 11, 2024
@Donnype Donnype self-assigned this Apr 18, 2024
Copy link
Contributor

@ammar92 ammar92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me 👍 Just a few fix suggestions

docs/source/developer_documentation/boefjes-runner.md Outdated Show resolved Hide resolved
docs/source/developer_documentation/boefjes-runner.md Outdated Show resolved Hide resolved
Signed-off-by: Donny Peeters <[email protected]>
ammar92
ammar92 previously approved these changes Apr 30, 2024
@stephanie0x00
Copy link
Contributor

No QA comments. Looks good for now.

…design

# Conflicts:
#	docs/source/developer_documentation/boefjes-runner.md
@underdarknl underdarknl merged commit 3588c77 into main May 2, 2024
10 checks passed
@underdarknl underdarknl deleted the chore/docs-on-oci-image-building-design branch May 2, 2024 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs update for containerized boefjes
4 participants