Skip to content

Commit

Permalink
Merge branch 'main' into Reuse-Migration-TOML-Branch
Browse files Browse the repository at this point in the history
  • Loading branch information
ajinkyapatil8190 authored Feb 23, 2025
2 parents f66d1e4 + bd430b1 commit 13c234c
Show file tree
Hide file tree
Showing 34 changed files with 545 additions and 411 deletions.
18 changes: 0 additions & 18 deletions .github/workflows/licenses.yml

This file was deleted.

6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Portal UI Library

![Build Status](https://github.com/openmfp/portal-ui-lib/actions/workflows/pipeline.yaml/badge.svg)
[![REUSE status](
https://api.reuse.software/badge/github.com/openmfp/portal-ui-lib)](https://api.reuse.software/info/github.com/openmfp/portal-ui-lib)

This library helps you to set up your angular project consuming [Luigi](https://luigi-project.io/) configuration.

Main features of this library are:
Expand Down Expand Up @@ -635,5 +639,5 @@ Please refer to the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file in this reposi

## Licensing

Copyright 2024 SAP SE or an SAP affiliate company and openMFP contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/openmfp/portal-ui-lib).
Copyright 2025 SAP SE or an SAP affiliate company and openMFP contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/openmfp/portal-ui-lib).

2 changes: 1 addition & 1 deletion REUSE.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ SPDX-PackageDownloadLocation = "https://github.com/openmfp/portal-ui-lib"
[[annotations]]
path = "**"
precedence = "aggregate"
SPDX-FileCopyrightText = "2024 SAP SE or an SAP affiliate company and openMFP contributors and portal-ui-lib contributors."
SPDX-FileCopyrightText = "2025 SAP SE or an SAP affiliate company and openMFP contributors and portal contributors."
SPDX-License-Identifier = "Apache-2.0"
8 changes: 4 additions & 4 deletions docs/readme-nodes-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ To create a micro frontend that is displayed in the portal, you need to create a

This file is picked up by the deployed portal server at runtime therefore the file needs to be reachable from the domain the portal server is deployed on.
The registration to the portal happens through the portals Extension mechanism.
Technically an Extension is a Custom Resource Definition of Kuberenetes.
Its a dedicated resource in the Kuberentes cluster and this resource contains the URL to the `content-configuration.json` file of your application.
Technically an Extension is a Custom Resource Definition of Kubernetes.
It is a dedicated resource in the Kubernetes cluster and this resource contains the URL to the `content-configuration.json` file of your application.

## The Content Configuration File Contents

Expand Down Expand Up @@ -289,7 +289,7 @@ Further Portal specific parameters are supported on node level:

The following section explains Portal-specific parameters related to entity types:

- **entityType** - defines the location within the Portal navigation tree under which this node will be added. Currently, there are three **entityTypes** predefined in Portal: "global", "project" and "project.component". The **entityType** correlates with a particular route in Portal, so it defines the base route to which your micro frontends pathSegment is added.
- **entityType** - defines the location within the Portal navigation tree under which this node will be added. Currently, there is an **entityType** predefined in Portal: "global". The **entityType** correlates with a particular route in Portal, so it defines the base route to which your micro frontends pathSegment is added.
- Example ("global"): If the [pathSegment](https://docs.luigi-project.io/docs/navigation-configuration/?section=pathsegment) of the child node is `overview` and **entityType** is `global`, the node is shown in Portal's global navigation and the resulting route will be `/overview`.
- Example ("project"): A project has a dynamic URL part. If the child **pathSegment** is "overview" and the **entityType** is "project", the URL will be `/project/123ProjectId/overview`.
> NOTE: The **projectId** is available in the Luigi context object and can be retrieved by the micro frontend using the [initListener](https://docs.luigi-project.io/docs/luigi-client-api/?section=addinitlistener) / [contextUpdateListener](https://docs.luigi-project.io/docs/luigi-client-api/?section=addcontextupdatelistener).
Expand Down Expand Up @@ -338,7 +338,7 @@ The following section explains Portal-specific parameters related to entity type
```
Unlike the static example, here **dynamicFetchId** and **contextKey** are defined, so additional nodes will be fetched from the extension manager for this entity type.

For example, a route `/projects/123ProjectId/sample/123someId` will result in a request to extension manager with the following data:
For example, a route `/projects/123ProjectId/sample/123someId` will result in a request with the following data:

- Entity Type: `sample` - dynamicFetchId
- Entity Id: `123sampleId` - this value is retrieved from the node **context** object, specified by the `contextKey` property.
Expand Down
Loading

0 comments on commit 13c234c

Please sign in to comment.