Commit Graph

68 Commits

Author SHA1 Message Date
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
codyrancher 2f64abbddf
Merge pull request #9434 from codyrancher/layouts-docs
Adding documentation for the layouts directory
2023-07-28 12:16:06 -07:00
Cody Jackson 2dc6dfb113 Adding documentation for the layouts directory 2023-07-28 10:15:30 -07:00
Evgeniya Vashkevich ebfd4ccd51
Changed navlink page and improved error handling for FileImageUpload (#9411) 2023-07-27 14:03:43 -07: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
Richard Cox be16d584c2
Merge pull request #9251 from richard-cox/fix-link
Remove link to code within repo from docs page
2023-07-12 13:13:29 +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
yonasberhe23 2c18619932
ui automation: update workflow: create standard user, add tags to tests (#9029)
* add standard user to workflow

* update create user logic and added cypress-grep plugin

* added admin and standard user tags to tests, updated workflow in test.yaml

* update workflow file and added adminUser tag to setup

---------

Co-authored-by: Yonas Berhe <yberhe@Yonass-MacBook-Pro.local>
2023-07-04 11:17:24 -07:00
Richard Cox 9141a925cd Remove link to code within repo from docs page
- supercedes https://github.com/rancher/dashboard/pull/9250
2023-07-03 12:03:19 +01:00
Evgeniya Vashkevich f88f6ef92b
Update quickstart.md
Added prerequisites to Development quickstart guide.
2023-06-27 11:24:29 -07: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
Richard Cox 9179530ad8 Add a quick start guide for running e2e tests in vanilla systems 2023-05-11 12:30:06 +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
Cody Jackson 487cf0d6a4 Migrating all of the files out of the nuxt directory into reasonable places within shell 2023-04-20 11:56:58 +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
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
codyrancher 457b0df175
Merge pull request #8436 from codyrancher/better-routes
Moving the route files outside of the nuxt subfolder
2023-03-16 14:10:10 -06:00
Jordon Leach 65cd3c4ada
Add extension translation docs (#8417) 2023-03-16 11:32:39 -04:00
Cody Jackson eecefff26a Moving the route files outside of the nuxt subfolder 2023-03-14 17:00:42 -07:00
Cody Jackson bbb7eebc90 Removing nuxt 2023-03-03 11:49:26 +00: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
Neil MacDougall 525de17e68
Update repo readme and move quickstart docs to docusaurus (#7778)
* Update repo readme and move quickstart docs to docusaurus

* Fix typo

* One fix, one tweak
- Fix localhost reference
- Explicity state quickstart to run dashboard

Co-authored-by: Richard Cox <richard.cox@suse.com>
2022-12-22 18:14:46 +00:00
Neil MacDougall 81da914c14
Do not always instrument code (#7651)
* Do not always instrument code

* Update docs

* Rename env var
2022-12-08 17:01:59 +00:00
Neil MacDougall 4ba79f761c
Move storybook (#7611)
* Improve Storybook welcome/landing page

* Move storybook

* Tidy up build scripts and docs

* Update yarn.lock

* Update yarn.lock

* Address PR feedback

* Fix issue with running after 1st run

* Add back top-level build-storybook target
2022-12-07 18:07:48 +00:00
Nancy 002c984e0f
refactor promptModal component props (#7435)
* use modalData.componentProps to pass props to custom modal components

* linting errors
2022-12-06 09:41:17 -07:00
Neil MacDougall fc377a0eb2
Extension and other docs (#7551) 2022-11-28 15:04:53 +00:00
richa 5413c42f52
Added info about how table headers are populated (#7527)
* Added info about how table headers are populated

* Change text for Custom header
2022-11-25 12:40:29 +01:00
Jordon Leach 8d5d91d16d
Replace initial Verdaccio guide with published npm packages (#7481)
Replace wording
2022-11-22 12:52:07 -05:00
Giuseppe Leo cd947db43b
Add unit tests for Namespace filtering in resources (#7465)
* Prevent errors if no resource is retrieved for NamespaceFilter; Add data-testid attributes for testing purposes and ocmments for readability

* Add NamespaceFilter component tests

* Add Workload loading unit tests

* Restore mokcs globally after each test

* Add issue number to TODO comment
2022-11-18 00:05:42 +01:00
richa b6b98f62d6
Storybook doc (#7356)
* Added Storybook page

* Modify storybook doc

* Added details in storybook.md

* Fixed some text

* Fixed merge conflict
2022-11-16 15:50:08 +01:00
Alexandre Alves 0f2e2fc51f
Updating docs for kube resources data loading optimisation on dashboard (#7321)
* working on docs

* finish up docs for kube resources data loading optimisations

Co-authored-by: Alexandre Alves <aalves@Alexandres-MacBook-Pro.local>
2022-11-14 09:25:43 +00:00
Nancy Butler b700c4d28b fix relative links in docs 2022-11-08 09:12:03 -07:00
Richard Cox 54b6cac0cb
Merge pull request #7162 from mantis-toboggan-md/plugins-docs
[WIP] plugin/general docs update
2022-11-08 15:15:13 +00:00
Jordon Leach 6d6c2e084e
Add script to update docker image (#7343)
* Add script to update docker image

* Change docker run output to log file - update docs
2022-11-07 16:04:54 -05:00
Nancy Butler 93d0a24258 initial plugins docs
move stuff
2022-11-01 08:38:32 -07:00
Giuseppe Leo a3b6e0becb
Clarify E2E setup docs (#7228) 2022-10-27 11:13:07 +02:00