Skip to content

Commit

Permalink
Add links to transition guide
Browse files Browse the repository at this point in the history 
- Add links to the Stratum Dependencies Transition Guide to the
  top-level and `setup` README files.

- Remove individual links to the target-specific setup guides in
  favor of the more general link to the user guide.

Signed-off-by: Derek G Foster <[email protected]>
  • Loading branch information
@ffoulkes
ffoulkes committed Oct 26, 2023
1 parent e5bbefc commit 1ab8b01
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 15 deletions.
16 changes: 3 additions & 13 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ The Stratum dependencies have moved from the `setup` directory to a new
This allows the dependencies to be updated and built independently of
P4 Control Plane.

See the [README](https://github.com/ipdk-io/stratum-deps/blob/main/README.md)
file for more information.
See the [README file](https://github.com/ipdk-io/stratum-deps/blob/main/README.md)
and [Transition Guide](https://github.com/ipdk-io/stratum-deps/blob/main/docs/transition-guide.md)
for more information.

## Source code

Expand All @@ -32,17 +33,6 @@ To download the source code for P4 Control Plane:
git clone --recursive https://github.com/ipdk-io/networking-recipe
```

## Targets

P4 Control Plane can be configured at build time to support any one
of the following targets:

| Target | Instructions |
| ------ | ------------ |
| dpdk | [DPDK Setup Guide](https://ipdk.io/p4cp-userguide/guides/setup/dpdk-setup-guide.html) |
| es2k | [ES2K Setup Guide](https://ipdk.io/p4cp-userguide/guides/setup/es2k-setup-guide.html) |
| tofino | [Tofino Setup Guide](https://ipdk.io/p4cp-userguide/guides/setup/tofino-setup-guide.html) |

## Documentation

- [P4 Control Plane User Guide](https://ipdk.io/p4cp-userguide/)
5 changes: 3 additions & 2 deletions setup/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ The Stratum dependencies have moved from the `setup` directory to a new
This allows the dependencies to be updated and built independently of the
Networking Recipe (P4 Control Plane).

See the [README](https://github.com/ipdk-io/stratum-deps/blob/main/README.md)
file for more information.
See the [README file](https://github.com/ipdk-io/stratum-deps/blob/main/README.md)
and [Transition Guide](https://github.com/ipdk-io/stratum-deps/blob/main/docs/transition-guide.md)
for more information.

0 comments on commit 1ab8b01

Please sign in to comment.