Commit Graph

21 Commits

Author SHA1 Message Date
Richard Cox bcee72e260 Update `addTableColumn` api docs 2025-10-02 09:35:14 +01:00
Alexandre Alves c5f096ac5f
add missing docs for addtab and addpanel (#14997) 2025-08-01 17:15:01 +01:00
Alexandre Alves 3d0d345c08
add docs for page templates (#14937)
* improve definition for top level and cluster level product + add docs for templates + add advanced usecase of extending other products

* address pr comments

* address pr comments from nancy
2025-08-01 16:28:05 +01:00
Alexandre Alves 85111b13cb
add docs for addTab about accessible Vue props + fix minor typo in panels docs (#14968) 2025-07-30 15:31:56 +01:00
Alexandre Alves 1c6b664330
move comprehensive node driver docs to api/components (#14952)
* move comprehensive node driver docs to api/components and leave usecases with a simple page linking to the examples repo pkg

* fix broken links
2025-07-30 10:30:01 +01:00
Jordon Leach 78d6af4c28
Add docs on how to customize a product menu entry (#13961) 2025-04-02 08:36:59 -04:00
Alexandre Alves 68c7c83bee
migrate docusaurus to v3 and add search for documentation (#12681)
* migrate docusaurus to v3 + add search for documentation

* add script to run built assets on docusaurus
2024-11-28 11:44:56 +00:00
Richard Cox 4d4c06f624 Merge pull request #11984 from richard-cox/node-driver-fixes
Fix two node driver based issues
2024-09-26 16:15:57 +01:00
Alexandre Alves 4779223ea4
update extensions documentation for Rancher 2.9 updates (#11362)
* update extensions documentation

* update routing structure overview examples so that devs are not confused on how to setup proper routing for an extension

* update routing docs

* address pr comments

* update all references to shell 2.0.0 to 2.0.1

* update known issues page in docusaurus

* Update docusaurus/docs/extensions/rancher-2.9-support.md

Co-authored-by: Richard Cox <18697775+richard-cox@users.noreply.github.com>

* Update docusaurus/docs/extensions/rancher-2.9-support.md

Co-authored-by: Richard Cox <18697775+richard-cox@users.noreply.github.com>

---------

Co-authored-by: Richard Cox <18697775+richard-cox@users.noreply.github.com>
2024-07-10 09:02:23 +01:00
Alexandre Alves 4ae1459cae
make docusaurus public-facing area exclusive to extensions (#11121) 2024-06-03 12:58:55 +01:00
Alexandre Alves c3cbd738b8
update images in docusaurus extension docs to reflect current UI + added support matrix to extensions api page (#10990) 2024-05-28 10:05:08 +01:00
Alexandre Alves 6ebbcef87e
Improve Extensions documentation (#9896)
* improve docs + fix types definition to prevent linter issues on getting started examples + bump shell version so that we can release a new version

* address pr comments

---------

Co-authored-by: Alexandre Alves <aalves@Alexandres-MBP.lan>
2023-10-12 17:47:45 +01:00
Alexandre Alves c136e0f81f
locationConfig hash param (#9514)
* add hash param to locationConfig object in extensions to allow fine-tune of application of an extension + change logic around extension table cols to better reflect col location based on page user is browsing

* remove commented line

* update docs

* improve docs with breaking changes warning

* address pr comments

* bump shell version

---------

Co-authored-by: Alexandre Alves <aalves@Alexandres-MBP.lan>
2023-08-25 14:41:38 +01:00
Alexandre Alves 744e733f2a
Create mode missing from LocationConfig (#9425)
* fix modes for locationConfig + support new mode ´create´

* update docs

---------

Co-authored-by: Alexandre Alves <aalves@Alexandres-MacBook-Pro.local>
2023-07-27 14:40:45 +01:00
Alexandre Alves e5e7fcb46b
improve location config cross-check with path param (#9385)
* improve location config cross-check with path param

* update docs

---------

Co-authored-by: Alexandre Alves <aalves@Alexandres-MBP.lan>
2023-07-26 17:27:07 +01:00
Neil MacDougall c9e1a19396
Extension support for custom provisioning (#9246)
* Extension support for custom provisioning

* FIx lint issues

* Discovery / Tweaks
- fix issue where namespacesOverride was lost
- tidy up PROVIDER
- try to handle missing provider=type url param (could be missing extension-params)
- added a few comments to comments to come back to

* Names and typings
- change param --> customParam to make it clearer it's not url params
- add labels-annotations to shell types

* Wire in provider detailTabs
- as per original readme this should be made generic (extension point working directly with ResourceTabs)

* Update IClusterProvisioner & docs

* Improvements / Changes to support proving out DO extension
- cluster hooks optional
- buff up save hook (and pass in cluster when calling apply fn)
- move normalizeName into generic place
- bring back async create machine config
- hack for do extension (map example provider to do provider)

* updates, add optional saveCluster, add missing kube file
- saveCluster complements hooks, doesn't skip handling of addons, etc
- ensure register hooks take the `this` context in all worlds

* Adding docs

* Updates
- location config based changes
  - change customParams to context
  - add query param
- add new extention point to add tabs to cluster create cluster config section
- fixed some typing
- fixed issue where cluster was not passed to before / after hooks (only important if 'this' changes

* Changes following review, fix `t` in plugins

* Fix linting

* Docs updates, pass through more edit/view things

* Conditionally show the namespace grouping in the cluster list
- means users can differentiate between clusters with same name in different namespaces
- useful when clusters created via extension provisioner where ns can be selected

* docs tweaks, actually include the provisioning page in docs

---------

Co-authored-by: Richard Cox <richard.cox@suse.com>
2023-07-11 22:17:57 +01:00
Alexandre Alves 1ec3056b74
add support for enabled as a function in table action extension point + update extension docs (#9170)
Co-authored-by: Alexandre Alves <aalves@Alexandres-MBP.lan>
2023-07-07 14:59:43 +01:00
codyrancher 55c9497fe9 Provide the relevant types for the product.ts and update the appropriate docs
https://github.com/rancher/dashboard/issues/8744
2023-04-28 14:25:10 +02:00
Alexandre Alves fedc7c1692
final breakdown of extensions doc into smaller chapters (#8678)
* final breakdown of my huge doc into smaller chapters

* fix broken link on docs + add usecases chapter + replace blank cluster definition

* remove chapter on concepts

* minor fixes to docs after testing usecase code

---------

Co-authored-by: Alexandre Alves <aalves@Alexandres-MacBook-Pro.local>
Co-authored-by: Alexandre Alves <aalves@Alexandres-MBP.lan>
2023-04-18 19:12:13 +01:00
Neil MacDougall 41cc5ff0cf
Extension docs: Minor tweaks (#8677)
* first push on docs

* another iteration of the extensions docs

* minor cleanup

* minor cleanup

* lint fix + remove pkg

* address PR comments

* Restructuring

* Fix broken links

* Extension Docs: Minor improvements

* Fix lint

---------

Co-authored-by: Alexandre Alves <aalves@Alexandres-MBP.lan>
Co-authored-by: Alexandre Alves <aalves@Alexandres-MacBook-Pro.local>
2023-04-18 12:10:57 +01:00
Neil MacDougall 0ab17e228c
Ext docs (#8673)
* first push on docs

* another iteration of the extensions docs

* fixing lint suggestion

* minor cleanup

* minor cleanup

* lint fix + remove pkg

* fix broken link

* address PR comments

* Restructuring

* Fix broken links

* Fit lint

---------

Co-authored-by: Alexandre Alves <aalves@Alexandres-MBP.lan>
Co-authored-by: Alexandre Alves <aalves@Alexandres-MacBook-Pro.local>
Co-authored-by: Alexandre Alves <97888974+aalves08@users.noreply.github.com>
2023-04-17 15:43:16 +01:00