Skip to content

docs(plugin): add mermaid to create diagram as code #1070

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 1 commit into from
Mar 9, 2022
Merged

docs(plugin): add mermaid to create diagram as code #1070

merged 1 commit into from
Mar 9, 2022

Conversation

dreamorosi
Copy link
Contributor

Issue #, if available: N/A but discussed directly with maintainers

Description of changes:

This PR adds the plugin that allows to use mermaid diagrams in the MKDocs documentation as discussed internally.

image

Note: the diagram above is provided only as an aid for review, it is not part of the actual commit.

Additionally I also updated the year in copyright notice that is in the footer of the docs to the correct year (it was still 2021).

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.

@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 8, 2022
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Mar 8, 2022
@codecov-commenter
Copy link

codecov-commenter commented Mar 8, 2022

Codecov Report

Merging #1070 (abaeed3) into develop (2a3ff9a) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1070   +/-   ##
========================================
  Coverage    99.96%   99.96%           
========================================
  Files          119      119           
  Lines         5365     5365           
  Branches       612      612           
========================================
  Hits          5363     5363           
  Partials         2        2           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2a3ff9a...abaeed3. Read the comment docs.

@heitorlessa
Copy link
Contributor

Thank you so much @dreamorosi !!!!

@heitorlessa heitorlessa changed the title build(dev-deps): added mermaid plugin to docs docs(plugin): add mermaid to create diagram as code Mar 9, 2022
@heitorlessa heitorlessa merged commit 0ba2ad7 into aws-powertools:develop Mar 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants