Skip to content

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented Mar 30, 2021

Issue #, if available:

Description of changes:

This will address a common challenge of having staged changes not being visible in the documentation, or the need for banners like New in X due to not having docs related to a particular release.

  • Include mike in mkdocs.yml
  • Configure versions and alias
  • Automate versioned deploys for develop and upon new releases
  • Version API ref docs per develop as well as releases e.g., /develop/api, /1.15.0/api
  • Create redirect from old links to latest alias

Demo: https://heitorlessa.github.io/powertools-docs-versioning/latest/

This will introduce a /<version> in the URL and will break bookmark links, since GH Pages doesn't support redirects. Redirecting might work with mkdocs-redirects plugin, though we might reactively fix it as I'm not sure whether pages have been bookmarked as >90% of customers come straight to index then navigate.

Update: Thanks to @saragerion, including a 404.html in the root of GH Pages works to preserve old docs to latest version.

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.

@heitorlessa heitorlessa added documentation Improvements or additions to documentation feature New feature or functionality labels Mar 30, 2021
@heitorlessa heitorlessa marked this pull request as draft March 30, 2021 12:52
@heitorlessa heitorlessa added this to the 1.14.0 milestone Mar 30, 2021
@heitorlessa heitorlessa marked this pull request as ready for review March 30, 2021 15:41
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
* develop: fix(idempotent): Correctly raise IdempotencyKeyError (#378) feat(event-handler): Add AppSync handler decorator (#363) feat(parameter): add dynamodb_endpoint_url for local_testing (#376) fix(parser): S3Model support empty keys (#375) fix(data-classes): Add missing operationName (#373) fix: perf tests for Logger and fail str msgs feat(parser): Add S3 Object Lambda Event (#362) build(pre-commit): Add pre-commit to make pr (#368) fix(tracer): Correct type hint for MyPy (#365) fix(metrics): AttributeError raised by MediaManager and Typing and docs (#357) Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa heitorlessa merged commit da3aa5d into aws-powertools:develop Apr 5, 2021
@heitorlessa heitorlessa deleted the docs/versioning branch April 5, 2021 09:15
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 feature New feature or functionality

1 participant