fantonangeli commented on code in PR #3261:
URL:
https://github.com/apache/incubator-kie-tools/pull/3261#discussion_r2316432078
##########
packages/kogito-data-index-webapp/README.md:
##########
@@ -0,0 +1,18 @@
+## Build
Review Comment:
```suggestion
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
# Kogito Data Index Webapp
This package contains the webapp for the Data Index endpoint
## Build
```
##########
packages/kogito-jobs-service-webapp/README.md:
##########
@@ -0,0 +1,20 @@
+## Build
Review Comment:
```suggestion
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
# Kogito Jobs Service Webapp
This package contains the webapp for the Jobs Service endpoint
## Build
```
##########
packages/kogito-jobs-service-webapp/README.md:
##########
@@ -0,0 +1,20 @@
+## Build
+
+- The image name and tags can be customized by setting the following
environment variables:
+
+ ```bash
+ export KOGITO_JOBS_SERVICE_WEBAPP_title=<title>
+ export KOGITO_JOBS_SERVICE_WEBAPP_logo=<logo>
+ export KOGITO_JOBS_SERVICE_WEBAPP_docLinkHref=<docLinkHref>
+ export KOGITO_JOBS_SERVICE_WEBAPP_docLinkText=<docLinkText>
+ export SONATAFLOW_JOBS_SERVICE_WEBAPP_docLinkHref=<docLinkHref>
+ export SONATAFLOW_JOBS_SERVICE_WEBAPP_docLinkText=<docLinkText>
+ ```
+
+ > Default values can be found [here](./env/index.js).
+
+- After optionally setting up the environment variables, run the following in
the root folder of the repository to build the package:
+
+ ```bash
+ pnpm -F @kie-tools/kogito-jobs-service-webapp... build:prod
+ ```
Review Comment:
GH doesn't allow me to suggest over a line with 3 backticks.
Please add this to the bottom of this file to be compliant with Apache
guidelines:
```
---
Apache KIE (incubating) is an effort undergoing incubation at The Apache
Software
Foundation (ASF), sponsored by the name of Apache Incubator. Incubation is
required of all newly accepted projects until a further review indicates that
the infrastructure, communications, and decision making process have
stabilized
in a manner consistent with other successful ASF projects. While incubation
status is not necessarily a reflection of the completeness or stability of
the
code, it does indicate that the project has yet to be fully endorsed by the
ASF.
Some of the incubating project’s releases may not be fully compliant with ASF
policy. For example, releases may have incomplete or un-reviewed licensing
conditions. What follows is a list of known issues the project is currently
aware of (note that this list, by definition, is likely to be incomplete):
- Hibernate, an LGPL project, is being used. Hibernate is in the process of
relicensing to ASL v2
- Some files, particularly test files, and those not supporting comments, may
be missing the ASF Licensing Header
If you are planning to incorporate this work into your product/project,
please
be aware that you will need to conduct a thorough licensing review to
determine
the overall implications of including this work. For the current status of
this
project through the Apache Incubator visit:
https://incubator.apache.org/projects/kie.html
```
##########
packages/kogito-data-index-webapp/README.md:
##########
@@ -0,0 +1,18 @@
+## Build
+
+- The image name and tags can be customized by setting the following
environment variables:
+
+ ```bash
+ export KOGITO_DATA_INDEX_WEBAPP_title=<title>
+ export KOGITO_DATA_INDEX_WEBAPP_logo=<logo>
+ export KOGITO_DATA_INDEX_WEBAPP_docLinkHref=<docLinkHref>
+ export KOGITO_DATA_INDEX_WEBAPP_docLinkText=<docLinkText>
+ ```
+
+ > Default values can be found [here](./env/index.js).
+
+- After optionally setting up the environment variables, run the following in
the root folder of the repository to build the package:
+
+ ```bash
+ pnpm -F @kie-tools/kogito-data-index-webapp... build:prod
+ ```
Review Comment:
GH doesn't allow me to suggest over a line with 3 backticks.
Please add this to the bottom of this file to be compliant with Apache
guidelines:
```
---
Apache KIE (incubating) is an effort undergoing incubation at The Apache
Software
Foundation (ASF), sponsored by the name of Apache Incubator. Incubation is
required of all newly accepted projects until a further review indicates that
the infrastructure, communications, and decision making process have
stabilized
in a manner consistent with other successful ASF projects. While incubation
status is not necessarily a reflection of the completeness or stability of
the
code, it does indicate that the project has yet to be fully endorsed by the
ASF.
Some of the incubating project’s releases may not be fully compliant with ASF
policy. For example, releases may have incomplete or un-reviewed licensing
conditions. What follows is a list of known issues the project is currently
aware of (note that this list, by definition, is likely to be incomplete):
- Hibernate, an LGPL project, is being used. Hibernate is in the process of
relicensing to ASL v2
- Some files, particularly test files, and those not supporting comments, may
be missing the ASF Licensing Header
If you are planning to incorporate this work into your product/project,
please
be aware that you will need to conduct a thorough licensing review to
determine
the overall implications of including this work. For the current status of
this
project through the Apache Incubator visit:
https://incubator.apache.org/projects/kie.html
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
