Skip to content

Commit 2a36c4d

Browse files
authored
Updates to documentation (#576)
* Update README.md to include restricted AMI info * Updates to developer support section in README.md and fix broken url links (#723)
1 parent 466045c commit 2a36c4d

File tree

2 files changed

+7
-10
lines changed

2 files changed

+7
-10
lines changed

README.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Table of Contents
22

33
1. [Overview of AWS EC2 FPGA Development Kit](#overview-of-aws-ec2-fpga-development-kit)
4+
- [Developer Support](#developer-support)
45
- [Development Flow](#development-flow)
56
- [Development environments](#development-environments)
67
- [FPGA Developer AMI](#fpga-developer-ami)
@@ -14,7 +15,6 @@
1415
- [Quickstarts](#quickstarts)
1516
- [How To's](#how-tos)
1617
1. [Documentation Overview](#documentation-overview)
17-
1. [Developer Support](#developer-support)
1818

1919
# Overview of AWS EC2 FPGA Development Kit
2020

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

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

26+
## Developer Support
27+
28+
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.
29+
2630
## Development Flow
2731
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.
2832

@@ -77,6 +81,7 @@ For software-defined development please look at the runtime compatibility table
7781
|-----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
7882
| 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). |
7983
| 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). |
84+
| 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 |
8085

8186
## Hardware Development Kit (HDK)
8287

@@ -217,11 +222,3 @@ Documentation is located throughout this developer kit and the table below conso
217222
| 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. |
218223
| 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) |
219224
| Frequently asked questions | [FAQ](./FAQs.md)| Q/A are added based on developer feedback and common AWS forum questions |
220-
221-
222-
# Developer Support
223-
224-
* [**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.
225-
226-
* 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.
227-
* Click the "Watch" button in GitHub upper right corner to get regular updates.

sdk/tests/fio_dma_tools/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,6 @@ As an alternative to the above, a variable blocksize (or other parameters) may b
170170

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

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

175175

0 commit comments

Comments
 (0)