Commit Graph

176 Commits

Author SHA1 Message Date
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
Cody Jackson 3c200bb35d Pinning the sub-dependency cheerio to a version that works with our builds
Docusaurus had a sub-depency on cheerio "^1.0.0-rc.12". Cheerio just released version 1.0.0 which requires node 18 or greater. I pinned the version to what we previously had.

We can unpin this once we upgrade our node version. Likely after vue3.
2024-08-13 08:46:55 -07: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
Neil MacDougall 136ae6ad78
Fix broken links on readme and docs homepage (#11161)
* Fix broken links on readme and docs homepage

* Fix lint
2024-06-03 17:37:27 +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
Neil MacDougall 3451cdd287
Extensions docs: Add cname to gh-pages branch (#11007)
* Trying a different URL

* Add CNAME to the gh-pages branch

* Update docusaurus.yaml
2024-05-10 19:13:51 +01:00
Neil MacDougall ad648104ca
Trying a different URL (#11006) 2024-05-10 18:16:54 +01:00
Alexandre Alves a18e6bff25
revert url change (#11004) 2024-05-10 17:08:40 +01:00
Neil MacDougall 52bc23bca6
Update docusaurus for extensions domain (#11002) 2024-05-10 15:50:52 +01: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
Richard Cox 411a9bf8e8 Changes following review 2024-04-26 13:32:22 +01:00
Richard Cox e3143f6164 Port drone build tasks to gh workflows + actions
- Remove old drone build tasks (note - FOSSA will not be ported at this time, discussed in slack)
- create generic setup composit action which can be used by multiple workflows
- create generic lint, i18n-lint and unittest composit action which can be used by multiple workflows
- create generic build-and-upload workflow which can be used by multiple workflows
- trigger build-and-upload on merge to specific branch (TBD)
- trigger build-and-upload on specific tags

Also
- changed name of yarn install:ci as it was used outside of ci

Note
- I'd have liked to group together the workflows used by the build, but things like workflow subfolders
aren't supported
2024-04-25 13:45:11 +01: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 64f5d8b79f
revert change (#10217)
Co-authored-by: Alexandre Alves <aalves@Alexandres-MacBook-Pro.local>
2024-01-03 15:59:17 +00:00
Neil MacDougall 526a078678
Fix docusaurus build (#10204) 2024-01-02 15:26:16 +00:00