Skip to content

Maintenance: docs versioning & labels #1421

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

Closed
1 of 2 tasks
dreamorosi opened this issue Apr 25, 2023 · 2 comments · Fixed by #1433
Closed
1 of 2 tasks

Maintenance: docs versioning & labels #1421

dreamorosi opened this issue Apr 25, 2023 · 2 comments · Fixed by #1433
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Comments

@dreamorosi
Copy link
Contributor

Summary

While working on the docs I have realized that the when we touched the workflow that publishes the docs a couple of months ago we have broken the labeling/versioning.

Currently the docs that should be published as staging/dev when the docs are merged are not selectable, and the version label has changed convention which conflicts with the ordering of the labels in the docs dropdown.

image

Why is this needed?

Because currently we are unable to:

  • Select the stage label to see the docs once they are merged
  • Select the labels in chronological order with most recent on top (currently v1.8.0 which is latest is towards the bottom of the dropdown)

Which area does this relate to?

Automation

Solution

Ideally, we should get to a state that has:

  • All the version numbers without the v prefix - this way we maintain the ordering in the dropdown with the more recent on top
  • Remove all orphan labels like dev, main, and the ones that start with v (i.e. v1.7.0 and v1.8.0)
  • When docs are merged to main, they are published under stage, which should appear in the dropdown as last (at the bottom)

Acknowledgment

Future readers

Please react with 👍 and your use case to help us understand customer demand.

@dreamorosi dreamorosi added documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) confirmed The scope is clear, ready for implementation labels Apr 25, 2023
@dreamorosi dreamorosi linked a pull request Apr 27, 2023 that will close this issue
13 tasks
@dreamorosi dreamorosi assigned dreamorosi and unassigned am29d May 4, 2023
@dreamorosi dreamorosi moved this from Backlog to Working on it in AWS Lambda Powertools for TypeScript May 4, 2023
@dreamorosi
Copy link
Contributor Author

I'll be working on this one, we can't rebuild the docs until this is fixed.

@github-actions
Copy link
Contributor

github-actions bot commented May 4, 2023

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot added the pending-release This item has been merged and will be released soon label May 4, 2023
@dreamorosi dreamorosi added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon confirmed The scope is clear, ready for implementation labels May 4, 2023
@dreamorosi dreamorosi moved this from Coming soon to Shipped in AWS Lambda Powertools for TypeScript May 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)
Projects
None yet
2 participants