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

DOC: Update API docs to work with rewritten API #2292

Merged
merged 4 commits into from
Jul 17, 2023

Conversation

kamil-certat
Copy link
Contributor

Rewritten API requires configuring web server and services
for manually installation. In addition, some previously
missing information are clarified.

This docs are ready to review, but valid after merging the rewritten API in intelmq-api repository.

@gethvi
Copy link
Contributor

gethvi commented Jan 4, 2023

Where can I see the code? :-) I was actually working on my own version of IntelMQ API using FastAPI...

@kamil-certat
Copy link
Contributor Author

I opened PRs in the API repository in December: certtools/intelmq-api#38 (+depending PR 39 with packaging)

@aaronkaplan
Copy link
Member

Where can I see the code? :-) I was actually working on my own version of IntelMQ API using FastAPI...

@gethvi you can see the code in https://github.com/certtools/intelmq-api/

Copy link
Member

@aaronkaplan aaronkaplan left a comment

Choose a reason for hiding this comment

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

minor typo squatting suggestions.
May I suggest to run this through a spell checker again (use chatGPT or so and instruct it to rewrite it ;-) )

docs/user/intelmq-api.rst Outdated Show resolved Hide resolved
docs/user/intelmq-api.rst Outdated Show resolved Hide resolved
@aaronkaplan aaronkaplan added the documentation Indicates a need for improvements or additions to documentation label Feb 2, 2023
@kamil-certat
Copy link
Contributor Author

@aaronkaplan Done. The ChatGPT was unfortunately busy, but the LanguageTool found a few small issues

@aaronkaplan
Copy link
Member

@aaronkaplan Done. The ChatGPT was unfortunately busy, but the LanguageTool found a few small issues

Thank you very much! Looks great.

@kamil-certat kamil-certat marked this pull request as ready for review February 16, 2023 15:53
@kamil-certat kamil-certat force-pushed the docs/fast_api branch 2 times, most recently from fb6073e to 0133c5f Compare February 16, 2023 16:08
Rewritten API requires configuring web server and services
for manually installation. In addition, some previously
missing information are clarified.
@sebix
Copy link
Member

sebix commented Jul 6, 2023

I rebased the branch on current develop to fix the conflict.

@aaronkaplan This PR is marked by yourself as "changes requested". Please look to see if this PR is OK for you now. I think @kamil-certat addressed the issues you pointed out.

@sebix sebix merged commit ded0adf into certtools:develop Jul 17, 2023
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants