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

edit: custom resources documentation #1696

Merged
merged 12 commits into from
Oct 4, 2024
Merged

edit: custom resources documentation #1696

merged 12 commits into from
Oct 4, 2024

Conversation

GiovannaMonti
Copy link
Member

Description

This PR introduces some changes to the pages related to Custom Resources, adding references to the marketplace management and some use cases.

Pull Request Type

  • Documentation content changes
  • Bugfix / Missing Redirects
  • Docusaurus site code changes

PR Checklist

  • The commit message follows our guidelines included in the CONTRIBUTING.md
  • All tests of Lint, cspell and check-content pass. (How to launch them?)
  • No sensitive content has been committed

@github-actions github-actions bot added fast-data Contents related to Mia-Platform Fast Data documentation release-note labels Oct 3, 2024
@fredmaggiowski
Copy link
Member

Some more important things that I think are still missing are:

  • a note regarding the fact that to deploy template based cr that are not meant to be deployed on k8s will require additional work in the deploy pipeline.
  • schema + field explanation on how to define you cr (maybe a sequence explaining how they are generated at deploy time could be useful?
  • a note regarding the fact that template cr are only supported for the enhanced workflow

fredmaggiowski
fredmaggiowski approved these changes Oct 4, 2024
View reviewed changes
Copy link
Member

@fredmaggiowski fredmaggiowski left a comment

Choose a reason for hiding this comment

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

LGTM

@fredmaggiowski fredmaggiowski marked this pull request as ready for review October 4, 2024 14:18
@fredmaggiowski fredmaggiowski requested a review from a team as a code owner October 4, 2024 14:18
ThisIsDemetrio
ThisIsDemetrio approved these changes Oct 4, 2024
View reviewed changes
Copy link
Contributor

@ThisIsDemetrio ThisIsDemetrio left a comment

Choose a reason for hiding this comment

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

nice job!

@fredmaggiowski fredmaggiowski merged commit 2051d28 into main Oct 4, 2024
6 checks passed
@fredmaggiowski fredmaggiowski deleted the edit/custom-resources-documentation branch October 4, 2024 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ThisIsDemetrio ThisIsDemetrio ThisIsDemetrio approved these changes

@fredmaggiowski fredmaggiowski fredmaggiowski approved these changes

Assignees
No one assigned
Labels
fast-data Contents related to Mia-Platform Fast Data documentation release-note
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@GiovannaMonti @fredmaggiowski @ThisIsDemetrio