docs(maintenance): retire stale process docs - #5618
Open
dreamorosi wants to merge 7 commits into
Open
Conversation
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.
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
dreamorosi
commented
Sep 3, 2026
Trim the label tables down to what we still use. Issue type now comes from GitHub Issue Types, and duplicates or work we won't pick up are closed with a close reason instead of a label, so the labels that covered both are archived. Keep the automation in step: the stale workflow no longer applies `rejected` on close and no longer exempts labels that are gone, and the post-release script only removes `pending-release` rather than swapping it for `completed`. Also refresh emeritus affiliations and drop sample applications from the contribution entry points, since that app is on its way out.
Removed the stale-issues.yml workflow and updated MAINTAINERS.md to reference organization-level automation instead. - deleted .github/workflows/stale-issues.yml - updated label descriptions in MAINTAINERS.md to reference org-level stale automation This aligns with the organization's move to handle stale issue automation at the org level rather than in this repository.
This was referenced Sep 4, 2026
Org-level automation now handles pending-release label management via GitHub organization settings. This removes the need for the repository's post-release workflow and script. - Remove .github/workflows/post-release.yml - Remove .github/scripts/post_release.js - Update MAINTAINERS.md to document org-level automation for pending-release All label management is now handled exclusively by organization-level automation, eliminating repository-specific release maintenance.
…ology Changes institutional-level automation references to standardize with other organization-level terminology throughout the document.
dreamorosi
marked this pull request as ready for review
September 4, 2026 22:43
svozza
reviewed
Sep 5, 2026
| - **Node.js 24.x**, the version pinned in `.nvmrc`, so `nvm use` or `fnm use` picks it up. npm 11.x ships with it; this is an npm workspaces monorepo, so always install from the repo root rather than from a package directory. | ||
| - **Docker**, only to preview the documentation with `npm run docs:docker:*`. Nothing else in the repo needs it. | ||
| - **Python 3**, only to preview the documentation without Docker, with `npm run docs:local:*`. | ||
| - **An AWS account and the AWS CLI**, only to run [end-to-end tests](#end-to-end-tests). |
Contributor
There was a problem hiding this comment.
Nit: you don't really install an AWS account. Should we call this list pre-requisites?
|
|
||
| 1. Create a branch named after the change you are contributing, e.g. `improv/logger-debug-sampling`. | ||
| 2. Commit to your fork using clear commit messages. Don't worry about the commit format — we squash every pull request on merge. | ||
| 3. Make sure the Git hooks pass. The pre-commit hook lints and formats staged files; the pre-push hook type-checks the tests and runs the unit tests with the 100% coverage threshold. |
Contributor
There was a problem hiding this comment.
I have often seen agents skip this step if they encounter an issue running theses, especially in Git workspaces, should we make this wording more emphatic?
|
|
||
| ## Releasing a new version | ||
|
|
||
| It takes a few hours end to end, most of it spent waiting on the layer rollout and on the two PRs that need a human review. |
Contributor
There was a problem hiding this comment.
Don't think this even takes an hour now that we've automated most of it.
| - copies the layer into the GovCloud and China partitions, Gamma then Prod, both in parallel; | ||
| - opens a `chore(ci): update layer ARN on documentation` PR once all three Prod deployments are done. | ||
| 6. **Review and merge the layer ARN docs PR.** `.github/workflows/on_layer_docs_pr_merge.yml` picks up the merge and dispatches `Rebuild latest docs`, which republishes the user guide and API reference. | ||
| 7. **Draft and publish the release notes** (see below). Organization-level automation removes `pending-release` from shipped issues once the release is published. |
Contributor
There was a problem hiding this comment.
Not for this PR but we should make an agent skill for this.
| @@ -1,93 +0,0 @@ | |||
| --- | |||
Contributor
There was a problem hiding this comment.
This is very useful information, especially for agents. Am I missing something that this info has not moved to a different location so we're just deleting it?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Retires stale process pages that remained published after their removal from the MkDocs navigation in #5426. Consolidates current contributor and maintainer guidance in the repository root, removes repository automation superseded at the organization level, and refreshes related references and examples.
Changes
.github/workflows/stale-issues.yml,.github/workflows/post-release.yml, and.github/scripts/post_release.js, all superseded by organization-level automation.Issue number: closes #5636
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.