Skip to content

Maintenance: Version the documentation #1239

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.

Sign up for GitHub

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

Jump to bottom
Open
1 of 2 tasks
jeromevdl opened this issue Jun 23, 2023 · 2 comments
Open
1 of 2 tasks

Maintenance: Version the documentation #1239

jeromevdl opened this issue Jun 23, 2023 · 2 comments
Assignees
@kozub
Labels
documentation Improvements or additions to documentation maintenance priority:3 Neutral - not a core feature or affects less than 40% of users

Comments

@jeromevdl
Copy link
Contributor

Summary

Currently the documentation is not versioned, unlike Python and Typescript. We should version the doc to be consistent with other runtimes and to prepare for v2.

Why is this needed?

  • Consistency with other runtimes
  • Keep history of changes (doc for a specified version)
  • Preparing v2 (we'll need to have both v1 and v2 available at least)

Which area does this relate to?

Automation, Governance

Solution

See how python is doing: https://github.com/aws-powertools/powertools-lambda-python/blob/develop/.github/workflows/reusable_publish_docs.yml. Check with @sthulb / @heitorlessa.

Acknowledgment
@jeromevdl jeromevdl added documentation Improvements or additions to documentation maintenance labels Jun 23, 2023
@sthulb
Copy link
Contributor

sthulb commented Jun 27, 2023

Python/TS uses a python package called mike to version docs – but in our post GH Pages world, we might want to look into doing this differently.

@kozub
Copy link
Contributor

kozub commented Jul 12, 2023

I'm going to take care of it.

@jeromevdl jeromevdl moved this from Backlog to Working on it in Powertools for AWS Lambda (Java) Jul 17, 2023
@jeromevdl jeromevdl added the priority:3 Neutral - not a core feature or affects less than 40% of users label Jul 17, 2023
kozub added a commit that referenced this issue Jul 18, 2023
@kozub
docs: add support for docs versioning (#1239)
5092119
@kozub kozub mentioned this issue Jul 18, 2023
Merged
kozub added a commit that referenced this issue Jul 21, 2023
@kozub
docs: change configuration to release docs only during the release or…
85200be 
… by hand. Rollback config for building doc for PR. (#1239)
kozub added a commit that referenced this issue Jul 28, 2023
@kozub
docs: Uncomment logic responsible for pushing changes to S3.(#1239)
a9e9ee5
scottgerring added a commit that referenced this issue Jul 28, 2023
@kozub @scottgerring
docs: add support for docs versioning (#1239) (#1293)
3dc8405 
* docs: add support for docs versioning (#1239)

* docs: change configuration to release docs only during the release or by hand. Rollback config for building doc for PR. (#1239)

* docs: Uncomment logic responsible for pushing changes to S3.(#1239)

---------

Co-authored-by: Scott Gerring <[email protected]>
kozub added a commit that referenced this issue Jul 28, 2023
@kozub
docs: add support for docs versioning (#1239)
9132f4a
kozub added a commit that referenced this issue Jul 28, 2023
@kozub
docs: change configuration to release docs only during the release or…
3003180 
… by hand. Rollback config for building doc for PR. (#1239)
kozub added a commit that referenced this issue Jul 28, 2023
@kozub
docs: HotFix - workflow path(#1239)
149777d
kozub added a commit that referenced this issue Jul 28, 2023
@kozub
docs: HotFix - workflow path(#1239)
a5e5349
kozub added a commit that referenced this issue Jul 28, 2023
@kozub
docs: typo. (#1239)
b21855b
scottgerring pushed a commit that referenced this issue Jul 28, 2023
@kozub
docs: versioning - fix typo (#1322)
a0c7d38 
* docs: add support for docs versioning (#1239)

* docs: change configuration to release docs only during the release or by hand. Rollback config for building doc for PR. (#1239)

* docs: HotFix - workflow path(#1239)

* docs: HotFix - workflow path(#1239)

* docs: typo. (#1239)
scottgerring added a commit that referenced this issue Jul 28, 2023
@scottgerring
Revert "docs: add support for docs versioning (#1239) (#1293)"
9e62424 
This reverts commit 3dc8405.
scottgerring added a commit that referenced this issue Jul 28, 2023
@scottgerring
fix: Rollback doc changes (#1323)
bddd99a 
* Revert "docs: versioning - fix typo (#1322)"

This reverts commit a0c7d38.

* Revert "docs: add support for docs versioning (#1239) (#1293)"

This reverts commit 3dc8405.
jeromevdl pushed a commit that referenced this issue Jul 28, 2023
@kozub @jeromevdl
docs: versioning - fix typo (#1322)
d66e1ca 
* docs: add support for docs versioning (#1239)

* docs: change configuration to release docs only during the release or by hand. Rollback config for building doc for PR. (#1239)

* docs: HotFix - workflow path(#1239)

* docs: HotFix - workflow path(#1239)

* docs: typo. (#1239)
jeromevdl pushed a commit that referenced this issue Jul 29, 2023
@scottgerring @jeromevdl
fix: Rollback doc changes (#1323)
9aa9a58 
* Revert "docs: versioning - fix typo (#1322)"

This reverts commit a0c7d38.

* Revert "docs: add support for docs versioning (#1239) (#1293)"

This reverts commit 3dc8405.
kozub added a commit that referenced this issue Aug 16, 2023
@kozub
docs: Add support for docs versioning and publishing docs to S3 with …
9100859 
…version. (#1239)
This was referenced Aug 16, 2023
Closed
Closed
This was linked to pull requests Aug 30, 2023
docs: Add additional workflow for rebuilding old versions of documentation #1371
Closed
docs: Add support for docs versioning (#1239) #1370
Closed
@phipag phipag mentioned this issue Mar 13, 2025
Open
1 task
@phipag phipag moved this from Working on it to On hold in Powertools for AWS Lambda (Java) Mar 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kozub kozub

Labels
documentation Improvements or additions to documentation maintenance priority:3 Neutral - not a core feature or affects less than 40% of users
Projects
Powertools for AWS Lambda (Java)
Status: On hold
Milestone
No milestone
4 participants
@sthulb @jeromevdl @scottgerring @kozub