Commit Graph

119 Commits

Author SHA1 Message Date
Eric Promislow 90859a2a66
Remove a stutter in the sentence. (#12742) 2024-12-03 11:13:40 -08:00
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
Richard Cox 4e5ef98ff5
Merge pull request #12483 from richard-cox/e2e-doc-update
Update e2e docs
2024-11-04 17:58:41 +01: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 a3b1be9b36 Update e2e docs 2024-11-04 09:44:53 +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
Richard Cox 8a7b5c8e57
Merge pull request #11897 from richard-cox/e2e-docs-update
Improve e2e docs on PO usages
2024-09-24 12:01:52 +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
Richard Cox 8ed524f922 Improve e2e docs on PO usages 2024-09-12 10:18:57 +01:00
Corentin Néau 133964241f
Fix running dashboard link
`Running the Dashboard` now points to the `Quickstart` section, where
relevant instructions live.
2024-09-06 17:02:51 +02:00
Corentin Néau 1c71605a0f
Make Rancher installation instructions version-agnostic
Documentation now recommends using a version-agnostic tag and provides
a link for checking the most recent ones.
2024-09-06 16:53:53 +02:00
Corentin Néau 6cab691bcd
Update documented latest Rancher version to 2.9
Tag `v2.6-head` no longer points to a recent Rancher commit.
2024-09-06 16:33:33 +02: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
Mo Mesgin d65d82f6a0 Merge branch 'master' of github.com:momesgin/dashboard into 10740-update-docs 2024-07-26 12:48:15 -07:00
Silvio Moioli ba23ca6811 Remove unnecessary lines 2024-07-26 13:26:27 +01:00
Silvio Moioli ec6829f764 quickstart: document a known failure case and workaround 2024-07-26 13:26:27 +01:00
Mo Mesgin 0a7edd1aea update docs link, revert some of the removed text 2024-07-19 10:58:02 -07:00
Mo Mesgin 77bdeb3d8a update first login docs to refer to rancher documentation 2024-07-17 12:09:12 -07: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
Giuseppe Leo c36b071e40
Remove every reference to .nuxt global option (#11265)
* Remove unused rehydratation plugin

* Remove any reference to the .nuxt folders

* Remove globalApp nuxt and any reference or use case to nuxt.error

* Replace errors handling with existing fail-whale logic
2024-06-21 11:15:05 +02: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
Izaac Zavaleta a19883566a
Merge pull request #10901 from yonasberhe23/update_docs
update developer docs
2024-05-08 11:00:48 -07:00
Neil MacDougall f5431cbbaf
Add i18n string usage checker script (#10805)
* Add i18n string usage checker script

* Fix lint issues

* Add i18n check to GH Action workflow

* Update to node 16

* Update workflow to run script properly

* Allow script to return okay if when there are errors

* Add documentation

* Remove commented code
2024-05-02 20:52:15 +01:00
Yonas Berhe 95a227823c update developer docs 2024-04-30 09:51:17 -07:00
Francesco Torchia f13cf9aed0
Add e2e @components tag
Signed-off-by: Francesco Torchia <francesco.torchia@suse.com>
2024-02-14 15:50:58 +01:00
Richard Cox c510161796 Tidy up docs related to build
- remove reference to Dockerfile.dev
- move unsupported build steps from public docs to repo docs
- add unsupported info to other files in repo docs
2024-02-06 08:59:32 +00:00
Cody Jackson 48e1b0b3bb Layout removal
fixes #10059
2024-01-22 06:30:17 -07:00
Alexandre Alves 6637583874
remove "process." mentions from Dashboard and adjust code (#10119)
* remove process.client and process.server mentions and adjust code

* fix a couple of missing conditions for process.server

* remove commented line

* remove process.static

* fix lint errors

* uncomment code

---------

Co-authored-by: Alexandre Alves <aalves@Alexandres-MacBook-Pro.local>
2023-12-13 08:41:26 +00:00
Giuseppe Leo e92b03943b
E2E job parallelization by user role and functionality (#9887)
* Create matrix for E2E job

* Create utility for mapping skipped tests for given dirs

* Allow to filter any dir for given env vars

Add Rancher setup phase in test CI

Restore skip setup variable for other checks

* Cypress config cleanup

* Avoid use of tags for setup test

Add setup tag

* Add specs dir to the matrix

Correct matrix to use each role

Add tag prefix on command

* Correct coverage path

* Simplify cypress utility

* Implement only env var filtering logic

Update env var filtering with a menageable definition

Update CI to filter paths by new logic

Reorganize tests file tree

Add tags for each section

Combine roles and features specs

Update new specs to the tag format

Grouping tags

Fix issues with specs and admin spec/username for login parallelization

Fix issue pre-pending @ character

Remove coupling

Remove Docker stop

Enable all the tests in groups

Allow E2E matrix to fail with strategy flag fail-fast

* Add role for setup in combination to features

* Change tag AND to OR (space instead plus)

* Exclude non tagged tests instead of skip

* Correct standard user name

* Use object for matrix definition; Restore usernames for tests; Remove hackish tag for role

* Pair matrix role tag to multiple matrix features

* Disable failing tests

* Move diagnostic from extension to generic

* Remove build dashboard flag for setup

* Correct screenshot naming to match coverage file naming

* Move Cypress utils out of shell

* Remove View API check for fleet

* Add documentation

* Update skip logic and documentation

* Update env template
2023-12-12 13:07:54 +01:00
Jordon Leach c526e46058
Move dashboard container build to internal documentation (#10113) 2023-12-05 12:32:42 -05:00
Richard Cox 7730c6f240 Move API docs out of docusaurus 2023-11-24 10:34:32 +00: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
Mo Mesgin 768a8f74bf changed docs version from 2.7 to 2.8 2023-10-06 17:53:13 -07:00
Mo Mesgin 2c4e700a5a updated docs urls 2023-10-04 11:44:45 -07:00