Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: migrate documentation from Gatsby to MkDocs material #279

Merged
merged 81 commits into from
Feb 12, 2021
Merged

docs: migrate documentation from Gatsby to MkDocs material #279

merged 81 commits into from
Feb 12, 2021

Conversation

am29d
Copy link
Contributor

@am29d am29d commented Feb 2, 2021

Issue #, if available:

Description of changes:

Due to a rather high time investment for documentation maintenance (read: fight npm ecosystem), we decided to move the documentation to MkDocs material. This pull contains the migration of the content to the MkDocs.

Here is the live preview: https://am29d.github.io/aws-lambda-powertools-python/

The github workflow python_docs.yml contains for now the branch docs/mkdocs to have a live preview in my fork. It will be removed once the PR is approved.

Checklist

Breaking change checklist

RFC issue #:

  • Migration process documented
  • Implement warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@am29d am29d added the documentation Improvements or additions to documentation label Feb 2, 2021
@to-mc to-mc self-requested a review February 2, 2021 16:59
to-mc
to-mc suggested changes Feb 2, 2021
View reviewed changes
Copy link
Contributor

@to-mc to-mc left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great changes! Added some comments inline. Not sure if its just me but the content seems quite squashed in the center of the page, so you need to do a bit of side scrolling for some of the code blocks. Can we add a stylesheet to increase the width of .md-grid?

docs/core/tracer.md Show resolved Hide resolved
docs/core/tracer.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/core/logger.md Outdated Show resolved Hide resolved
docs/core/logger.md Outdated Show resolved Hide resolved
docs/utilities/batch.md Outdated Show resolved Hide resolved
docs/utilities/parameters.md Outdated Show resolved Hide resolved
docs/utilities/parameters.md Show resolved Hide resolved
docs/utilities/validation.md Outdated Show resolved Hide resolved
docs/utilities/validation.md Outdated Show resolved Hide resolved
heitorlessa and others added 8 commits February 3, 2021 08:28
@heitorlessa @to-mc
chore: typo in GetCfnTemplate
264a028 
Co-authored-by: Tom McCarthy <tmac.se@gmail.com>
@heitorlessa @to-mc
Update docs/core/logger.md
1fa47d9 
Co-authored-by: Tom McCarthy <tmac.se@gmail.com>
@heitorlessa @to-mc
Update docs/core/logger.md
8f418cb 
Co-authored-by: Tom McCarthy <tmac.se@gmail.com>
@heitorlessa @to-mc
Update docs/utilities/parameters.md
7ddb544 
Co-authored-by: Tom McCarthy <tmac.se@gmail.com>
@heitorlessa @to-mc
Update docs/utilities/validation.md
e425d6d 
Co-authored-by: Tom McCarthy <tmac.se@gmail.com>
@heitorlessa @to-mc
Update docs/utilities/validation.md
36cba90 
Co-authored-by: Tom McCarthy <tmac.se@gmail.com>
@heitorlessa @to-mc
Update docs/utilities/batch.md
4b9ca27 
Co-authored-by: Tom McCarthy <tmac.se@gmail.com>
@heitorlessa @to-mc
Update docs/core/tracer.md
84c8e35 
Co-authored-by: Tom McCarthy <tmac.se@gmail.com>
@heitorlessa
Copy link
Contributor

Great changes! Added some comments inline. Not sure if its just me but the content seems quite squashed in the center of the page, so you need to do a bit of side scrolling for some of the code blocks. Can we add a stylesheet to increase the width of .md-grid?

Same here - Experiment using a max-width between 70rem to 77rem to see how that would look like. You will need an additional CSS and use !important to override the theme.

.md-grid
    max-width: 75rem

I've committed most of @cakepietoast suggestions, so we can spend more time on the larger pieces of content we'll also need to change to best use the content area we have now :)

If you're not comfortable with the CSS pieces, leave that with me - I can also adjust the blockquotes I see on Tom's feedback too.

Alex Melnyk and others added 25 commits February 10, 2021 08:09
docs: set tabs for yaml/json to 2 spaces
13a4070
fix: yaml indent for cfn
2422d3b
fix: formatting yaml cfn
fd548e1
@heitorlessa
fix: typo in features table
96524a3 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
fix: typo in features table, match sidebar
f2fab62 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
Merge remote-tracking branch 'am29d/docs/mkdocs' into docs/mkdocs
7f5b7ed 
* am29d/docs/mkdocs:
  fix: formatting yaml cfn
  fix: yaml indent for cfn
  docs: set tabs for yaml/json to 2 spaces
  Update docs/core/tracer.md
  Update docs/core/tracer.md
@heitorlessa
feat: add built-in search
12a6827 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
fix: broken links
9ab143c 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
improv: bring tenets up, clarify core vs general
4ad97f9 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
fix: broken links
9e38495 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
fix: contrast for layer IAM snippet
b7191f0 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
fix: change extra dep to warning; wording
e295ca2 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
remove ... from cfn docs
ad63957
Merge branch 'docs/mkdocs' of github.com:am29d/aws-lambda-powertools-…
8c71f6b 
…python into docs/mkdocs
@heitorlessa
fix: width; remove old comments
6ca1d15 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
improv: add explicit section for LOG_EVENT
5d27c18 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
fix: highlight inject_lambda_context
3ce7c94 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
feat: add docker-based docs for dev
7d907b3 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
chore: copyright to 2021
2607f1d 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
revert: search width
51a0ae6 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
chore: Add higher res metrics image
3495899
@heitorlessa
Merge branch 'docs/mkdocs' of https://github.com/am29d/aws-lambda-pow…
892dc5f 
…ertools-python into docs/mkdocs

* 'docs/mkdocs' of https://github.com/am29d/aws-lambda-powertools-python:
  chore: Add higher res metrics image
@heitorlessa
chore: remove custom font; correct edit uri
d340128 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
feat: record page view and search pattern
d63e231 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
feat: add API reference
e03e7f0 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa heitorlessa changed the title docs: migrate documentation to MkDocs material docs: migrate documentation from Gatsby to MkDocs material Feb 12, 2021
@heitorlessa
Copy link
Contributor

THANK YOU to everyone who helped us in this migration from Gatsby to MKdocs.. in no particular order

@am29d @michaelbrewer @cakepietoast @Nr18

This should be out today

@heitorlessa heitorlessa merged commit fc08062 into aws-powertools:develop Feb 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Nr18 Nr18 Nr18 left review comments

@heitorlessa heitorlessa heitorlessa approved these changes

@to-mc to-mc to-mc approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@am29d @heitorlessa @codecov-io @michaelbrewer @Nr18 @to-mc