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

Go tutorials are referencing old project layout #6821

Open
maxcao13 opened this issue Aug 28, 2024 · 3 comments
Open

Go tutorials are referencing old project layout #6821

maxcao13 opened this issue Aug 28, 2024 · 3 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@maxcao13
Copy link

maxcao13 commented Aug 28, 2024

What is the URL of the document?

https://sdk.operatorframework.io/docs/building-operators/golang/tutorial/
https://sdk.operatorframework.io/docs/building-operators/golang/migration/
...etc

Which section(s) is the issue in?

Create a new API and Controller (tutorial)
What was changed (migration)

What needs fixing?

I think the documentation that references controllers and main.go is old. Seems like when I do operator-sdk init and operator-sdk create api, it generates cmd/main.go and internal/..._controller.go. Not sure which one is wrong, the docs or the init, but I'm guessing it's the docs.

Additional context

I think there's more cases of the wrong project layout being referenced in the docs.
Operator-sdk version:

operator-sdk version: "v1.36.1", commit: "37d2f2872bfecd6927469f384be4951805aa4caa", kubernetes version: "1.29.0", go version: "go1.21.12", GOOS: "linux", GOARCH: "amd64"
@maxcao13 maxcao13 added the kind/documentation Categorizes issue or PR as related to documentation. label Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

3 participants
@maxcao13 and others