Skip to content

Commit

Permalink
Updates to documentation (#576)
Browse files Browse the repository at this point in the history
* Update README.md to include restricted AMI info

* Updates to developer support section in README.md and fix broken url links (#723)
  • Loading branch information
kyyalama2 authored Jul 18, 2022
1 parent 466045c commit 2a36c4d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 10 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Table of Contents

1. [Overview of AWS EC2 FPGA Development Kit](#overview-of-aws-ec2-fpga-development-kit)
- [Developer Support](#developer-support)
- [Development Flow](#development-flow)
- [Development environments](#development-environments)
- [FPGA Developer AMI](#fpga-developer-ami)
Expand All @@ -14,7 +15,6 @@
- [Quickstarts](#quickstarts)
- [How To's](#how-tos)
1. [Documentation Overview](#documentation-overview)
1. [Developer Support](#developer-support)

# Overview of AWS EC2 FPGA Development Kit

Expand All @@ -23,6 +23,10 @@ It is distributed between this github repository and FPGA Developer AMI - [Cento

⚠️ <b>NOTE:</b> The developer kit is supported for Linux operating systems only.

## Developer Support

Opening a [GitHub Issue](https://github.com/aws/aws-fpga/issues) is the preferred method to get support with the AWS FPGA Development Kit. In addition, the [FPGA Development re:Post Tag](https://repost.aws/tags/TAc7ofO5tbQRO57aX1lBYbjA/fpga-development) is available to find FPGA-related discussion topics from the AWS community of customers, AWS customer support, and the AWS FPGA development team.

## Development Flow
After creating an FPGA design (also called CL - Custom logic), developers can create an Amazon FPGA Image (AFI) and easily deploy it to an F1 instance. AFIs are reusable, shareable and can be deployed in a scalable and secure way.

Expand Down Expand Up @@ -77,6 +81,7 @@ For software-defined development please look at the runtime compatibility table
|-----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 2017.1 | 🚫 Deprecated on 09/01/2018 | Developer kit versions prior to v1.3.7 and Developer AMI prior to v1.4 (2017.1) [reached end-of-life](https://forums.aws.amazon.com/ann.jspa?annID=6068). |
| 2017.4 | 🚫 Deprecated on 12/31/2021 | [Support for Xilinx 2017.4 toolsets was deprecated on 12/31/2021](https://forums.aws.amazon.com/ann.jspa?annID=8949). |
| 2020.1 and below | Discontinued on 02/2022 | Removed the ability for customers to newly subscribe to 2020.1 and below AMI versions to remove exposure to [CVE-2021-44228](https://www.cve.org/CVERecord?id=CVE-2021-44228) as these versions of tools do not have patches from xilinx |

## Hardware Development Kit (HDK)

Expand Down Expand Up @@ -217,11 +222,3 @@ Documentation is located throughout this developer kit and the table below conso
| AFI - Power | [FPGA Power, recovering from clock gating](./hdk/docs/afi_power.md) | Helps developers with understanding FPGA power usage, preventing power violations on the F1 instance and recovering from a clock gated slot. |
| On-premise Development | [Tools, Licenses required for on-premise development](./docs/on_premise_licensing_help.md) | Guidance for developer wanting to develop AFIs from on-premises instead of using the [FPGA Developer AMI](https://aws.amazon.com/marketplace/pp/B06VVYBLZZ) |
| Frequently asked questions | [FAQ](./FAQs.md)| Q/A are added based on developer feedback and common AWS forum questions |


# Developer Support

* [**AWS Re:Post**](https://repost.aws/) is the first place to go to post questions, learn from other users, to engage with the FPGA developer community, AWS and Xilinx engineers to get help.

* You could also file a [Github Issue](https://github.com/aws/aws-fpga/issues) for support. We prefer AWS Re:Post as this helps the entire community learn from issues, feedback and answers.
* Click the "Watch" button in GitHub upper right corner to get regular updates.
2 changes: 1 addition & 1 deletion sdk/tests/fio_dma_tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,6 @@ As an alternative to the above, a variable blocksize (or other parameters) may b

## FIO is very useful and configurable, how do I learn about the other supported options?

Please see this [link](https://github.com/axboe/fio/blob/master/HOWTO) for the full FIO command set.
Please see this [link](https://github.com/axboe/fio/blob/master/HOWTO.rst) for the full FIO command set.


0 comments on commit 2a36c4d

Please sign in to comment.