ambiser
/
openvidu
mirror of https://github.com/OpenVidu/openvidu.git
8
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

openvidu-components-angular: Update links in documentation to use the latest version

dependabot/npm_and_yarn/openvidu-components-angular/multi-f2b383cc78
juancarmore 2024-12-18 15:32:17 +01:00
parent dead4853aa
commit b829142caf
6 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
openvidu-components-angular/generate-docs.sh
View File

@ -6,7 +6,7 @@ if [[ -z "$BASEHREF_VERSION" ]]; then
fi fi
# Replace version from "stable" to the specified one in all TypeDoc links # 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 # Replace testapp README by openvidu-components-angular README
mv README.md README-testapp.md mv README.md README-testapp.md
@ -16,7 +16,7 @@ cp ./projects/openvidu-components-angular/README.md .
npm run doc:build npm run doc:build
# Return links to "stable" version # 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 # Undo changes with READMEs
rm README.md rm README.md

4
openvidu-components-angular/projects/openvidu-components-angular/README.md
View File

@ -8,7 +8,7 @@ Angular Components are the simplest way to create real-time videoconferencing ap
## Getting Started ## 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) 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 ## 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 ## Support

2
openvidu-components-angular/projects/openvidu-components-angular/src/lib/components/dialogs/pro-feature-dialog.component.ts
View File

@ -29,6 +29,6 @@ export class ProFeatureDialogTemplateComponent {
} }
seeMore() { seeMore() {
window.open('https://docs.openvidu.io/en/stable/openvidu-pro/', '_blank')?.focus(); window.open('https://openvidu.io/pricing/#openvidu-pro', '_blank')?.focus();
} }
} }

2
openvidu-components-angular/projects/openvidu-components-angular/src/lib/components/videoconference/videoconference.component.ts
View File

@ -330,7 +330,7 @@ export class VideoconferenceComponent implements OnInit, OnDestroy, AfterViewIni
/** /**
* Provides event notifications that fire when OpenVidu Room is created. * 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<Room> = new EventEmitter<Room>(); @Output() onRoomCreated: EventEmitter<Room> = new EventEmitter<Room>();

24
openvidu-components-angular/projects/openvidu-components-angular/src/lib/directives/template/openvidu-components-angular.directive.ts
View File

@ -116,7 +116,7 @@ import { Directive, TemplateRef, ViewContainerRef } from '@angular/core';
* ``` * ```
* <!--ovToolbar-end-tutorial--> * <!--ovToolbar-end-tutorial-->
* *
* 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({ @Directive({
selector: '[ovToolbar]' selector: '[ovToolbar]'
@ -254,7 +254,7 @@ export class ToolbarDirective {
* ``` * ```
* <!--ovToolbarAdditionalButtons-end-tutorial--> * <!--ovToolbarAdditionalButtons-end-tutorial-->
* *
* 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({ @Directive({
@ -377,7 +377,7 @@ export class ToolbarAdditionalButtonsDirective {
* ``` * ```
* <!--ovToolbarAdditionalPanelButtons-end-tutorial--> * <!--ovToolbarAdditionalPanelButtons-end-tutorial-->
* *
* 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({ @Directive({
selector: '[ovToolbarAdditionalPanelButtons]' selector: '[ovToolbarAdditionalPanelButtons]'
@ -526,7 +526,7 @@ export class ToolbarAdditionalPanelButtonsDirective {
* <!--ovPanel-end-tutorial--> * <!--ovPanel-end-tutorial-->
* *
* *
* 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({ @Directive({
selector: '[ovPanel]' selector: '[ovPanel]'
@ -712,7 +712,7 @@ export class PanelDirective {
* ``` * ```
* <!--ovAdditionalPanels-end-tutorial--> * <!--ovAdditionalPanels-end-tutorial-->
* *
* 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({ @Directive({
selector: '[ovAdditionalPanels]' 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, * 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({ @Directive({
selector: '[ovChatPanel]' selector: '[ovChatPanel]'
@ -1015,7 +1015,7 @@ export class BackgroundEffectsPanelDirective {
* <!--ovActivitiesPanel-end-tutorial--> * <!--ovActivitiesPanel-end-tutorial-->
* *
* For a step-by-step tutorial on how to replace the activities template with just a few lines of code, * 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({ @Directive({
selector: '[ovActivitiesPanel]' selector: '[ovActivitiesPanel]'
@ -1184,7 +1184,7 @@ export class ActivitiesPanelDirective {
* ``` * ```
* <!--ovParticipantsPanel-end-tutorial--> * <!--ovParticipantsPanel-end-tutorial-->
* *
* 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({ @Directive({
@ -1321,7 +1321,7 @@ export class ParticipantsPanelDirective {
* ``` * ```
* <!--ovParticipantPanelItem-end-tutorial--> * <!--ovParticipantPanelItem-end-tutorial-->
* *
* 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({ @Directive({
@ -1463,7 +1463,7 @@ export class ParticipantPanelItemDirective {
* ``` * ```
* <!--ovParticipantPanelItemElements-end-tutorial--> * <!--ovParticipantPanelItemElements-end-tutorial-->
* *
* 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({ @Directive({
@ -1659,7 +1659,7 @@ export class ParticipantPanelItemElementsDirective {
* <!--ovLayout-end-tutorial--> * <!--ovLayout-end-tutorial-->
* *
* *
* 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({ @Directive({
selector: '[ovLayout]' selector: '[ovLayout]'
@ -1789,7 +1789,7 @@ export class LayoutDirective {
* ``` * ```
* <!--ovStream-end-tutorial--> * <!--ovStream-end-tutorial-->
* *
* 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({ @Directive({

2
openvidu-components-angular/projects/openvidu-components-angular/src/lib/pipes/translate.pipe.ts
View File

@ -13,7 +13,7 @@ export class TranslatePipe implements PipeTransform {
if (translation?.includes('OpenVidu PRO')) { if (translation?.includes('OpenVidu PRO')) {
return translation.replace( return translation.replace(
'OpenVidu PRO', 'OpenVidu PRO',
'<a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank">OpenVidu PRO</a>' '<a href="https://openvidu.io/pricing/#openvidu-pro" target="_blank">OpenVidu PRO</a>'
); );
} }
return translation; return translation;