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 Extension Getting Started Guide #12649

Open
richard-cox opened this issue Nov 21, 2024 · 1 comment
Open

Improve Extension Getting Started Guide #12649

richard-cox opened this issue Nov 21, 2024 · 1 comment
Labels
area/documentation area/extensions kind/enhancement QA/dev-automation Issues that engineers have written automation around so QA doesn't have look at this
Milestone

Comments

@richard-cox
Copy link
Member

https://extensions.rancher.io/extensions/next/extensions-getting-started

This needs to be converted into a clear A --> Z guide and possibly broken up

  • "Creating an extension" covers creating the root app and 1 extension, this isn't very clear
  • Order isn't logical
    • asked to run yarn create @rancher/extension my-app
    • then info on installing rancher (this shouldn't be embedded in this guide, if at all it should be a link outside)
    • then in the same section as installing rancher details of the options for create @rancher/extension takes
    • then instructions on how to run rancher using root app
  • Creating another extension pkg
    • this starts with the same command as above, which would create the root app (does it skip if exists?)
    • not sure why his isn't covered in the section above?
  • Configuring extension (shouldn't this be writing extension, it's not really config)
  • Running the App
    • this repeats the instruct from above
  • Loading Into Rancher
  • Creating a Release
  • Wrap-up
@richard-cox richard-cox added this to the v2.11.0 milestone Nov 21, 2024
@github-actions github-actions bot added the QA/dev-automation Issues that engineers have written automation around so QA doesn't have look at this label Nov 21, 2024
@sudomateo
Copy link

I would very much appreciate an improved getting started guide that covers creating an extension with both cloud-credential and machine-config folders. My use case is I would like to create a third-party Node Driver with a more polished UI than the default.

When I was researching and hacking around on this I found the following resources.

I asked for help in the Rancher Users Slack and received guidance to look at Notable Vue3 syntax changes and the Vue 3 Migration Guide. Those resources were helpful and I was able to get components rendering but I still don't fully understand the data binding model. Specifically how does data within cloud-credential relate to machine-config and the node driver itself?

I spent more time than I wanted on this so I'm going to punt on this and focus just on the Go node driver. I'll come back to this when the documentation is more current/stable. I think a great getting started guide would be one that runs through a full node driver integration with a UI extension that customizes the cloud-credential and machine-config. This guide could also explain how the data is meant to interact with one another. Thank you for writing this issue up!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation area/extensions kind/enhancement QA/dev-automation Issues that engineers have written automation around so QA doesn't have look at this
Projects
None yet
Development

No branches or pull requests

2 participants