feat: add link to documentation in editor

.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 }}
 

.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

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
     <li class="nav-item" ngbDropdown>
       <button id="editor-about-menu" class="nav-link px-4 text-light" ngbDropdownToggle>About</button>
       <div ngbDropdownMenu aria-labelledby="editor-about-menu">
+        @if (documentationUrl !== undefined) {
+          <a [href]="documentationUrl" target="_blank" ngbDropdownItem>Documentation</a>
+        }
         @if (showSelfHostingMenu()) {
           <button ngbDropdownItem>Self-hosting</button>
         }
@@ -19,4 +23,6 @@ import { NgbDropdown, NgbDropdownItem, NgbDropdownMenu, NgbDropdownToggle } from
 })
 export class EditorAboutMenuComponent {
   showSelfHostingMenu = input<boolean>(false);
+
+  protected documentationUrl: string | undefined = environment.documentationUrl;
 }

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',
 };

src/FacturXDotNet.WebEditor/src/environments/environment.types.ts

@@ -2,4 +2,5 @@ export interface Environment {
   version: string;
   buildDate: Date;
   apiUrl: string;
+  documentationUrl?: string;
 }