From 21f0f35b48de725bfb6beb7725a482a1fb5afc3c Mon Sep 17 00:00:00 2001 From: ismailbennani Date: Thu, 24 Apr 2025 18:34:08 +0200 Subject: [PATCH 1/2] feat: add link to documentation in editor --- .../components/editor-menu/editor-about-menu.component.ts | 6 ++++++ .../src/environments/environment.development.ts | 1 + .../src/environments/environment.types.ts | 1 + 3 files changed, 8 insertions(+) diff --git a/src/FacturXDotNet.WebEditor/src/app/features/editor/components/editor-menu/editor-about-menu.component.ts b/src/FacturXDotNet.WebEditor/src/app/features/editor/components/editor-menu/editor-about-menu.component.ts index 556ec683..528ca73e 100644 --- a/src/FacturXDotNet.WebEditor/src/app/features/editor/components/editor-menu/editor-about-menu.component.ts +++ b/src/FacturXDotNet.WebEditor/src/app/features/editor/components/editor-menu/editor-about-menu.component.ts @@ -1,6 +1,7 @@ import { Component, input } from '@angular/core'; import { RouterLink } from '@angular/router'; import { NgbDropdown, NgbDropdownItem, NgbDropdownMenu, NgbDropdownToggle } from '@ng-bootstrap/ng-bootstrap'; +import { environment } from '../../../../../environments/environment'; @Component({ selector: 'app-editor-about-menu', @@ -9,6 +10,9 @@ import { NgbDropdown, NgbDropdownItem, NgbDropdownMenu, NgbDropdownToggle } from
  • + @if (documentationUrl !== undefined) { + Documentation + } @if (showSelfHostingMenu()) { } @@ -19,4 +23,6 @@ import { NgbDropdown, NgbDropdownItem, NgbDropdownMenu, NgbDropdownToggle } from }) export class EditorAboutMenuComponent { showSelfHostingMenu = input(false); + + protected documentationUrl: string | undefined = environment.documentationUrl; } diff --git a/src/FacturXDotNet.WebEditor/src/environments/environment.development.ts b/src/FacturXDotNet.WebEditor/src/environments/environment.development.ts index 59183309..13c305bc 100644 --- a/src/FacturXDotNet.WebEditor/src/environments/environment.development.ts +++ b/src/FacturXDotNet.WebEditor/src/environments/environment.development.ts @@ -4,4 +4,5 @@ export const environment: Environment = { version: '~dev', buildDate: new Date(), apiUrl: 'http://localhost:5295', + documentationUrl: 'https://docs.facturxdotnet.org', }; diff --git a/src/FacturXDotNet.WebEditor/src/environments/environment.types.ts b/src/FacturXDotNet.WebEditor/src/environments/environment.types.ts index 8168c08d..ffeb1838 100644 --- a/src/FacturXDotNet.WebEditor/src/environments/environment.types.ts +++ b/src/FacturXDotNet.WebEditor/src/environments/environment.types.ts @@ -2,4 +2,5 @@ export interface Environment { version: string; buildDate: Date; apiUrl: string; + documentationUrl?: string; } From 4b2f596df6eedf0ccd5e07181564e03c49c5b824 Mon Sep 17 00:00:00 2001 From: ismailbennani Date: Thu, 24 Apr 2025 18:36:06 +0200 Subject: [PATCH 2/2] update CI --- .github/workflows/reusable-build-deploy-api-editor-docs.yml | 1 + .github/workflows/reusable-build-editor-application.yml | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/.github/workflows/reusable-build-deploy-api-editor-docs.yml b/.github/workflows/reusable-build-deploy-api-editor-docs.yml index 19fd5e5a..1b3079ef 100644 --- a/.github/workflows/reusable-build-deploy-api-editor-docs.yml +++ b/.github/workflows/reusable-build-deploy-api-editor-docs.yml @@ -42,6 +42,7 @@ jobs: uses: ./.github/workflows/reusable-build-editor-application.yml with: artifact-name: editor + documentation-url: https://${{ inputs.build-name }}.facturxdotnet.org/docs api-url: https://${{ inputs.build-name }}.facturxdotnet.org/api version: ${{ needs.compute-version.outputs.version }} diff --git a/.github/workflows/reusable-build-editor-application.yml b/.github/workflows/reusable-build-editor-application.yml index 31c7f52e..b9574c4c 100644 --- a/.github/workflows/reusable-build-editor-application.yml +++ b/.github/workflows/reusable-build-editor-application.yml @@ -13,6 +13,11 @@ on: type: string required: true + documentation-url: + description: The URL at which the FacturX.NET Documentation will be served + type: string + required: true + version: description: The version of the application type: string @@ -50,6 +55,7 @@ jobs: echo " version: '${{ inputs.version }}'," >> src/environments/environment.ts echo " buildDate: new Date('$(date +'%Y-%m-%d')')," >> src/environments/environment.ts echo " apiUrl: '${{ inputs.api-url }}'," >> src/environments/environment.ts + echo " documentationUrl: '${{ inputs.documentation-url }}'," >> src/environments/environment.ts echo "};" >> src/environments/environment.ts echo "Environment is" cat src/environments/environment.ts