Skip to content

Commit 7f07ace

Browse files
committed
Add CHANGELOG.md so mkdocs doesn't throw an error for file not found
1 parent 0dcb12d commit 7f07ace

File tree

5 files changed

+58
-11003
lines changed

5 files changed

+58
-11003
lines changed

.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,7 @@ coverage
2929
.DS_Store
3030

3131
# Visual Studio Code
32-
.vscode
32+
.vscode
33+
34+
# Python virtual environments (for running mkdocs locally)
35+
venv

CHANGELOG.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
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).
6+
7+
8+
## [Unreleased]
9+
10+
## 0.1.0
11+
12+
### Features
13+
14+
* **tracer:** beta release ([#91](https://github.com/awslabs/aws-lambda-powertools-python/issues/91))
15+
* **logger:** beta release ([#24](https://github.com/awslabs/aws-lambda-powertools-python/issues/24))
16+
* **metrics:** beta release ([#25](https://github.com/awslabs/aws-lambda-powertools-python/issues/25))

CONTRIBUTING.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,10 @@ You might find useful to run both the documentation website and the API referenc
5252

5353
* **API reference**: :construction:
5454
* **Docs website**:
55-
- `docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/`
56-
- `docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
55+
56+
You can build and start a local docs website by running these two commands.
57+
- `npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/`
58+
- `npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
5759

5860
### Conventions
5961

0 commit comments

Comments
 (0)