Commit Graph

48 Commits

Author SHA1 Message Date
Jordon Leach f0458777d5
Extension creator upgrade paths - Update documentation (#12737)
* Fix upgrade path for extension creators

* Add extension upgrade documentation

* Bump extension creator
2024-12-02 13:26:24 -05:00
Alexandre Alves b0aba31dc8
Small fixes for docs and extensions workflow tests (#12704)
* small fix extensions workflow tests + update docs for extensions

* small fix extensions workflow tests

* fix annotation in migration script
2024-11-28 16:05:05 +00: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
Alexandre Alves 2c0c8ad30f
Extensions docs update (#12491)
* update docs with migration guide + new mechanism to fix annotations + other small changes

* Update docusaurus/docs/extensions/advanced/fix-annotations-published-extensions.md

Co-authored-by: Jordon Leach <jordonleach@gmail.com>

* update docs for annotations fix + update dates format on changelog + fix link on homepage

* configure redirect plugin (only works in production)

* update redirect config

* Update docusaurus/docs/extensions/advanced/fix-annotations-published-extensions.md

Co-authored-by: Jordon Leach <jordonleach@gmail.com>

* Update docusaurus/docs/extensions/advanced/fix-annotations-published-extensions.md

Co-authored-by: Jordon Leach <jordonleach@gmail.com>

* Update docusaurus/docs/extensions/advanced/fix-annotations-published-extensions.md

Co-authored-by: Jordon Leach <jordonleach@gmail.com>

* Update docusaurus/docs/extensions/advanced/fix-annotations-published-extensions.md

Co-authored-by: Jordon Leach <jordonleach@gmail.com>

* hide docs on fixing annotations

* add simple change to re-trigger test

---------

Co-authored-by: Jordon Leach <jordonleach@gmail.com>
2024-11-07 09:53:31 +00:00
Jordon Leach dd0b605c56
Refactor extensions docs to enable versioning (#12355)
* Refactor extensions docs to enable versioning

* Fix relative links

* Change next version label to 3.x.x
2024-11-04 16:26:59 +00:00
Richard Cox 77e91a4185
Merge pull request #12039 from richard-cox/fix-node-drivers
Fix two node driver based issues
2024-10-21 14:50:39 +02:00
Jordon Leach 623a36c044
Fix extension publishing workflows for Vue3 compatibility (#12148)
* Add warning about skeleton application naming scheme and workflow compatibility

* Pin node version 20 - remove global yarn setup
2024-10-07 08:22:49 -04:00
Alexandre Alves 04057e6479 update extension docs 2024-10-02 10:07:52 +01: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 b8ad980c51
update extensions build chart workflow to only work with tagged releases (#11946)
* update extensions build chart workflow to only work with tagged releases

* improve docs on publishing extensions

* Update docusaurus/docs/extensions/publishing.md

Co-authored-by: Jordon Leach <40806497+jordojordo@users.noreply.github.com>

* Update docusaurus/docs/extensions/publishing.md

Co-authored-by: Jordon Leach <40806497+jordojordo@users.noreply.github.com>

* Update docusaurus/docs/extensions/publishing.md

Co-authored-by: Jordon Leach <40806497+jordojordo@users.noreply.github.com>

* Update docusaurus/docs/extensions/publishing.md

Co-authored-by: Jordon Leach <40806497+jordojordo@users.noreply.github.com>

---------

Co-authored-by: Jordon Leach <40806497+jordojordo@users.noreply.github.com>
2024-09-20 09:40:38 +01:00
Jordon Leach c171255899
Ensure @rancher/shell version using tags (#11758)
* Ensure @rancher/shell version using tags

Enable corepack for extension builds

Migrate creators outside of shell dir

Update creators path - switch to npm publish

* Add NPM_REGISTRY to publish args

* Fix creators_dir path - Bump ext package

* Add update package version function in test script

* Fix gitignore file name

* Add .yarnrc.yml for skeleton - revert node versions
2024-08-30 19:10:19 -04:00
Neil MacDougall cbf74d1738
Tweaks to docs (#11739) 2024-08-29 10:00:42 +01:00
Alexandre Alves 9d03336be9
add docs for adding icon to custom node driver (#11717) 2024-08-27 15:33:32 +01:00
Alexandre Alves 3db111e1b6
fix query param on docs to be correct (#11691) 2024-08-23 12:53:43 +01:00
Jordon Leach 21120630f7
Consolidate extension creators into one package (#11605)
* Consolidate extension creators into one package

* PR updates

* Fix test-plugins-build script to match new creator - remove dependency install step
2024-08-22 11:18:49 -04:00
Alexandre Alves 300916d7fd
Improve extensions docs - changelog (#11636)
* add changelog section for shell releases + add extra documentation regarding the 2.9 update in terms of branching

* add 2.10 page about vue3 migration

* address pr comments
2024-08-21 16:13:28 +01:00
Anton Ovechkin 17039a3af0
Update rancher-2.9-support.md (#11575)
* Update rancher-2.9-support.md

Addressing typo in the desired `@rancher/shell` version from 2.9.0 to 2.0.1

* Update rancher-2.9-support.md

Change 2.1.0 to 2.0.1
2024-08-02 09:14:02 +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 7c8dcf9c30
update docs for noAuth annotation (#11221)
* update docs

* update docs

* address pr comments
2024-06-17 13:26:45 +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
Giuseppe Leo 696e511984
Create Vue3 migration script: upgrade libraries, configuration, syntax and tools (extension ready) (#10998)
* Add migration script and documentation

* Correct linting issue due new location of script

* Remove v-model migration due lack of emitter implementation
2024-05-11 10:05:38 +02:00
Jordon Leach 20de414d04
Add GitLab support for extensions (#9891) 2023-11-20 14:12:47 -05: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
Jordon Leach 5dd0d52942
Add reusable workflows for extension builds (#9495)
* Add reusable workflows for extension builds

Add workflow configuration

* Add parsing of extension release tag name

* Update permissions for ext workflows
2023-08-28 11:23:10 -04: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
Jordon Leach d0a0a4b72f
Fix extension displayName annotation conditions - add configuration docs (#9544) 2023-08-18 16:17:18 -04:00
Jordon Leach c23dcf5de6
Add tagged release option to publish-pkgs script (#9456)
* Add tagged release option to publish-pkgs script

* Update publishing documentation for manual Github builds
2023-08-02 07:42:05 -04: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
codyrancher cc086ee953 Switch safemode to use the query param
Making this switch because using the path can lead to undefined routes and some confusion on wildcard routes.

https://github.com/rancher/dashboard/pull/9135#discussion_r1232391119
2023-07-09 09:07:42 -07: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
Alexandre Alves 8c36ed5f5d
update extension docs with version compatibility and safe mode information (#9135)
Co-authored-by: Alexandre Alves <aalves@Alexandres-MBP.lan>
2023-06-16 17:54:14 +01:00
Jordon Leach d94e78c24a
Add extension image load dialog (#9010)
Update dialog with repo creation - update docs

Add uninstall for custom images

Add extension images list view

Add image load dialog and uninstall within extension image view

Update publish and bundle scripts for image load - move image page to tab

Add extension container build workflow file to pkg creator

Move plugin server template into extension build scripts

Fix publish script for multiple asset packages

Move ImageList view to separate page - add crd metadata for custom images

Update docs - fix references to images with catalog

Fix wording, cache state badge, masthead breadcrumb, when deleteing resources check for namespaces

Update docs - fix delete repo resource - default cache state

Trim image whitespace - populate extensionUrl

Add experimental badge
2023-06-02 08:28:47 -04:00
Neil MacDougall 9d5b197b6e
Update node driver docs (#8990) 2023-05-26 15:30:46 +01:00
Alexandre Alves a1c3d6e679
minor updates for extensions (#8792)
* docs minor update + add gitignore file to creator npm package

* update gitignore

---------

Co-authored-by: Alexandre Alves <aalves@Alexandres-MBP.lan>
2023-05-08 10:07:53 +01:00
codyrancher 1a6ccebb80 Making small improvements to the getting started docs
- https://rancher.github.io/dashboard/extensions/extensions-getting-started#creating-an-extension Make it clear where to put the options
-  Fix the missing API= in each of the getting started locations
- https://rancher.github.io/dashboard/extensions/extensions-getting-started#running-the-app Link to the docs or explain how to edit the page that reads Default dashboard for myProductName.
- https://rancher.github.io/dashboard/extensions/extensions-getting-started#release-prerequisites It would be nice to link to gh-pages docs or provide screenshots
2023-04-28 17:14:02 +02: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
Neil MacDougall 34d1c47fd9
Update docs to indicate Windows is not support as a dev environment (#8699) 2023-04-20 12:58:32 +01: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
Jordon Leach 2d5e1c32ee
Add github workflow option to creator pkg (#8318)
* Add github workflow option to creator pkg

Add js-yaml to creator pkg dependencies

Update init to move workflow file into root app dir

Split build-extension workflow jobs - add tmp directory step in publish script

Fix issues with non-existent workflows - add some docs

Fix pkg and app versions

add yarn.lock and ignore

Update workflow to use @rancher/shell publish script

Decouple the image build from the publish script - update docs

Remove implies for repo and branch options

Update advanced.md

Change type folder generation from i18n to l10n

Remove mention of tmp dir in clean-up section

* Remove bundle registry_org conditional
2023-04-03 15:44:16 -04:00
Jordon Leach 65cd3c4ada
Add extension translation docs (#8417) 2023-03-16 11:32:39 -04:00
Neil MacDougall 7aade7ec4f
Very minor Extension docs changes (#8323) 2023-03-02 17:26:41 +00:00
Jordon Leach 27cc5618a1
Update extension docs (#8251) 2023-02-24 09:29:08 +00:00
Alexandre Alves 7961638525
add documentation for extensions api (#7874)
* add documentation for extensions api + update extension docs
---------

Co-authored-by: Alexandre Alves <aalves@Alexandres-MBP.lan>
2023-02-23 17:08:20 +00:00