docs(v2): Create upgrade guide and versioning policy #1856
Conversation
…lms.txt plugin. Make Idempotency documentation environment variable naming consistent. Fix documentation formatting issue in FAQ.md.
phipag
added
documentation
github-project-automation
bot
moved this to Pending review
in Powertools for AWS Lambda (Java)
Co-authored-by: Stefano Vozza <[email protected]>
Co-authored-by: Stefano Vozza <[email protected]>
Co-authored-by: Stefano Vozza <[email protected]>
|
Co-authored-by: Stefano Vozza <[email protected]>
Co-authored-by: Stefano Vozza <[email protected]>
Co-authored-by: Stefano Vozza <[email protected]>
Co-authored-by: Stefano Vozza <[email protected]>
Co-authored-by: Leandro Damascena <[email protected]>
| @@ -1,10 +1,11 @@ | |||
| site_name: Powertools for AWS Lambda (Java) Preview | |||
| site_description: Powertools for AWS Lambda (Java) Preview | |||
| site_author: Amazon Web Services | |||
| site_url: https://docs.powertools.aws.dev/lambda-java/ | |||
| site_url: https://docs.powertools.aws.dev/lambda/java/preview/ | |||
There was a problem hiding this comment.
Why the /preview suffix?
There was a problem hiding this comment.
I think we should handle versioning differently and keep the base url intact (SEO and all that stuff).
In a nutshell, we need to add a versions.json file like this one with the two versions in this case that we want to show and mkdocs should pick it up.
For now latest would be whatever is on alias v1 and next (or something else) would be preview. Closer to v2 release we can swap them and rename v1 as legacy or just v1 but the base url always stays the same.
MKdocs also has the ability to automatically add a top-banner that informs readers they're not on the latest version.
|
Issue #, if available: #1804
Description of changes:
Rendered preview: https://dealn7fl31ram.cloudfront.net/upgrade/
This documentation update contains smaller fixes and a comprehensive upgrade from v1 to v2. This will be treated as a living document and will be updated as breaking changes happen during developer preview.
Checklist