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

Fix documentation where schematic for component definition refers to kube #6436

Open
anoop2811 opened this issue Jan 5, 2024 · 5 comments · May be fixed by #6441
Open

Fix documentation where schematic for component definition refers to kube #6436

anoop2811 opened this issue Jan 5, 2024 · 5 comments · May be fixed by #6441
Labels
good first issue Good for newcomers help wanted Extra attention is needed and welcome new comers who are well skilled type/docs Improvements or additions to documentation

Comments

@anoop2811
Copy link
Contributor

Refer to this slack conversation: https://cloud-native.slack.com/archives/C01BLQ3HTJA/p1704394842494259

The kube scematic was deprecated in this commit: f1bae16

However we still have documentation like here where it refers to kube schematic. We should update this to using cue.

@anoop2811 anoop2811 added type/docs Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed and welcome new comers who are well skilled labels Jan 5, 2024
@professorabhay
Copy link

Hey, @anoop2811 ! I would like to give it a try.
Is there anything else related to this that can help?

@anoop2811
Copy link
Contributor Author

Hey @professorabhay ! Welcome to the community. One way you could do is search in the code under the docs directory for "kube:" and look for occurrences under schematic, convert them to using cue and test the same locally. You can refer to an example here: https://kubevela.io/docs/platform-engineers/oam/x-definition/#specpoddisruptive. Let us know if you need any further help.

@professorabhay
Copy link

Ok @anoop2811, I got it almost. Just one question -
I found kube in docs/ at two places.

1 - docs/examples/workflow/Li-Auto-Inc/common-definitions.yaml

2 - docs/examples/kube-module/kube-worker-cd.yaml

In both files kube is written under the schematic: and I have to change it to cue. Am I right?

image

*both are same

@kartikaysaxena kartikaysaxena linked a pull request Jan 14, 2024 that will close this issue
@anoop2811
Copy link
Contributor Author

@professorabhay you would need to change it to cue and the template needs to be converted from yaml to cuelang equivalent for that yaml

@kartikaysaxena
Copy link

Hi @anoop2811 I have opened a PR, can you please take a look at it? Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed and welcome new comers who are well skilled type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants