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

Create boefjes.md #828

Merged
merged 36 commits into from
May 17, 2023
Merged

Create boefjes.md #828

merged 36 commits into from
May 17, 2023

Conversation

ring-ring-ring
Copy link
Contributor

Changes

Moving all content from the readmes to dev docs

@github-actions
Copy link
Contributor

github-actions bot commented Apr 28, 2023 •
edited
Loading

File Coverage
All files 65% ❌
bits/definitions.py 65% ❌
bits/runner.py 56% ❌
bits/https_availability/https_availability.py 93% ✅
bits/oois_in_headers/oois_in_headers.py 57% ❌
bits/spf_discovery/internetnl_spf_parser.py 55% ❌
bits/spf_discovery/spf_discovery.py 72% ❌
octopoes/api/api.py 58% ❌
octopoes/api/models.py 75% ✅
octopoes/api/router.py 46% ❌
octopoes/core/app.py 80% ✅
octopoes/core/service.py 44% ❌
octopoes/events/events.py 96% ✅
octopoes/events/manager.py 65% ❌
octopoes/models/__init__.py 86% ✅
octopoes/models/datetime.py 66% ❌
octopoes/models/exception.py 83% ✅
octopoes/models/origin.py 70% ❌
octopoes/models/path.py 99% ✅
octopoes/models/types.py 95% ✅
octopoes/models/ooi/certificate.py 96% ✅
octopoes/models/ooi/config.py 89% ✅
octopoes/models/ooi/email_security.py 95% ✅
octopoes/models/ooi/findings.py 94% ✅
octopoes/models/ooi/network.py 97% ✅
octopoes/models/ooi/service.py 91% ✅
octopoes/models/ooi/software.py 71% ❌
octopoes/models/ooi/web.py 81% ✅
octopoes/models/ooi/dns/records.py 95% ✅
octopoes/models/ooi/dns/zone.py 77% ✅
octopoes/repositories/ooi_repository.py 39% ❌
octopoes/repositories/origin_parameter_repository.py 53% ❌
octopoes/repositories/origin_repository.py 52% ❌
octopoes/repositories/scan_profile_repository.py 45% ❌
octopoes/xtdb/client.py 49% ❌
octopoes/xtdb/query_builder.py 69% ❌
octopoes/xtdb/related_field_generator.py 71% ❌
tests/conftest.py 88% ✅
tests/integration/test_xtdb_client.py 34% ❌

Minimum allowed coverage is 75%

Generated by 🐒 cobertura-action against 0e75371

@github-actions
Copy link
Contributor

File Coverage
All files 65% ❌
bits/definitions.py 64% ❌
bits/runner.py 56% ❌
bits/https_availability/https_availability.py 93% ✅
bits/oois_in_headers/oois_in_headers.py 57% ❌
bits/spf_discovery/internetnl_spf_parser.py 55% ❌
bits/spf_discovery/spf_discovery.py 72% ❌
octopoes/api/api.py 59% ❌
octopoes/api/models.py 75% ✅
octopoes/api/router.py 52% ❌
octopoes/core/app.py 69% ❌
octopoes/core/service.py 46% ❌
octopoes/events/events.py 96% ✅
octopoes/events/manager.py 65% ❌
octopoes/models/__init__.py 86% ✅
octopoes/models/datetime.py 66% ❌
octopoes/models/exception.py 83% ✅
octopoes/models/origin.py 70% ❌
octopoes/models/path.py 99% ✅
octopoes/models/types.py 95% ✅
octopoes/models/ooi/certificate.py 96% ✅
octopoes/models/ooi/email_security.py 95% ✅
octopoes/models/ooi/findings.py 94% ✅
octopoes/models/ooi/network.py 97% ✅
octopoes/models/ooi/service.py 91% ✅
octopoes/models/ooi/software.py 71% ❌
octopoes/models/ooi/web.py 81% ✅
octopoes/models/ooi/dns/records.py 95% ✅
octopoes/models/ooi/dns/zone.py 77% ✅
octopoes/repositories/ooi_repository.py 40% ❌
octopoes/repositories/origin_parameter_repository.py 53% ❌
octopoes/repositories/origin_repository.py 53% ❌
octopoes/repositories/scan_profile_repository.py 45% ❌
octopoes/xtdb/client.py 39% ❌
octopoes/xtdb/query_builder.py 69% ❌
octopoes/xtdb/related_field_generator.py 73% ❌
tests/conftest.py 91% ✅

Minimum allowed coverage is 75%

Generated by 🐒 cobertura-action against 2aea748

@ring-ring-ring ring-ring-ring marked this pull request as ready for review April 28, 2023 13:20
@ring-ring-ring ring-ring-ring requested a review from a team as a code owner April 28, 2023 13:20
@ring-ring-ring ring-ring-ring mentioned this pull request Apr 28, 2023
Closed
@dekkers
Copy link
Contributor

dekkers commented May 1, 2023

I think the READMEs in each individual directory is not really useful and we can just delete them?

@ring-ring-ring
Copy link
Contributor Author

There is some content left in these readmes. The idea of moving them here is to make everything available in one place and start updating as needed.

@Donnype Donnype added the documentation Improvements or additions to documentation label May 9, 2023
@dekkers
Copy link
Contributor

dekkers commented May 9, 2023

There is some content left in these readmes. The idea of moving them here is to make everything available in one place and start updating as needed.

I don't mean the content that is moved to the documentation, but the README.rst that are added in each directory telling you to go to docs.openkat.nl, isn't having that in the toplevel directory enough?

@ring-ring-ring
Copy link
Contributor Author

There is some content left in these readmes. The idea of moving them here is to make everything available in one place and start updating as needed.

I don't mean the content that is moved to the documentation, but the README.rst that are added in each directory telling you to go to docs.openkat.nl, isn't having that in the toplevel directory enough?

Yes it might be enough, we can leave them out. Thanks for clarifying, I misunderstood.

ammar92
ammar92 previously approved these changes May 10, 2023
View reviewed changes
Donnype
Donnype requested changes May 10, 2023
View reviewed changes
docs/source/developer_documentation/rocky.md
```


## KATalogus View Structure
Copy link
Contributor

Choose a reason for hiding this comment

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

Since I moved these diagrams in another PR as well, there is a duplicate for the Katalogus views diagram now (see below)!

Donnype
Donnype previously approved these changes May 17, 2023
View reviewed changes
@dekkers dekkers merged commit 6dac07a into main May 17, 2023
@dekkers dekkers deleted the ring-ring-ring-freshreadmes branch May 17, 2023 13:14
jpbruinsslot added a commit that referenced this pull request May 25, 2023
@jpbruinsslot
Merge branch 'main' into fix/mula/thread-termination
12791e0 
* main: (21 commits)
  feature(octopoes): fields to finding type model (#921)
  Add new permissions (#950)
  Fix RDO workflow (#1023)
  Various fixes to Fierce boefje (#1001)
  Feature/add signing provider for raw file (#994)
  Only sleep when all queues are empty (#952)
  Upgrade (default) container Dockerfiles from Python 3.8 to 3.11 (#1021)
  Upgrade FastAPI and dependencies (#467)
  Make two-factor authentication (2fa) optional (#1002)
  Upgrade to Django 4.2 (#1004)
  Upgrade to requests v2.31.0 (#1020)
  Removed LXD legacy (#1016)
  Pin typing-extensions to 4.5.0 (#1019)
  Fix error on clone settings without organization selected (#997)
  Scheduler tests clean up (#978)
  Remove job model and generate migrations (#995)
  update/nuclei path fix, backwards compat (#962)
  Update debianinstall.rst (#822)
  Delete `plugin_repository` package (#992)
  Create boefjes.md (#828)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@underdarknl underdarknl underdarknl left review comments

@dekkers dekkers dekkers approved these changes

@Donnype Donnype Donnype left review comments

@ammar92 ammar92 ammar92 left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
KAT
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@ring-ring-ring @dekkers @underdarknl @ammar92 @Donnype @praseodym @Rieven