From b829142caf190c071d4de7e8fc58a545f41ac2b1 Mon Sep 17 00:00:00 2001 From: juancarmore Date: Wed, 18 Dec 2024 15:32:17 +0100 Subject: [PATCH] openvidu-components-angular: Update links in documentation to use the latest version --- openvidu-components-angular/generate-docs.sh | 4 ++-- .../openvidu-components-angular/README.md | 4 ++-- .../dialogs/pro-feature-dialog.component.ts | 2 +- .../videoconference.component.ts | 2 +- .../openvidu-components-angular.directive.ts | 24 +++++++++---------- .../src/lib/pipes/translate.pipe.ts | 2 +- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/openvidu-components-angular/generate-docs.sh b/openvidu-components-angular/generate-docs.sh index 5201a22a..0c295d4d 100755 --- a/openvidu-components-angular/generate-docs.sh +++ b/openvidu-components-angular/generate-docs.sh @@ -6,7 +6,7 @@ if [[ -z "$BASEHREF_VERSION" ]]; then fi # Replace version from "stable" to the specified one in all TypeDoc links -grep -rl '/en/stable/' projects src | xargs sed -i -e 's|/en/stable/|/en/'${BASEHREF_VERSION}'/|g' +grep -rl '/latest/' projects src | xargs sed -i -e 's|/latest/|/'${BASEHREF_VERSION}'/|g' # Replace testapp README by openvidu-components-angular README mv README.md README-testapp.md @@ -16,7 +16,7 @@ cp ./projects/openvidu-components-angular/README.md . npm run doc:build # Return links to "stable" version -grep -rl '/en/'${BASEHREF_VERSION}'/' projects src | xargs sed -i -e 's|/en/'${BASEHREF_VERSION}'/|/en/stable/|g' +grep -rl '/'${BASEHREF_VERSION}'/' projects src | xargs sed -i -e 's|/'${BASEHREF_VERSION}'/|/latest/|g' # Undo changes with READMEs rm README.md diff --git a/openvidu-components-angular/projects/openvidu-components-angular/README.md b/openvidu-components-angular/projects/openvidu-components-angular/README.md index 235167ef..6bfd831c 100644 --- a/openvidu-components-angular/projects/openvidu-components-angular/README.md +++ b/openvidu-components-angular/projects/openvidu-components-angular/README.md @@ -8,7 +8,7 @@ Angular Components are the simplest way to create real-time videoconferencing ap ## Getting Started -To get started with OpenVidu Components Angular, visit our [**Getting Started guide**](https://openvidu.io/docs/ui-components/angular-components/). +To get started with OpenVidu Components Angular, visit our [**Getting Started guide**](https://openvidu.io/latest/docs/ui-components/angular-components/). 1. Create an Angular Project (>= 17.0.0) @@ -92,7 +92,7 @@ You can also customize the styles in your `styles.scss` file: ## API Documentation -For detailed information on OpenVidu Angular Components, refer to our [**API Reference**](https://openvidu.io/docs/reference-docs/openvidu-components-angular). +For detailed information on OpenVidu Angular Components, refer to our [**API Reference**](https://openvidu.io/latest/docs/reference-docs/openvidu-components-angular/). ## Support diff --git a/openvidu-components-angular/projects/openvidu-components-angular/src/lib/components/dialogs/pro-feature-dialog.component.ts b/openvidu-components-angular/projects/openvidu-components-angular/src/lib/components/dialogs/pro-feature-dialog.component.ts index edb47a75..5b303644 100644 --- a/openvidu-components-angular/projects/openvidu-components-angular/src/lib/components/dialogs/pro-feature-dialog.component.ts +++ b/openvidu-components-angular/projects/openvidu-components-angular/src/lib/components/dialogs/pro-feature-dialog.component.ts @@ -29,6 +29,6 @@ export class ProFeatureDialogTemplateComponent { } seeMore() { - window.open('https://docs.openvidu.io/en/stable/openvidu-pro/', '_blank')?.focus(); + window.open('https://openvidu.io/pricing/#openvidu-pro', '_blank')?.focus(); } } diff --git a/openvidu-components-angular/projects/openvidu-components-angular/src/lib/components/videoconference/videoconference.component.ts b/openvidu-components-angular/projects/openvidu-components-angular/src/lib/components/videoconference/videoconference.component.ts index dddcfd03..b2ae2a7c 100644 --- a/openvidu-components-angular/projects/openvidu-components-angular/src/lib/components/videoconference/videoconference.component.ts +++ b/openvidu-components-angular/projects/openvidu-components-angular/src/lib/components/videoconference/videoconference.component.ts @@ -330,7 +330,7 @@ export class VideoconferenceComponent implements OnInit, OnDestroy, AfterViewIni /** * Provides event notifications that fire when OpenVidu Room is created. - * It provides the {@link https://openvidu.io/docs/getting-started/#room Room} payload as event data. + * It provides the {@link https://openvidu.io/latest/docs/getting-started/#room Room} payload as event data. */ @Output() onRoomCreated: EventEmitter = new EventEmitter(); diff --git a/openvidu-components-angular/projects/openvidu-components-angular/src/lib/directives/template/openvidu-components-angular.directive.ts b/openvidu-components-angular/projects/openvidu-components-angular/src/lib/directives/template/openvidu-components-angular.directive.ts index e0fb18ee..b914ad9d 100644 --- a/openvidu-components-angular/projects/openvidu-components-angular/src/lib/directives/template/openvidu-components-angular.directive.ts +++ b/openvidu-components-angular/projects/openvidu-components-angular/src/lib/directives/template/openvidu-components-angular.directive.ts @@ -116,7 +116,7 @@ import { Directive, TemplateRef, ViewContainerRef } from '@angular/core'; * ``` * * - * You can run the associated tutorial [here](https://docs.openvidu.io/en/stable/components/openvidu-custom-toolbar). + * You can run the associated tutorial [here](https://openvidu.io/latest/docs/tutorials/angular-components/openvidu-custom-toolbar/). */ @Directive({ selector: '[ovToolbar]' @@ -254,7 +254,7 @@ export class ToolbarDirective { * ``` * * - * To follow a step-by-step tutorial on this feature, please visit [this link](https://docs.openvidu.io/en/stable/components/openvidu-toolbar-buttons). + * To follow a step-by-step tutorial on this feature, please visit [this link](https://openvidu.io/latest/docs/tutorials/angular-components/openvidu-toolbar-buttons/). */ @Directive({ @@ -377,7 +377,7 @@ export class ToolbarAdditionalButtonsDirective { * ``` * * - * You can run the associated tutorial [here](https://docs.openvidu.io/en/stable/components/openvidu-toolbar-panel-buttons). + * You can run the associated tutorial [here](https://openvidu.io/latest/docs/tutorials/angular-components/openvidu-toolbar-panel-buttons/). */ @Directive({ selector: '[ovToolbarAdditionalPanelButtons]' @@ -526,7 +526,7 @@ export class ToolbarAdditionalPanelButtonsDirective { * * * - * For a comprehensive tutorial on implementing custom panels, please refer to the associated guide [here](https://docs.openvidu.io/en/stable/components/openvidu-custom-panels). + * For a comprehensive tutorial on implementing custom panels, please refer to the associated guide [here](https://openvidu.io/latest/docs/tutorials/angular-components/openvidu-custom-panels/). */ @Directive({ selector: '[ovPanel]' @@ -712,7 +712,7 @@ export class PanelDirective { * ``` * * - * For detailed instructions, refer to the tutorial available [here](https://docs.openvidu.io/en/stable/components/openvidu-additional-panels). + * For detailed instructions, refer to the tutorial available [here](https://openvidu.io/latest/docs/tutorials/angular-components/openvidu-additional-panels/). */ @Directive({ selector: '[ovAdditionalPanels]' @@ -889,7 +889,7 @@ export class AdditionalPanelsDirective { * * * For a step-by-step tutorial on how to replace the chat template with just a few lines of code, - * check out our comprehensive guide: [Customizing the Chat Panel](https://docs.openvidu.io/en/stable/components/openvidu-custom-chat-panel). + * check out our comprehensive guide: [Customizing the Chat Panel](https://openvidu.io/latest/docs/tutorials/angular-components/openvidu-custom-chat-panel/). */ @Directive({ selector: '[ovChatPanel]' @@ -1015,7 +1015,7 @@ export class BackgroundEffectsPanelDirective { * * * For a step-by-step tutorial on how to replace the activities template with just a few lines of code, - * check out our comprehensive guide: [Customizing the Activities Panel](https://docs.openvidu.io/en/stable/components/openvidu-custom-activities-panel). + * check out our comprehensive guide: [Customizing the Activities Panel](https://openvidu.io/latest/docs/tutorials/angular-components/openvidu-custom-activities-panel/). */ @Directive({ selector: '[ovActivitiesPanel]' @@ -1184,7 +1184,7 @@ export class ActivitiesPanelDirective { * ``` * * - * For a comprehensive tutorial on customizing the participants panel, please visit [this link](https://docs.openvidu.io/en/stable/components/openvidu-custom-participants-panel). + * For a comprehensive tutorial on customizing the participants panel, please visit [this link](https://openvidu.io/latest/docs/tutorials/angular-components/openvidu-custom-participants-panel/). */ @Directive({ @@ -1321,7 +1321,7 @@ export class ParticipantsPanelDirective { * ``` * * - * For a detailed tutorial on customizing participant panel items, please visit [this link](https://docs.openvidu.io/en/stable/components/openvidu-custom-participant-panel-item). + * For a detailed tutorial on customizing participant panel items, please visit [this link](https://openvidu.io/latest/docs/tutorials/angular-components/openvidu-custom-participant-panel-item/). */ @Directive({ @@ -1463,7 +1463,7 @@ export class ParticipantPanelItemDirective { * ``` * * - * For a comprehensive tutorial on adding elements to participant panel items, please visit [this link](https://docs.openvidu.io/en/stable/components/openvidu-custom-participant-panel-item-elements). + * For a comprehensive tutorial on adding elements to participant panel items, please visit [this link](https://openvidu.io/latest/docs/tutorials/angular-components/openvidu-custom-participant-panel-item-element/). */ @Directive({ @@ -1659,7 +1659,7 @@ export class ParticipantPanelItemElementsDirective { * * * - * For a comprehensive guide on implementing custom layouts, please refer to the associated tutorial [here](https://docs.openvidu.io/en/stable/components/openvidu-custom-layout). + * For a comprehensive guide on implementing custom layouts, please refer to the associated tutorial [here](https://openvidu.io/latest/docs/tutorials/angular-components/openvidu-custom-layout/). */ @Directive({ selector: '[ovLayout]' @@ -1789,7 +1789,7 @@ export class LayoutDirective { * ``` * * - * For a detailed tutorial on customizing the stream component, please visit [this link](https://docs.openvidu.io/en/stable/components/openvidu-custom-stream). + * For a detailed tutorial on customizing the stream component, please visit [this link](https://openvidu.io/latest/docs/tutorials/angular-components/openvidu-custom-stream/). */ @Directive({ diff --git a/openvidu-components-angular/projects/openvidu-components-angular/src/lib/pipes/translate.pipe.ts b/openvidu-components-angular/projects/openvidu-components-angular/src/lib/pipes/translate.pipe.ts index b3691d59..41e88f93 100644 --- a/openvidu-components-angular/projects/openvidu-components-angular/src/lib/pipes/translate.pipe.ts +++ b/openvidu-components-angular/projects/openvidu-components-angular/src/lib/pipes/translate.pipe.ts @@ -13,7 +13,7 @@ export class TranslatePipe implements PipeTransform { if (translation?.includes('OpenVidu PRO')) { return translation.replace( 'OpenVidu PRO', - 'OpenVidu PRO' + 'OpenVidu PRO' ); } return translation;