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.

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

feat: add documentation website #37

Merged
merged 45 commits into from
May 27, 2020
Merged

feat: add documentation website #37

merged 45 commits into from
May 27, 2020

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented May 22, 2020

Issue #, if available: #18

Description of changes:

  • Sections
    • Tracer
    • Logger
    • Metrics
    • Middleware factory
  • Menu
  • Notes component
  • Correct font size
  • Update SVG Icon
  • Add Testing section for each utility
    • Tracer
    • Metrics
  • Enhancements
    • Offline plugin
    • Sitemap plugin
  • Automate doc builds
  • Add info on decorator nesting w/ log_metrics
  • Add debug mode info
  • Add Trace annotation/metadata sub-section
  • Add Tips section
  • Add API docs under /api

Note: Algolia DocsSearch can only be enabled once docs website is deployed; ignoring it for this PR

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

@heitorlessa heitorlessa changed the title docs: add initial docs website [WIP] Add initial docs website May 22, 2020
@heitorlessa heitorlessa self-assigned this May 22, 2020
@heitorlessa heitorlessa changed the title [WIP] Add initial docs website [WIP] Documentation website May 22, 2020
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]>
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]>
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]>
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]>
@heitorlessa heitorlessa changed the title [WIP] Documentation website Documentation website May 27, 2020
@heitorlessa heitorlessa merged commit e51dd10 into develop May 27, 2020
@heitorlessa heitorlessa deleted the feat/docs branch May 27, 2020 16:06
heitorlessa added a commit that referenced this pull request May 27, 2020
* develop:
  feat: add documentation website (#37)
  improv: move away from monorepo due to change in direction (#36)
  fix: #35 duplicate changelog to project root
@heitorlessa heitorlessa added the documentation Improvements or additions to documentation label Jun 3, 2020
@heitorlessa heitorlessa changed the title Documentation website feat: add documentation website Jun 3, 2020
heitorlessa referenced this pull request in heitorlessa/aws-lambda-powertools-python Jun 17, 2020
* docs: add initial docs website

* docs: correct max width from theme

* docs: remove redundant options

* docs: fix env var contents

Signed-off-by: heitorlessa <[email protected]>

* docs: enlarge trace graph

Signed-off-by: heitorlessa <[email protected]>

* docs: fix stale package.json

Signed-off-by: heitorlessa <[email protected]>

* docs: add offline support

Signed-off-by: heitorlessa <[email protected]>

* docs: generate sitemap for docs

Signed-off-by: heitorlessa <[email protected]>

* docs: use bold text for code to ease reading

Signed-off-by: heitorlessa <[email protected]>

* docs: add Logger section

Signed-off-by: heitorlessa <[email protected]>

* docs: fix spacing in Logger

Signed-off-by: heitorlessa <[email protected]>

* docs: add Metrics section

Signed-off-by: heitorlessa <[email protected]>

* fix: add comment in example for odd dimension

Signed-off-by: heitorlessa <[email protected]>

* docs: add Middleware factory section

Signed-off-by: heitorlessa <[email protected]>

* docs: add testing your code section

Signed-off-by: heitorlessa <[email protected]>

* docs: rearrange tenets section

Signed-off-by: heitorlessa <[email protected]>

* docs: add debug mode

Signed-off-by: heitorlessa <[email protected]>

* docs: add helpful resources

Signed-off-by: heitorlessa <[email protected]>

* docs: correct src title

Signed-off-by: heitorlessa <[email protected]>

* docs: fix svg logo

Signed-off-by: heitorlessa <[email protected]>

* docs: typo

Signed-off-by: heitorlessa <[email protected]>

* docs: capitalize resources

Signed-off-by: heitorlessa <[email protected]>

* docs: fix main logo height

Signed-off-by: heitorlessa <[email protected]>

* feat: build docs website workflow

Signed-off-by: heitorlessa <[email protected]>

* fix: remove gatsby CI action

Signed-off-by: heitorlessa <[email protected]>

* chore: debug CI

Signed-off-by: heitorlessa <[email protected]>

* fix: Make syntax

Signed-off-by: heitorlessa <[email protected]>

* chore: remove tmate debugging

Signed-off-by: heitorlessa <[email protected]>

* fix: assets prefix

Signed-off-by: heitorlessa <[email protected]>

* chore: debug build prefix

Signed-off-by: heitorlessa <[email protected]>

* fix: docs target

Signed-off-by: heitorlessa <[email protected]>

* fix: CI attempt 2345678903245

Signed-off-by: heitorlessa <[email protected]>

* fix: content tree

Signed-off-by: heitorlessa <[email protected]>

* chore: debug mkdir utility

Signed-off-by: heitorlessa <[email protected]>

* fix: prefix assets

Signed-off-by: heitorlessa <[email protected]>

* fix: github actions mkdir outdated

Signed-off-by: heitorlessa <[email protected]>

* fix: gatsby build files take 3245678

Signed-off-by: heitorlessa <[email protected]>

* chore: fix api path

Signed-off-by: heitorlessa <[email protected]>

* fix: correct github ref url

Signed-off-by: heitorlessa <[email protected]>

* fix: last fixes for repo url

Signed-off-by: heitorlessa <[email protected]>

* fix: remove DEBUG

Signed-off-by: heitorlessa <[email protected]>

* improv: fix footer resources

Signed-off-by: heitorlessa <[email protected]>

* improv: add local docs target

Signed-off-by: heitorlessa <[email protected]>

* improv: add annotation and metadata info

Signed-off-by: heitorlessa <[email protected]>

* chore: docs build on master only

Signed-off-by: heitorlessa <[email protected]>
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant