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 Algolia search for docs #39

Merged
merged 1 commit into from
May 28, 2020
Merged

feat: add Algolia search for docs #39

merged 1 commit into from
May 28, 2020

Conversation

heitorlessa
Copy link
Contributor

Signed-off-by: heitorlessa lessa@amazon.co.uk

Issue #, if available: #37

Description of changes:

This completes the docs experience by including a search for both docs, and API docs.

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

Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa heitorlessa self-assigned this May 28, 2020
@heitorlessa heitorlessa merged commit 3403e71 into develop May 28, 2020
@heitorlessa heitorlessa added this to Done in Python - GA via automation May 28, 2020
@heitorlessa heitorlessa deleted the feat/docs-search branch May 28, 2020 08:58
heitorlessa added a commit that referenced this pull request May 28, 2020
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
heitorlessa added a commit that referenced this pull request May 28, 2020
* develop:
  Docs: fix minor UX issues (#42)
  feat: add algolia search for docs and api ref (#39)
heitorlessa added a commit that referenced this pull request May 29, 2020
* [Sync Master] 0.7.0 release (#22)

* docs: add pypi badge

* fix: add missing single_metric example; test var name

* chore: pypi monthly download badge

* chore: fix github badge typo

* feat: add docs to CI

* fix: CI attempt 2

* fix: CI attempt 3

* fix: CI attempt 3

* fix: CI attempt 4

* chore: clean up CI workflows

* Decorator factory Feat: Create your own middleware (#17)

* feat(utils): add decorator factory

* improv: use partial to reduce complexity

* improv: add error handling

* chore: type hint

* docs: include pypi downloads badge

* feat: opt in to trace each middleware that runs

* improv: add initial util tests

* improv: test explicit and implicit trace_execution

* improv: test decorator with params

* chore: linting

* docs: include utilities

* improv: correct tests, dec_factory only for func

* improv: make util name more explicit

* improv: doc trace_execution, fix casting

* docs: add limitations, improve syntax

* docs: use new docs syntax

* fix: remove middleware decorator from libs

* feat: build docs in CI

* chore: linting

* fix: CI python-version type

* chore: remove docs CI

* chore: kick CI

* chore: include build badge master branch

* chore: refactor naming

* fix: rearrange tracing tests

* improv(tracer): toggle default auto patching

* feat(tracer): retrieve registered class instance

* fix(Makefile):  make cov target more explicit

* improv(Register): support multiple classes reg.

* improv(Register): inject class methods correctly

* docs: add how to reutilize Tracer

* improv(tracer): test auto patch method

* improv: address nicolas feedback

* improv: update example to reflect middleware feat

* fix: metric dimension in root blob

* chore: version bump

Co-authored-by: heitorlessa <lessa@amazon.co.uk>

Co-authored-by: heitorlessa <lessa@amazon.co.uk>

* feat: add algolia search for docs and api ref (#39) (#40)

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* fix: revert makefile build-docs-api

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* fix: metric_set reuse #43

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* fix: clear metrics

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* fix: update serialize_metrics helper function to use MetricManager instead of Metrics

* fix: clear metrics after lambda invocation #43

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* improv: document metrics tests, remove redundants

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

#43

* chore: linting

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* docs: add section to flush metrics manually

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* docs: include EMF Json object

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* chore: bump version 0.9.4

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

Co-authored-by: Tom McCarthy <thommcc@amazon.com>
@heitorlessa heitorlessa added documentation Improvements or additions to documentation and removed enhancement labels Jun 3, 2020
@heitorlessa heitorlessa changed the title Add Algolia search for docs and API reference feat: add Algolia search for docs and API reference Jun 3, 2020
@heitorlessa heitorlessa changed the title feat: add Algolia search for docs and API reference feat: add Algolia search for docs Jun 3, 2020
heitorlessa referenced this pull request in heitorlessa/aws-lambda-powertools-python Jun 17, 2020
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
heitorlessa referenced this pull request in heitorlessa/aws-lambda-powertools-python Jun 17, 2020
* [Sync Master] 0.7.0 release (#22)

* docs: add pypi badge

* fix: add missing single_metric example; test var name

* chore: pypi monthly download badge

* chore: fix github badge typo

* feat: add docs to CI

* fix: CI attempt 2

* fix: CI attempt 3

* fix: CI attempt 3

* fix: CI attempt 4

* chore: clean up CI workflows

* Decorator factory Feat: Create your own middleware (#17)

* feat(utils): add decorator factory

* improv: use partial to reduce complexity

* improv: add error handling

* chore: type hint

* docs: include pypi downloads badge

* feat: opt in to trace each middleware that runs

* improv: add initial util tests

* improv: test explicit and implicit trace_execution

* improv: test decorator with params

* chore: linting

* docs: include utilities

* improv: correct tests, dec_factory only for func

* improv: make util name more explicit

* improv: doc trace_execution, fix casting

* docs: add limitations, improve syntax

* docs: use new docs syntax

* fix: remove middleware decorator from libs

* feat: build docs in CI

* chore: linting

* fix: CI python-version type

* chore: remove docs CI

* chore: kick CI

* chore: include build badge master branch

* chore: refactor naming

* fix: rearrange tracing tests

* improv(tracer): toggle default auto patching

* feat(tracer): retrieve registered class instance

* fix(Makefile):  make cov target more explicit

* improv(Register): support multiple classes reg.

* improv(Register): inject class methods correctly

* docs: add how to reutilize Tracer

* improv(tracer): test auto patch method

* improv: address nicolas feedback

* improv: update example to reflect middleware feat

* fix: metric dimension in root blob

* chore: version bump

Co-authored-by: heitorlessa <lessa@amazon.co.uk>

Co-authored-by: heitorlessa <lessa@amazon.co.uk>

* feat: add algolia search for docs and api ref (#39) (#40)

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* fix: revert makefile build-docs-api

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* fix: metric_set reuse #43

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* fix: clear metrics

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* fix: update serialize_metrics helper function to use MetricManager instead of Metrics

* fix: clear metrics after lambda invocation #43

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* improv: document metrics tests, remove redundants

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

#43

* chore: linting

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* docs: add section to flush metrics manually

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* docs: include EMF Json object

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

* chore: bump version 0.9.4

Signed-off-by: heitorlessa <lessa@amazon.co.uk>

Co-authored-by: Tom McCarthy <thommcc@amazon.com>
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
No open projects
Python - GA
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

1 participant