Refactor all internal links to point to markdown source.

This will allow the content to be referenced within GitHub as well as VSCode and in the final build

Author: spikeheap

docs/api-playbook/11-faqs.md

@@ -10,8 +10,6 @@ You can do this by looking up the API in AWS API Gateway.
 5. Choose the stage you want to use;
 6. Now you can see the entire URL inside a blue box on the top with the heading "Invoke URL";
 
-Additionally, you can find API URLs on our Developer Hub website. See more information about it [here](../Governance/developer_hub).
-
 ## How do I find out whether an API is healthy?:
 
 You can utilise AWS Canaries, which we use for uptime monitoring.
@@ -55,7 +53,3 @@ Visit [https://app.circleci.com/pipelines/github/LBHackney-IT](https://app.circl
 If you aren't subscribed to any projects, simply navigate to the'projects' tab on the sidebar to view and search for all Hackney projects.
 
 ![Circle CI Sidebar - Click on the second icon (projects) to view all projects in a workspace](./doc-images/CircleCI_sidebar.png)
-
-## Where can I find different APIs that we use at Hackney?:
-
-You can use our Developer Hub to view our APIs! See [this page](../Governance/developer_hub/) for more information.

docs/api-playbook/DevOps practices/Monitoring/alerting.md

@@ -44,7 +44,7 @@ We use AWS CloudWatch Canaries to monitor the availability of our APIs and front
 
 - The current creation process for a canary is **manual**;
 
-[See the guidance for Canaries here](../uptime_monitoring)
+[See the guidance for Canaries here](./uptime_monitoring.md)
 
 ### AWS Canaries for front end applications:
 

docs/api-playbook/DevOps practices/aws_ecs.md

@@ -41,7 +41,7 @@ This means that if any large file needs to be stored at run time to be accessed
 
 It is recommended that you use Terraform to provision AWS resources. We already have produced a terraform template that generates all necessary resources for an API/app that is to be hosted using ECS with Fargate.
 
-In this playbook, please refer to the [Terraform section](../infrastructure) to find out more about the templates and how to use them. The template has configuration both for front end apps and for back end services that are to use ECS with Fargate.
+In this playbook, please refer to the [Terraform section](./infrastructure.md) to find out more about the templates and how to use them. The template has configuration both for front end apps and for back end services that are to use ECS with Fargate.
 
 ** The Terraform template creates the following resources: **
 

docs/api-playbook/DevOps practices/deployment_pipeline.md

@@ -37,7 +37,7 @@ We use the Test-Driven Development (TDD) approach when writing code.
 
 Each project’s test suite must include units tests produced as part of TDD as well as integration tests.
 
-> ℹ️ More on practices in Hackney for writing tests here: [TDD Practices](/api-playbook/Testing/tdd.md)
+> ℹ️ More on practices in Hackney for writing tests here: [TDD Practices](../../api-playbook/Testing/tdd.md)
 
 ## Environments:
 

docs/api-playbook/DevOps practices/lambda_best_practices.md

@@ -71,7 +71,7 @@ example-api’s serverless configuration includes the basic setup for policies r
 
 In some cases it’s useful to have a bit more insight on how the Lambda is performing. In that case services like X-Ray can be implemented. They require some additional configuration to the application, but are generally relatively easy to implement at any point.
 
-[**More about X-Ray here**](../Monitoring/x_ray)
+[**More about X-Ray here**](./Monitoring/x_ray.md)
 ### Alerts:
 
-For more details on logging and alerts in general, please see our [alerting guide](../Monitoring/alerting).
+For more details on logging and alerts in general, please see our [alerting guide](./Monitoring/alerting.md).

docs/api-playbook/Development Lifecycle/Designing your API/references.md

@@ -31,10 +31,10 @@ This section collects links to documents to which we refer, and base our guideli
   - [BCP 47: Tags for Identifying Languages](https://tools.ietf.org/html/bcp47);
 ## Dissertations:
 
-  - [Roy Thomas Fielding - Architectural Styles and the Design of Network-Based Software Architectures](http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm). This is the text which defines what REST is;
+  - [Roy Thomas Fielding - Architectural Styles and the Design of Network-Based Software Architectures](https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm). This is the text which defines what REST is;
 ## Books:
 
-  - [REST in Practice: Hypermedia and Systems Architecture](http://www.amazon.de/REST-Practice-Hypermedia-Systems-Architecture/dp/0596805829);
+  - [REST in Practice: Hypermedia and Systems Architecture](https://www.amazon.de/REST-Practice-Hypermedia-Systems-Architecture/dp/0596805829);
 
   - [Build APIs You Won’t Hate](https://leanpub.com/build-apis-you-wont-hate);
 

docs/api-playbook/Development Lifecycle/How to build an API/Preferred tech stack/Readme.md

@@ -5,16 +5,16 @@
 - .NET Core 3.1 (C#);
 - AWS Lambda;
 - Serverless framework.
-  * [See more](./serverless_lambda);
+  * [See more](./serverless_lambda.md);
 - AWS API Gateway;
 - Hackney Lambda authoriser (for authentication).
   * [See more](../API-Practices and tools/lambda_authoriser);
 - FxCop for static code analysis.
-  * [See more](./static_code_analysis);
+  - [See more](./static_code_analysis.md);
 - dotnet-format for linting.
   - [See more](../API-Practices and tools/linting);
 - AWS Canaries for availability monitoring.
-  * [See more](../../../DevOps%20practices/Monitoring/uptime_monitoring);
+  - [See more](../../../DevOps%20practices/Monitoring/uptime_monitoring.md);
 
 ## Testing:
 
@@ -29,20 +29,20 @@
     * For spinning up DB image containers and running tests against that database ;
     * _During local development and during test run as part of CI/CD_;
 
-*For more guidance on testing, go to the [testing](../../../Testing/tdd) section*.
+_For more guidance on testing, go to the [testing](../../../Testing/tdd.md) section_.
 
 ## Common:
 
 - Swagger documentation.
   * For API design prior to implementation;
   * Automated Swagger docs for each API endpoint deployed;
-  * [See more](../../API Documentation/swagger_documentation);
+  - [See more](../../API Documentation/swagger_documentation.md);
 - CircleCI for CI/CD.
-  * [See more](../../../DevOps%20practices/deployment_pipeline);
+  - [See more](../../../DevOps%20practices/deployment_pipeline.md);
 - GitHub for version control.
   * [HackIT Github](https://github.com/LBHackney-IT);
 - AWS for cloud hosting;
 - AWS CloudWatch for monitoring;
 - Terraform for Infrastructure as Code (IaC) (e.g. setting up AWS DMS).
-  - [See more](../../../DevOps%20practices/infrastructure);
+  - [See more](../../../DevOps%20practices/infrastructure.md);
 - AWS Parameter Store for secrets (connection string and similar);

docs/api-playbook/Development Lifecycle/Implementing HTTP endpoints/GET endpoint/get_dynamodb.md

@@ -9,7 +9,7 @@ GET requests are used to **read** either a single or a collection resource.
 
   - GET requests must NOT have a request body payload;
 
-**Note:** GET requests on collection resources should provide sufficient filter and [pagination](../../../Designing%20your%20API/pagination) mechanisms;
+**Note:** GET requests on collection resources should provide sufficient filter and [pagination](../../Designing%20your%20API/pagination.md) mechanisms;
 
 [Here is an example PR to show how to build an GET endpoint using DynamoDB](https://github.com/LBHackney-IT/notes-api/pull/8/files)
 

docs/api-playbook/Development Lifecycle/Implementing HTTP endpoints/GET endpoint/get_opensearch.md

@@ -10,7 +10,7 @@ GET requests are used to **read** either a single or a collection resource.
 
   - GET requests must NOT have a request body payload;
 
-**Note:** GET requests on collection resources should provide sufficient filter and [pagination](../../../Designing%20your%20API/pagination) mechanisms;
+**Note:** GET requests on collection resources should provide sufficient filter and [pagination](../../Designing%20your%20API/pagination.md) mechanisms;
 
 [Here is an example PR to show how to build a search endpoint using OpenSearch (Also known as ElasticSearch)](https://github.com/LBHackney-IT/housing-search-api/pull/154)
 

docs/api-playbook/Development Lifecycle/Implementing HTTP endpoints/GET endpoint/get_postgres.md

@@ -9,7 +9,7 @@ GET requests are used to **read** either a single or a collection resource.
 
   - GET requests must NOT have a request body payload;
 
-**Note:** GET requests on collection resources should provide sufficient filter and [pagination](../../../Designing%20your%20API/pagination) mechanisms;
+**Note:** GET requests on collection resources should provide sufficient filter and [pagination](../../Designing%20your%20API/pagination.md) mechanisms;
 
 We have created a video that gives developers a good understanding of how we build API Endpoints using Postgres from beginning to end, following best practices.