Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update demo readme and main readme #266

Merged
merged 3 commits into from
Jan 27, 2025
Merged

Update demo readme and main readme #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5776537
Update docs
Jan 3, 2025
350d9fd
DRY up the demo docs
Jan 6, 2025
87c7455
prettier cleanup
Jan 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 2 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To use Topology, you will need to have both [Node Active LTS](https://github.com

## Installing Topology

Once you have all of the prequisites, you can install the Topology package with Yarn or npm:
Once you have all of the prerequisites, you can install the Topology package with Yarn or npm:

1. Using Yarn:

Expand Down Expand Up @@ -202,38 +202,8 @@ export const TopologyBaselineDemo = React.memo(() => {

To help you better understand and visualize the different Topology components, we have created an interactive demo, [which is contained here.](https://github.com/patternfly/react-topology/tree/main/packages/demo-app-ts)

Continue reading for instructions on how to build and run the demo app.
See the instructions to install and run the demo app, here: [Demo README.md](packages/demo-app-ts/README.md)

### Prerequisites

In order to run the demo app, you need to make sure the following prerequisites are met.

1. Make sure that you have yarn installed, as outlined in [the general Topology prerequisites.](#prerequisites)
1. If you haven’t already, [fork the Topology project.](https://github.com/patternfly/react-topology)

### Running the demo app

Once you’ve set up the prerequisites, you can follow these steps to run the docs workspace or the demo app on your local machine

1. In a terminal, type the following commands to start the docs workspace:

```
yarn install
yarn start
```

2. In a terminal, type the following commands to navigate to demo-app-ts and launch the demo app:

```
cd packages/demo-app-ts
yarn start:demo-app:hot
```

3. You will receive a message confirming that the app is running. To view the locally running workspace, visit http://localhost:8008/.

4. Explore the demo app in your browser:

![Demo app landing page.](packages/module/patternfly-docs/content/examples/img/topology-demo-app.png)

## Need help?
If you find a bug, have a request, or have any questions about Topology that aren't answered in our documentation, please [reach out to us on Slack.](https://patternfly.slack.com/archives/CK7URGJ2W)
13 changes: 7 additions & 6 deletions packages/demo-app-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[the general Topology prerequisites]: ../../README.md#prerequisites
# Topology demo app

To help you better understand and visualize the different Topology components, we have created an interactive demo, [which is contained here.](https://github.com/patternfly/react-topology/tree/main/packages/demo-app-ts)
Expand All @@ -8,8 +9,8 @@ Continue reading for instructions on how to build and run the demo app.

In order to run the demo app, you need to make sure the following prerequisites are met.

1. Make sure that you have yarn installed, as outlined in [the general Topology prerequisites.](#prerequisites)
1. Make sure that you have the PatternFly React library installed. [Follow these instructions if you need to install this package.](https://github.com/patternfly/patternfly-react?tab=readme-ov-file#install-and-configure-patternfly-react)
1. Make sure that you have yarn installed, as outlined in [the general Topology prerequisites].
1. Make sure that you have the PatternFly React library installed. [Follow these instructions if you need to install this package.](https://github.com/patternfly/patternfly-react?tab=readme-ov-file#install-and-configure-patternfly-react)
1. If you haven’t already, clone [the Topology project](https://github.com/patternfly/react-topology) and navigate to your local directory:

```
Expand All @@ -21,14 +22,14 @@ cd react-topology

Once you’ve set up the prerequisites, you can follow these steps to run the demo app on your local machine

1. In a terminal, type the following commands to start the docs workspace:
1. In a terminal, type the following commands to start the `react topology docs workspace`:

```
yarn install
yarn start
```

2. In a separate terminal window, type the following commands to navigate to demo-app-ts and launch the demo app:
2. In a **separate** terminal window, type the following commands to navigate to `demo-app-ts` and launch the demo app:

```
cd packages/demo-app-ts
Expand All @@ -42,9 +43,9 @@ yarn start:demo-app:hot
<i> [webpack-dev-server] Loopback: http://localhost:3000/
```

4. Explore the demo app in your browser:
4. Explore the demo app in [your browser](http://localhost:3000/)

![Demo app landing page.](packages/module/patternfly-docs/content/examples/img/topology-demo-app.png)
![Demo app landing page.](../../packages/module/patternfly-docs/content/examples/img/topology-demo-app.png)

## Need help?
If you find a bug, have a request, or have any questions about Topology that aren't answered in our documentation, please [reach out to us on Slack.](https://patternfly.slack.com/archives/CK7URGJ2W)
5 changes: 1 addition & 4 deletions packages/module/release.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
module.exports = {
branches: [
'do-not-delete',
{ name: 'main', channel: 'prerelease', prerelease: 'prerelease' },
],
branches: ['do-not-delete', { name: 'main', channel: 'prerelease', prerelease: 'prerelease' }],
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

prettier build from a previous build asked me to make this change in this stage of CI:

yarn run v1.22.22
$ eslint . --ext .js,.jsx,.ts,.tsx --color

/home/runner/work/react-topology/react-topology/packages/module/release.config.js
  2:14  error  Replace `⏎····'do-not-delete',⏎····{·name:·'main',·channel:·'prerelease',·prerelease:·'prerelease'·},⏎··` with `'do-not-delete',·{·name:·'main',·channel:·'prerelease',·prerelease:·'prerelease'·}`  prettier/prettier

✖ 1 problem (1 error, 0 warnings)
  1 error and 0 warnings potentially fixable with the `--fix` option.

analyzeCommits: {
preset: 'angular'
},
Expand Down
Loading