docs: base documentation (#250)

* Copy the base documents from Python version. All pages are removed except the 3 core utilities. They still have the Python content right now.

Co-authored-by: Sara Gerion <[email protected]>
Co-authored-by: Andrea Amorosi <[email protected]>
Co-authored-by: ijemmy <[email protected]>

Author: 4 people

.gitignore

@@ -29,4 +29,7 @@ coverage
 .DS_Store
 
 # Visual Studio Code
-.vscode
+.vscode
+
+# Python virtual environments (for running mkdocs locally)
+venv

CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format for changes and adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [Unreleased]
+
+## 0.1.0
+
+### Features
+
+* **tracer:** beta release ([#91](https://github.com/awslabs/aws-lambda-powertools-python/issues/91))
+* **logger:** beta release ([#24](https://github.com/awslabs/aws-lambda-powertools-python/issues/24))
+* **metrics:** beta release ([#25](https://github.com/awslabs/aws-lambda-powertools-python/issues/25))

CONTRIBUTING.md

@@ -46,6 +46,17 @@ To send us a pull request, please follow these steps:
 GitHub provides an additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
 [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 
+#### Local documentation
+
+You might find useful to run both the documentation website and the API reference locally while contributing:
+
+* **API reference**: :construction:
+* **Docs website**:
+
+You can build and start a local docs website by running these two commands.
+  - `npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/`
+  - `npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
+
 ### Conventions
 
 Category | Convention

docs/Dockerfile

@@ -0,0 +1,2 @@
+FROM squidfunk/mkdocs-material
+RUN pip install mkdocs-git-revision-date-plugin

docs/changelog.md

@@ -0,0 +1,2 @@
+[comment]: <> (Includes Changelog content entire file as a snippet)
+--8<-- "CHANGELOG.md"