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

Improve operator documentation #1392

Merged
merged 4 commits into from
Jun 14, 2023
Merged

Conversation

andrea-smiesna
Copy link
Collaborator

@andrea-smiesna andrea-smiesna commented Jun 12, 2023

Checklist

  • I have followed (at least) the PR section of the contributing guide.
  • I fixed all necessary PR warnings
  • The commit history is clean
  • The E2E tests are passing
  • If possible, the issue has been divided into more subtasks
  • I did a self review before requesting a review from another team member

Description

Improve operation and administration documentation:

  • improve docs structure
  • improve architecture docs, add different diagrams
  • improve docs on monitoring and logging tools in TruBudget
  • add docs about debugging TruBudget
  • improve docs on updating TruBudget
  • add fixes to setup docs
  • add docs regarding k8s setup

Closes #1336
Closes #1095
Closes #1380

@andrea-smiesna andrea-smiesna linked an issue Jun 12, 2023 that may be closed by this pull request
1 task
@andrea-smiesna andrea-smiesna changed the title doc: Improve operator documentation Draft: doc: Improve operator documentation Jun 12, 2023
@andrea-smiesna andrea-smiesna force-pushed the 1380-improve-operator-documentation branch from 9514582 to 9135544 Compare June 12, 2023 14:45
@openkfwCI
Copy link

openkfwCI commented Jun 12, 2023

NotesTime
Note for Reviewer: E2E tests on remote server succeededTue, 13 Jun 2023 16:26:48 +0000

Generated by E2E-Test

- improve docs structure
- improve architecture docs, add different diagrams
- improve docs on monitoring and logging tools in TruBudget
- add docs ion debugging TruBudget
- improve docs on updating TruBudget
@georgimld georgimld force-pushed the 1380-improve-operator-documentation branch from 7c7df6e to a8f8997 Compare June 13, 2023 14:24
@georgimld georgimld marked this pull request as ready for review June 13, 2023 14:30
@georgimld georgimld changed the title Draft: doc: Improve operator documentation Improve operator documentation Jun 13, 2023
@georgimld georgimld merged commit 5f76e7d into main Jun 14, 2023
@georgimld georgimld deleted the 1380-improve-operator-documentation branch June 14, 2023 07:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants