Skip to content

docs: migrate documentation from Gatsby to MkDocs material #279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 81 commits into from
Feb 12, 2021
Merged
Show file tree
Hide file tree
Changes from 30 commits
Commits
Show all changes
81 commits
Select commit Hold shift + click to select a range
180e6ac
fix whitespace
Feb 2, 2021
1c4b0e3
docs: add logger
Feb 2, 2021
b4dce5e
docs: add middleware
Feb 2, 2021
01147a6
docs: parameters
Feb 2, 2021
7f93bbf
docs: batch
Feb 2, 2021
2a5f50c
docs: typing
Feb 2, 2021
0c492e1
docs: validation
Feb 2, 2021
e174d15
docs: dataclasses
Feb 2, 2021
98b3428
docs: parser
Feb 2, 2021
f9da787
docs: use mkdocs for website
Feb 2, 2021
7636f61
docs: add docs branch to have live preview for the PR
Feb 2, 2021
707b79b
docs: change color and adjust logo
Feb 2, 2021
cb9e881
docs: merged async and generator sections
Feb 2, 2021
1123a31
docs: merged cloudwatch logs to tabs
Feb 2, 2021
1cfdce2
docs: merged tabs
Feb 2, 2021
add4f4f
docs: remove highlight line markers
Feb 2, 2021
f4ea9b7
docs: add meta tags
Feb 2, 2021
2d05c72
docs: remove old docs folder
Feb 2, 2021
264a028
chore: typo in GetCfnTemplate
heitorlessa Feb 3, 2021
1fa47d9
Update docs/core/logger.md
heitorlessa Feb 3, 2021
8f418cb
Update docs/core/logger.md
heitorlessa Feb 3, 2021
7ddb544
Update docs/utilities/parameters.md
heitorlessa Feb 3, 2021
e425d6d
Update docs/utilities/validation.md
heitorlessa Feb 3, 2021
36cba90
Update docs/utilities/validation.md
heitorlessa Feb 3, 2021
4b9ca27
Update docs/utilities/batch.md
heitorlessa Feb 3, 2021
84c8e35
Update docs/core/tracer.md
heitorlessa Feb 3, 2021
f96abe7
Merge branch 'develop' of github.com:awslabs/aws-lambda-powertools-py…
Feb 3, 2021
da46dff
Merge branch 'docs/mkdocs' of github.com:am29d/aws-lambda-powertools-…
Feb 3, 2021
2556afa
remove code formatting from table headers
Feb 3, 2021
a6eb2b4
docs: increse max-width with extra css for readability
Feb 3, 2021
421145a
docs: add changes from review
Feb 4, 2021
1a483c9
docs: refactor doc targets, add docker build
Feb 4, 2021
8e548f5
docs: tabs naming for cloudwatch logs
Feb 4, 2021
32fdd23
docs: fix build-docs-website target
Feb 4, 2021
a815b40
docs: enhance the visual aid for accessibility purposes
Feb 4, 2021
0511fa5
fix: syntax previously broken in last set of commits
heitorlessa Feb 4, 2021
c21faea
fix: async ops snippet completeness
heitorlessa Feb 4, 2021
cca91d3
improv: screen real estate in home page.
heitorlessa Feb 4, 2021
8f0860f
feat: enable strict mode for broken links
heitorlessa Feb 5, 2021
4c07709
improv: merge Layer example to be more pragmatic
heitorlessa Feb 5, 2021
18e7a6f
improv: key features, getting started, clean non-essential
heitorlessa Feb 8, 2021
7bcb477
improv: expand escape hatch, async, reuse examples
heitorlessa Feb 8, 2021
cb2a570
improv: add getting started
heitorlessa Feb 8, 2021
d895006
improv: add getting started, trim content, expand examples
heitorlessa Feb 9, 2021
9d46917
improv: wording on logger reuse
heitorlessa Feb 9, 2021
6e8e108
improv: additional examples on formatting, order, etc. plus advanced …
heitorlessa Feb 9, 2021
383cc19
fix: typo on logging keys in FAQ
heitorlessa Feb 9, 2021
361634f
feat: enable snippets extension; include changelog in the docs
heitorlessa Feb 9, 2021
b78d2c3
fix: docker no longer works with strict due to an issue upstream
heitorlessa Feb 9, 2021
12853eb
feat: add favicon
heitorlessa Feb 9, 2021
e06d584
chore: consistency with metrics
heitorlessa Feb 9, 2021
cdf13f4
feat: docs revision date, smaller TOC, and footer copyright
heitorlessa Feb 9, 2021
aaaff91
improv: enhanced navigation, trimmed content, added more examples
heitorlessa Feb 9, 2021
ac29164
feat: add openGraph and Twitter card, attempt 1
heitorlessa Feb 9, 2021
d5365e0
Update docs/core/tracer.md
heitorlessa Feb 9, 2021
7d1be8c
Update docs/core/tracer.md
heitorlessa Feb 9, 2021
13a4070
docs: set tabs for yaml/json to 2 spaces
Feb 10, 2021
2422d3b
fix: yaml indent for cfn
Feb 10, 2021
fd548e1
fix: formatting yaml cfn
Feb 10, 2021
96524a3
fix: typo in features table
heitorlessa Feb 10, 2021
f2fab62
fix: typo in features table, match sidebar
heitorlessa Feb 10, 2021
7f5b7ed
Merge remote-tracking branch 'am29d/docs/mkdocs' into docs/mkdocs
heitorlessa Feb 10, 2021
12a6827
feat: add built-in search
heitorlessa Feb 10, 2021
9ab143c
fix: broken links
heitorlessa Feb 10, 2021
4ad97f9
improv: bring tenets up, clarify core vs general
heitorlessa Feb 10, 2021
9e38495
fix: broken links
heitorlessa Feb 10, 2021
b7191f0
fix: contrast for layer IAM snippet
heitorlessa Feb 10, 2021
e295ca2
fix: change extra dep to warning; wording
heitorlessa Feb 10, 2021
ad63957
remove ... from cfn docs
Feb 10, 2021
8c71f6b
Merge branch 'docs/mkdocs' of github.com:am29d/aws-lambda-powertools-…
Feb 10, 2021
6ca1d15
fix: width; remove old comments
heitorlessa Feb 10, 2021
5d27c18
improv: add explicit section for LOG_EVENT
heitorlessa Feb 10, 2021
3ce7c94
fix: highlight inject_lambda_context
heitorlessa Feb 10, 2021
7d907b3
feat: add docker-based docs for dev
heitorlessa Feb 10, 2021
2607f1d
chore: copyright to 2021
heitorlessa Feb 10, 2021
51a0ae6
revert: search width
heitorlessa Feb 10, 2021
3495899
chore: Add higher res metrics image
Feb 10, 2021
892dc5f
Merge branch 'docs/mkdocs' of https://github.com/am29d/aws-lambda-pow…
heitorlessa Feb 10, 2021
d340128
chore: remove custom font; correct edit uri
heitorlessa Feb 10, 2021
d63e231
feat: record page view and search pattern
heitorlessa Feb 12, 2021
e03e7f0
feat: add API reference
heitorlessa Feb 12, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/python_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ on:
push:
branches:
- master
- docs/mkdocs
# Disabled until docs support versioning per branch/release
# - develop
release:
Expand Down
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ dev:
pre-commit install

dev-docs:
cd docs && yarn install
pip install "mkdocs-material"

format:
poetry run isort -rc aws_lambda_powertools tests
Expand Down Expand Up @@ -42,11 +42,11 @@ build-docs-api: dev

build-docs-website: dev-docs
mkdir -p dist
cd docs && yarn build
cp -R docs/public/* dist/
mkdocs build
cp -R site/* dist/

docs-local: dev-docs
cd docs && yarn start
mkdocs serve

docs-api-local:
poetry run pdoc --http : aws_lambda_powertools
Expand Down
4 changes: 0 additions & 4 deletions docs/.prettierignore

This file was deleted.

4 changes: 0 additions & 4 deletions docs/.prettierrc

This file was deleted.

Empty file removed docs/api/.gitkeep
Empty file.
287 changes: 0 additions & 287 deletions docs/content/core/metrics.mdx

This file was deleted.

6 changes: 0 additions & 6 deletions docs/content/dummy.md

This file was deleted.

Loading