Updated ReadTheDocs

There are some issues with the current ReadTheDocs site, doing a quick test of the markdown support to see if I can get this in good working order for AWSWL v1.1.0.

Signed-off-by: Geoffrey Wiseman <geoffrey.wiseman@codiform.com>

.readthedocs.yml

@@ -0,0 +1,17 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with MkDocs
+mkdocs:
+  configuration: mkdocs.yml
+

README.md

@@ -1,8 +1,7 @@
 # AWS Whitelist
 
 [![ci](https://github.com/geoffreywiseman/awswl/actions/workflows/ci.yml/badge.svg)](https://github.com/geoffreywiseman/awswl/actions/workflows/ci.yml)
-[![downloads](http://pepy.tech/badge/awswl)](http://pepy.tech/count/awswl)
-
+[![Downloads](https://static.pepy.tech/badge/awswl)](https://pepy.tech/project/awswl)
 A small tool to make it pretty simple to add and remove ip addresses (or CIDR blocks) from an AWS
 security group. This acts like a sort of oversimplified VPN, where you can quickly give yourself
 SSH access to a project as you move about from network to network.

docs/alternatives.md

@@ -0,0 +1,23 @@
+# Alternatives to AWSWL
+
+AWSWL is one solution to the problem of controlling access to AWS resources with changing IP addresses.
+
+## Systems Manager Session Manager
+
+AWS has a feature, [Session Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager.html), within AWS Systems Manager that can allow you to connect, using your AWS credentials, to private resources in your VPC. In particular, this can allow you to make an SSH connection (or an SSH-like connection) to an instance that isn't public.
+
+## AWS Site-to-Site VPN
+
+If you're working from an office or a set of offices and you have good networking equipment and networking personnel, it's more common to use an [AWS site-to-site VPN](https://docs.aws.amazon.com/vpn/index.html), allowing you to connect the internal network of your office(s) to the internal network of your VPC(s).
+
+In a more complex environment, you might also include something like a Transit Gateway.
+
+## Other VPNs
+
+Some people prefer different VPN solutions and install OpenVPN appliances or a custom VPN on a Linux EC2 instance. This is not a VPN recommendation guide, but it's worth pointing out that there are other VPN choices available.
+
+## etc
+
+This is not an exhaustive list -- there are lots of other choices: Teleport, Direct Connect and probably a bunch of choices I haven't considered.
+
+If you feel strongly about an alternative and you want to add it to the documentation, feel free to raise a PR.

docs/index.md

@@ -0,0 +1,11 @@
+# AWSWL
+
+A small tool to make it pretty simple to add and remove ip addresses (or CIDR blocks) from an AWS security group. If you have AWS resources on public IPs and you need to control access to those resources (e.g. SSH to an EC2 instance).
+
+This acts like a sort of oversimplified VPN, where you can quickly give yourself SSH access to a project as you move about from network to network.
+
+## Alternatives
+
+In case you're encountering AWSWL without having considered the other options, you might want to consider [the alternatives](alternatives.md) (vpn, session manager, etc).
+
+

mkdocs.yml

@@ -0,0 +1,3 @@
+site_name: AWSWL
+
+