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

initial kof documentation proposal #94

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Conversation

mestadler
Copy link
Contributor

@mestadler mestadler commented Jan 22, 2025

Initial version of the docs for KOF to be included in the k0rdent documentation. This is taken from the wiki and repo docs, and will need review by the KOF team.

Closes #92

Initial version of the docs for KOF to be included in the k0rdent documentation.
@mestadler mestadler added the documentation Improvements or additions to documentation label Jan 22, 2025
@mestadler

This comment was marked as resolved.

@denis-ryzhkov denis-ryzhkov marked this pull request as draft January 23, 2025 08:49
docs/kof-into.md Outdated
@@ -0,0 +1,278 @@
# k0rdent Observability and FinOps (KOF)
Copy link
Contributor

Choose a reason for hiding this comment

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

The filename kof-into.md looks like a typo, please rename it to either:

  • kof-intro.md
  • kof-info.md
  • kof.md - I'd prefer this simple one.

Also please update the PR title in the same way.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Copy link
Contributor

Choose a reason for hiding this comment

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

as we discussed, we'll rename the file before the merge to avoid suggestions becoming outdated

docs/kof-into.md Outdated Show resolved Hide resolved
docs/kof-into.md Outdated Show resolved Hide resolved
docs/kof-into.md Outdated Show resolved Hide resolved
docs/kof-into.md Outdated Show resolved Hide resolved
name: kof-storage-cluster
namespace: kof
spec:
template: kof-storage
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure, but this template: kof-storage looks alike, but not compatible with template: kof-storage we're using here: https://github.com/k0rdent/kof/blob/f3520f76373672cd0325aa09d85210f0f268f1e3/demo/cluster/aws-storage.yaml#L40

And the same for template: kof-collectors below.


``` yaml
apiVersion: grafana.integreatly.org/v1beta1
kind: GrafanaDatasource
Copy link
Contributor

Choose a reason for hiding this comment

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

docs/kof-into.md Show resolved Hide resolved
docs/kof-into.md Outdated Show resolved Hide resolved
docs/kof-into.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@mestadler mestadler left a comment

Choose a reason for hiding this comment

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

All agreed.

@mestadler mestadler marked this pull request as ready for review January 23, 2025 18:20
mestadler and others added 5 commits January 23, 2025 18:50
Co-authored-by: Denis Ryzhkov <[email protected]>
Co-authored-by: Denis Ryzhkov <[email protected]>
Co-authored-by: Denis Ryzhkov <[email protected]>
Co-authored-by: Denis Ryzhkov <[email protected]>
@denis-ryzhkov
Copy link
Contributor

denis-ryzhkov commented Jan 24, 2025

As decided above, I'll continue from here in the same branch/PR.

@denis-ryzhkov denis-ryzhkov marked this pull request as draft January 24, 2025 11:47
@mestadler
Copy link
Contributor Author

Sounds good.

@mestadler mestadler marked this pull request as ready for review January 24, 2025 16:29
@denis-ryzhkov
Copy link
Contributor

Updated so far:

Rendered version

@denis-ryzhkov denis-ryzhkov changed the title Create kof-into.md initial kof documentation proposal Jan 24, 2025
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
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

initial kof documentation proposal
2 participants