Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hpehl committed Nov 19, 2024
1 parent 4e63ec0 commit 14768b2
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 15 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# HAL Foundation

This repository contains the foundation for the next major version of the HAL management console and the upcoming OpenShift version halOS.
This repository contains the foundation for the next major version of the HAL management console (halOP) and the upcoming
OpenShift version halOS.

The work is in a very early state and very much in progress.

Expand All @@ -11,7 +12,7 @@ The work is in a very early state and very much in progress.
- [Crysknife CDI](https://github.com/crysknife-io/crysknife)
- [Elemento](https://github.com/hal/elemento)
- [PatternFly Java](https://github.com/patternfly-java)
- [Maven](https://maven.apache.org/) and [Parcel](https://parceljs.org/)
- [Maven](https://maven.apache.org/), [Parcel](https://parceljs.org/), and [NPM](https://www.npmjs.com/)

# Get Started

Expand All @@ -33,10 +34,12 @@ In another shell run

```shell
cd op/console
yarn run watch
npm run watch
```

This will open a browser at http://localhost:1234 and watch for changes to your HTML, CSS, JavaScript, and Java code. Each time a change is made, the browser reloads the page automatically.
This will open a browser at http://localhost:1234. Changes to HTML and CSS will be detected by Parcel, and the browser reloads
the page automatically. Changes to the Java code will be detected by the J2CL Maven plugin, but you need to reload the browser
manually.

## Production mode

Expand Down Expand Up @@ -66,7 +69,8 @@ to start it and open a browser at http://localhost:9090.

# Contributing

This is an open source project. That means that everybody can contribute. It's not hard to get started. So start [contributing](CONTRIBUTING.md) today!
This is an open source project. That means that everybody can contribute. It's not hard to get started. So
start [contributing](CONTRIBUTING.md) today!

# Licenses

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@
import org.jboss.hal.env.Environment;
import org.jboss.hal.meta.StatementContext;
import org.jboss.hal.model.deployment.Deployments;
import org.patternfly.layout.flex.Direction;
import org.patternfly.layout.flex.FlexItem;
import org.patternfly.layout.flex.Gap;

import elemental2.dom.HTMLElement;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
import org.jboss.hal.dmr.dispatch.Dispatcher;
import org.jboss.hal.meta.AddressTemplate;
import org.patternfly.component.icon.Icon;
import org.patternfly.style.Classes;

import elemental2.dom.HTMLDivElement;
import elemental2.dom.HTMLElement;
Expand All @@ -56,7 +55,6 @@
import static org.patternfly.icon.IconSets.fas.exclamationCircle;
import static org.patternfly.icon.IconSets.fas.exclamationTriangle;
import static org.patternfly.style.Classes.modifier;
import static org.patternfly.style.GridBreakpoint.none;
import static org.patternfly.style.Status.danger;
import static org.patternfly.style.Status.success;
import static org.patternfly.style.Status.warning;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@
*/
package org.jboss.hal.op.dashboard;

import org.jboss.hal.dmr.dispatch.Dispatcher;
import org.jboss.hal.env.Environment;
import org.patternfly.component.card.CardBody;

import elemental2.dom.HTMLElement;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@

import org.kie.j2cl.tools.processors.annotations.GWT3Resource;
import org.kie.j2cl.tools.processors.common.resources.ClientBundle;
import org.kie.j2cl.tools.processors.common.resources.ImageResource;
import org.kie.j2cl.tools.processors.common.resources.TextResource;

@GWT3Resource
Expand All @@ -27,4 +26,4 @@ public interface Assets extends ClientBundle {

@Source("hal-logo.svg")
TextResource logo();
}
}
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@
<version.mockito>5.14.2</version.mockito>
<version.node>v20.18.0</version.node>
<version.patternfly>5.2.1</version.patternfly>
<version.patternfly.java>0.2.11-SNAPSHOT</version.patternfly.java>
<version.patternfly.java>0.2.11</version.patternfly.java>

<!-- Plugin versions -->
<version.checkstyle.plugin>3.3.0</version.checkstyle.plugin>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@
import static org.patternfly.icon.IconSets.fas.edit;
import static org.patternfly.icon.IconSets.fas.powerOff;
import static org.patternfly.icon.IconSets.fas.redo;
import static org.patternfly.icon.IconSets.fas.undo;
import static org.patternfly.popper.Placement.auto;
import static org.patternfly.style.Classes.modifier;

Expand Down

0 comments on commit 14768b2

Please sign in to comment.