-
Notifications
You must be signed in to change notification settings - Fork 421
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
Conversation
There was a problem hiding this comment.
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
?
Co-authored-by: Tom McCarthy <[email protected]>
Co-authored-by: Tom McCarthy <[email protected]>
Co-authored-by: Tom McCarthy <[email protected]>
Co-authored-by: Tom McCarthy <[email protected]>
Co-authored-by: Tom McCarthy <[email protected]>
Co-authored-by: Tom McCarthy <[email protected]>
Co-authored-by: Tom McCarthy <[email protected]>
Co-authored-by: Tom McCarthy <[email protected]>
Same here - Experiment using a .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 |
Signed-off-by: heitorlessa <[email protected]>
Signed-off-by: heitorlessa <[email protected]>
* 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
Signed-off-by: heitorlessa <[email protected]>
Signed-off-by: heitorlessa <[email protected]>
Signed-off-by: heitorlessa <[email protected]>
Signed-off-by: heitorlessa <[email protected]>
Signed-off-by: heitorlessa <[email protected]>
Signed-off-by: heitorlessa <[email protected]>
…python into docs/mkdocs
Signed-off-by: heitorlessa <[email protected]>
Signed-off-by: heitorlessa <[email protected]>
Signed-off-by: heitorlessa <[email protected]>
Signed-off-by: heitorlessa <[email protected]>
Signed-off-by: heitorlessa <[email protected]>
Signed-off-by: heitorlessa <[email protected]>
…ertools-python into docs/mkdocs * 'docs/mkdocs' of https://github.com/am29d/aws-lambda-powertools-python: chore: Add higher res metrics image
Signed-off-by: heitorlessa <[email protected]>
Signed-off-by: heitorlessa <[email protected]>
Signed-off-by: heitorlessa <[email protected]>
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 |
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 branchdocs/mkdocs
to have a live preview in my fork. It will be removed once the PR is approved.Checklist
Breaking change checklist
RFC issue #:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.