Documentation: Fixes broken links and standardizes headers.

Signed-off-by: Kevin Putnam <[email protected]>

Author: intelkevinputnam

DEVEL.md

@@ -1,5 +1,7 @@
-How to develop simple device plugins
-====================================
+# Development
+
+
+## How to develop simple device plugins
 
 To create a simple device plugin without the hassle of developing your own gRPC
 server, you can use a package included in this repository called
@@ -62,8 +64,7 @@ Optionally, your device plugin may also implement the
 before they are sent to `kubelet`. To see an example, refer to the FPGA
 plugin which implements this interface to annotate its responses.
 
-Logging
--------
+### Logging
 
 The framework uses [`klog`](https://github.com/kubernetes/klog) as its logging
 framework. It is encouraged for plugins to also use `klog` to maintain uniformity
@@ -84,8 +85,7 @@ The default is to not log `Info()` calls. This can be changed using the plugin c
 line `-v` parameter. The additional annotations prepended to log lines by 'klog' can be disabled
 with the `-skip_headers` option.
 
-Error Conventions
------------------
+### Error Conventions
 
 The framework has a convention for producing and logging errors. Ideally plugins will also adhere
 to the convention.
@@ -122,8 +122,7 @@ Otherwise, they can be logged as simple values:
     klog.Warningf("Example of a warning due to an external error: %v", err)
 ```
 
-How to build against a newer version of Kubernetes
-==================================================
+## How to build against a newer version of Kubernetes
 
 First you need to update module dependencies. The easiest way is to use the
 script copied from https://github.com/kubernetes/kubernetes/issues/79384#issuecomment-521493597:
@@ -163,4 +162,4 @@ $ make generate
 $ make test
 ```
 
-and fix all new compilation issues.
+and fix all new compilation issues.

README.md

@@ -1,11 +1,14 @@
-# Intel® Device Plugins for Kubernetes
+# Overview
 [![Build Status](https://github.com/intel/intel-device-plugins-for-kubernetes/workflows/CI/badge.svg?branch=master)](https://github.com/intel/intel-device-plugins-for-kubernetes/actions?query=workflow%3ACI)
 [![Go Report Card](https://goreportcard.com/badge/github.com/intel/intel-device-plugins-for-kubernetes)](https://goreportcard.com/report/github.com/intel/intel-device-plugins-for-kubernetes)
 [![GoDoc](https://godoc.org/github.com/intel/intel-device-plugins-for-kubernetes/pkg/deviceplugin?status.svg)](https://godoc.org/github.com/intel/intel-device-plugins-for-kubernetes/pkg/deviceplugin)
 
-## Table of Contents
+This repository contains a framework for developing plugins for the Kubernetes
+[device plugins framework](https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/),
+along with a number of device plugin implementations utilising that framework.
+
+Table of Contents
 
-* [About](#about)
 * [Prerequisites](#prerequisites)
 * [Plugins](#plugins)
     * [GPU device plugin](#gpu-device-plugin)
@@ -22,12 +25,6 @@
 * [Supported Kubernetes versions](#supported-kubernetes-versions)
 * [Related code](#related-code)
 
-## About
-
-This repository contains a framework for developing plugins for the Kubernetes
-[device plugins framework](https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/),
-along with a number of device plugin implementations utilising that framework.
-
 ## Prerequisites
 
 Prerequisites for building and running these device plugins include:
@@ -212,7 +209,7 @@ $ KUBEBUILDER_ASSETS=${HOME}/work/kubebuilder-assets make envtest
 
 ## Supported Kubernetes versions
 
-Releases are made under the github [releases area](../../releases). Supported releases and
+Releases are made under the github [releases area](https://github.com/intel/intel-device-plugins-for-kubernetes/releases). Supported releases and
 matching Kubernetes versions are listed below:
 
 | Branch            | Kubernetes branch/version      |
@@ -227,4 +224,4 @@ matching Kubernetes versions are listed below:
 
 ## Related code
 
-A related Intel SRIOV network device plugin can be found in [this repository](https://github.com/intel/sriov-network-device-plugin)
+A related Intel SRIOV network device plugin can be found in [this repository](https://github.com/intel/sriov-network-device-plugin)

cmd/fpga_admissionwebhook/README.md

@@ -1,6 +1,6 @@
 # Intel FPGA admission controller for Kubernetes
 
-# Table of Contents
+Table of Contents
 
 * [Introduction](#introduction)
 * [Dependencies](#dependencies)
@@ -10,7 +10,7 @@
 * [Mappings](#mappings)
 * [Next steps](#next-steps)
 
-# Introduction
+## Introduction
 
 The FPGA admission controller is one of the components used to add support for Intel FPGA
 devices to Kubernetes.
@@ -31,7 +31,7 @@ The admission controller also keeps the user from bypassing namespaced mapping r
 by denying admission of any pods that are trying to use internal knowledge of InterfaceID or
 Bitstream ID environment variables used by the prestart hook.
 
-# Dependencies
+## Dependencies
 
 This component is one of a set of components that work together. You may also want to
 install the following:
@@ -42,12 +42,12 @@ install the following:
 All components have the same basic dependencies as the
 [generic plugin framework dependencies](../../README.md#about)
 
-# Installation
+## Installation
 
 The following sections detail how to obtain, build and deploy the admission
 controller webhook plugin.
 
-## Pre-requisites
+### Pre-requisites
 
 The webhook depends on having [cert-manager](https://cert-manager.io/)
 installed:
@@ -89,7 +89,7 @@ spec:
     ...
 ```
 
-## Deployment
+### Deployment
 
 To deploy the webhook, run
 
@@ -108,7 +108,7 @@ issuer.cert-manager.io/intelfpgawebhook-selfsigned-issuer created
 ```
 Now you can deploy your mappings.
 
-# Mappings
+## Mappings
 
 Mappings is a an essential part of the setup that gives a flexible instrument to a cluster
 administrator to manage FPGA bitstreams and to control access to them. Being a set of
@@ -148,12 +148,12 @@ bitstream to a region before the container is started.
 
 Mappings of resource names are configured with objects of `AcceleratorFunction` and
 `FpgaRegion` custom resource definitions found respectively in
-[`./deployment/fpga_admissionwebhook/crd/bases/fpga.intel.com_af.yaml`](../../deployment/fpga_admissionwebhook/crd/bases/fpga.intel.com_af.yaml)
-and [`./deployment/fpga_admissionwebhook/crd/bases/fpga.intel.com_region.yaml`](../../deployment/fpga_admissionwebhook/crd/bases/fpga.intel.com_region.yaml).
+[`./deployment/fpga_admissionwebhook/crd/bases/fpga.intel.com_af.yaml`](/deployments/fpga_admissionwebhook/crd/bases/fpga.intel.com_acceleratorfunctions.yaml)
+and [`./deployment/fpga_admissionwebhook/crd/bases/fpga.intel.com_region.yaml`](/deployments/fpga_admissionwebhook/crd/bases/fpga.intel.com_fpgaregions.yaml).
 
 Mappings between 'names' and 'ID's are controlled by the admission controller
 mappings collection file found in
-[`./deployments/fpga_admissionwebhook/mappings-collection.yaml`](../../deployments/fpga_admissionwebhook/mappings-collection.yaml).
+[`./deployments/fpga_admissionwebhook/mappings-collection.yaml`](/deployments/fpga_admissionwebhook/mappings-collection.yaml).
 This mappings file can be deployed with
 
 ```bash
@@ -163,6 +163,6 @@ $ kubectl apply -f https://raw.githubusercontent.com/intel/intel-device-plugins-
 Note that the mappings are scoped to the namespaces they were created in
 and they are applicable to pods created in the corresponding namespaces.
 
-# Next steps
+## Next steps
 
-Continue with [FPGA prestart CRI-O hook](../fpga_crihook/README.md).
+Continue with [FPGA prestart CRI-O hook](../fpga_crihook/README.md).

cmd/fpga_crihook/README.md

@@ -1,6 +1,6 @@
 # Intel FPGA prestart CRI-O webhook for Kubernetes
 
-# Table of Contents
+Table of Contents
 
 * [Introduction](#introduction)
 * [Dependencies](#dependencies)
@@ -9,27 +9,27 @@
     * [Building the image](#building-the-image)
 * [Configuring CRI-O](#configuring-cri-o)
 
-# Introduction
+## Introduction
 
 The FPGA CRI-O webhook is one of the components used to add support for Intel FPGA
 devices to Kubernetes.
 
 The FPGA prestart CRI-O hook is triggered by container annotations, such as set by the
-[FPGA device plugin](../fpga_plugin).  It performs discovery of the requested FPGA
+[FPGA device plugin](../fpga_plugin/README.md).  It performs discovery of the requested FPGA
 function bitstream and then programs FPGA devices based on the environment variables
 in the workload description.
 
 The CRI-O prestart hook is only *required* when the
-[FPGA admission webhook](../fpga_admissionwebhook) is configured for orchestration
+[FPGA admission webhook](../fpga_admissionwebhook/README.md) is configured for orchestration
 programmed mode, and is benign (un-used) otherwise.
 
 > **Note:** The fpga CRI-O webhook is usually installed by the same DaemonSet as the
 > FPGA device plugin. If building and installing the CRI-O webhook by hand, it is
 > recommended you reference the
-> [fpga plugin DaemonSet YAML](../../deployments/fpga_plugin/base/intel-fpga-plugin-daemonset.yaml) for
+> [fpga plugin DaemonSet YAML](/deployments/fpga_plugin/base/intel-fpga-plugin-daemonset.yaml ) for
 > more details.
 
-# Dependencies
+## Dependencies
 
 This component is one of a set of components that work together. You may also want to
 install the following:
@@ -40,19 +40,19 @@ install the following:
 All components have the same basic dependencies as the
 [generic plugin framework dependencies](../../README.md#about)
 
-# Building
+## Building
 
 The following sections detail how to obtain, build and deploy the CRI-O
 prestart hook.
 
-## Getting the source code
+### Getting the source code
 
 ```bash
 $ export INTEL_DEVICE_PLUGINS_SRC=/path/to/intel-device-plugins-for-kubernetes
 $ git clone https://github.com/intel/intel-device-plugins-for-kubernetes ${INTEL_DEVICE_PLUGINS_SRC}
 ```
 
-## Building the image
+### Building the image
 
 ```bash
 $ cd ${INTEL_DEVICE_PLUGINS_SRC}
@@ -61,11 +61,11 @@ $ make intel-fpga-initcontainer
 Successfully tagged intel/intel-fpga-initcontainer:devel
 ```
 
-# Configuring CRI-O
+## Configuring CRI-O
 
 Recent versions of [CRI-O](https://github.com/cri-o/cri-o) are shipped with default configuration
 file that prevents CRI-O to discover and configure hooks automatically.
 For FPGA orchestration programmed mode, the OCI hooks are the key component.
 Please ensure that your `/etc/crio/crio.conf` parameter `hooks_dir` is either unset
 (to enable default search paths for OCI hooks configuration) or contains the directory
-`/etc/containers/oci/hooks.d`.
+`/etc/containers/oci/hooks.d`.