Skip to content

docs(maintenance): retire stale process docs - #5618

Draft
dreamorosi wants to merge 1 commit into
mainfrom
docs/retire-stale-process-docs
Draft

docs(maintenance): retire stale process docs#5618
dreamorosi wants to merge 1 commit into
mainfrom
docs/retire-stale-process-docs

Conversation

@dreamorosi

Copy link
Copy Markdown
Contributor

Summary

Retires stale process pages that remained published after their removal from the MkDocs navigation in #5426. Consolidates the current contributor and maintainer guidance in the repository root and refreshes related links and examples. This PR is a draft while a few documentation placement decisions remain open.

Changes

  • Removed the stale 2025 roadmap, the published maintainers page, and docs/contributing/*. Most roadmap items have shipped, and its public-roadmap framing no longer matches the project's stance.
  • Moved the maintainers' operational playbook into MAINTAINERS.md and checked it against current workflows. This includes releases, npm name reservation, package and CI wiring, Region and layer publishing through bootstrap_region.yml and layer_balance.yml, and a label table rebuilt from the repository's current labels. Retired aspirational governance content and fixed about six broken links.
  • Moved the non-obvious contributor guidance into CONTRIBUTING.md, including development requirements, end-to-end tests and their cost warning, direct ?template= issue links, and RFC Discussions. Updated the pull request requirements and replaced duplicate convention and testing tables with links to CODING_STANDARDS.md and AGENTS.md.
  • Corrected the test directory name and documented unpublished workspaces in CODING_STANDARDS.md. Removed the Roadmap link and changed the Parser install example from zod@~3 to zod in README.md.
  • Changed the RFC reference from an issue to a Discussion and refreshed runtime examples in docs/versioning.md. Fixed malformed iframes and replaced Twitter with X in docs/we_made_this.md.
  • Verified that markdownlint is clean, mkdocs build passes, and no links to the deleted pages remain.
  • Left follow-up decisions open for the RFC review checklist location, the serviceName convention placement, and the tenets anchor.

Issue number: n/a — maintenance cleanup


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

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

Move current contributor and maintainer guidance into the root documents and remove stale published process pages. Refresh related links and examples so the remaining documentation matches current project workflows.
@powertools-for-aws-oss-automation powertools-for-aws-oss-automation Bot added the size/XXL PRs with 1K+ LOC, largely documentation related label Sep 3, 2026
Comment thread CONTRIBUTING.md
<!-- markdownlint-disable MD013 -->
[When filing an issue](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new/choose), please check [existing open](https://github.com/aws-powertools/powertools-lambda-typescript/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc), or [recently closed](https://github.com/aws-powertools/powertools-lambda-typescript/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can.
<!-- markdownlint-enable MD013 -->
Still nothing that matches your skill set? Say so on [GitHub Discussions](https://github.com/aws-powertools/powertools-lambda-typescript/discussions) — especially if you'd like mentoring on something you don't feel ready for yet. Contributions are meant to be bi-directional; there's always something we can learn from each other.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove this

Comment thread CONTRIBUTING.md

We welcome you to use the GitHub issue tracker to report bugs, suggest features, or documentation improvements.
- **Documentation.** Look for places that could use a clearer example or a diagram, and keep in mind a diverse audience that often reads English as a second language.
- **Sample applications.** Using Powertools for AWS Lambda in a new context surfaces rough edges we can't see from the inside.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove this and adapt the section, we'll retire the sample app in this repo in a future PR

Comment thread MAINTAINERS.md

| Maintainer | GitHub ID | Affiliation |
| -------------------------- | ----------------------------------------------- | ----------- |
| Alexander Schueren | [am29d](https://github.com/am29d) | |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Affiliation is now OpenAI

Comment thread MAINTAINERS.md
| Maintainer | GitHub ID | Affiliation |
| -------------------------- | ----------------------------------------------- | ----------- |
| Alexander Schueren | [am29d](https://github.com/am29d) | |
| Simon Thulbourn | [sthulb](https://github.com/sthulb) | Amazon |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Affiliation is now empty

Comment thread MAINTAINERS.md
| Alexander Schueren | [am29d](https://github.com/am29d) | |
| Simon Thulbourn | [sthulb](https://github.com/sthulb) | Amazon |
| Sara Gerion | [saragerion](https://github.com/saragerion) | Amazon |
| Florian Chazal | [flochaz](https://github.com/flochaz) | Amazon |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Affiliation is now empty

Comment thread MAINTAINERS.md
| Label | Usage | Applied by |
| --------------------------------- | --------------------------------------------------------------------- | -------------------------------------------------------- |
| `triage` | Not yet triaged; remove it once you've validated the request or repro | Issue templates |
| `confirmed` | Scope is clear and it's ready for implementation | Manual |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's remove this, let's make confirmed state implicit by the absence of other blocking labels - also archive the label

Comment thread MAINTAINERS.md
Comment on lines +41 to +42
| `discussing` | Needs to be discussed, elaborated, or refined | Manual |
| `researching` | Under consideration; we'll update once we know more | Manual |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge these into one, archive the other - very similar anyway

Comment thread MAINTAINERS.md
| `rejected` | We won't work on this, at least not in the foreseeable future | `.github/workflows/stale-issues.yml` on close, or manual |
| `blocked` | Progress is blocked by an external dependency or reason | Manual |
| `on-hold` | Parked and will be revisited in the future | Manual |
| `revisit-in-3-months` | Parked with a rough timer, often paired with `need-customer-feedback` | Manual |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Retire this and archive the label

Comment thread MAINTAINERS.md
| `on-hold` | Parked and will be revisited in the future | Manual |
| `revisit-in-3-months` | Parked with a rough timer, often paired with `need-customer-feedback` | Manual |
| `next-major-version` | Deferred to the next major version | Manual |
| `duplicate` | Duplicate of an existing item | Manual |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Retire this and archive label, same can be done with issue closing reason

Comment thread MAINTAINERS.md
| `need-customer-feedback` | Needs more customer input before deciding or revisiting a decision | Manual |
| `need-response` | Waiting on the author; opts the issue into the stale automation | Manual |
| `pending-close-response-required` | Went stale waiting for a response and will be closed unless it moves | `.github/workflows/stale-issues.yml` |
| `rejected` | We won't work on this, at least not in the foreseeable future | `.github/workflows/stale-issues.yml` on close, or manual |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Retire this and archive, same can be done with issue closing reason

Comment thread MAINTAINERS.md
| `next-major-version` | Deferred to the next major version | Manual |
| `duplicate` | Duplicate of an existing item | Manual |
| `pending-release` | Merged and shipping in the next release | Manual, when merging the PR |
| `completed` | Shipped | `.github/workflows/post-release.yml` |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this and archive label, closed issue already means that

Comment thread MAINTAINERS.md
Comment on lines +66 to +68
| `RFC` | Technical design document related to a feature request | Manual |
| `deprecation` | Contains code deprecation | Manual |
| `breaking-change` | Customer-impacting change that needs careful triage | Manual |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove and archive all three

Comment thread MAINTAINERS.md
| Label | Usage | Applied by |
| -------------------- | ---------------------------------------------------------------------------------- | ----------------------------------------------- |
| `bug` | Unexpected, reproducible, unintended runtime behavior | `bug_report.yml` issue template |
| `not-a-bug` | Reported as a bug but isn't one, see [What counts as a bug](#what-counts-as-a-bug) | Manual |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove and archive, a bug report that is not a bug becomes a closed as not planned

Comment thread MAINTAINERS.md

| Label | Usage | Applied by |
| -------------------- | ---------------------------------------------------------------------------------- | ----------------------------------------------- |
| `bug` | Unexpected, reproducible, unintended runtime behavior | `bug_report.yml` issue template |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this, the feature-request, documentation, and internal and archive them, we'll use Issue Types instead

Comment thread MAINTAINERS.md

Area labels flag which part of the library an item belongs to: `logger`, `metrics`, `tracer`, `parameters`, `idempotency`, `batch`, `parser`, `validation`, `jmespath`, `event-handler`, `commons`, `layers`, and `automation` for CI/CD and workflows.

All of them are applied manually — nothing labels PRs by changed files anymore. There is no area label yet for `data-masking`, `kafka`, or `signer`.

@dreamorosi dreamorosi Sep 3, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this statement, create the missing labels

Comment thread MAINTAINERS.md
Comment on lines +82 to +84
| `feature` | Introduces a new feature; groups the PR in the drafted release notes | Manual |
| `enhancement` | Minor change, usually to an existing feature | Manual |
| `tests` | Adds or changes tests | Manual |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove all manual ones and archive the label

Comment thread MAINTAINERS.md

PR titles must follow [Conventional Commits](https://www.conventionalcommits.org/) — they feed the [changelog](./CHANGELOG.md) and the drafted release notes, so make sure they read well to a human. PR titles, related issues, and the acknowledgment checkbox are enforced by organization-level checks, not by workflows in this repository.

When merging a PR that closes an issue, apply `pending-release` to the issue. `.github/workflows/post-release.yml` swaps it for `completed` on every closed issue once the GitHub release is published.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both are applied automatically

Comment thread MAINTAINERS.md

When merging a PR that closes an issue, apply `pending-release` to the issue. `.github/workflows/post-release.yml` swaps it for `completed` on every closed issue once the GitHub release is published.

### Automation you can rely on

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this entire section

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XXL PRs with 1K+ LOC, largely documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant