Skip to content
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

Document release process in the code base #4933

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

abailly
Copy link
Collaborator

@abailly abailly commented Jan 10, 2025

This PR executes on the decision made on the 3rd of December, 2024, to store documentation alongside code.

  • Create a detailed description of the release process in its own page
  • Start recording some of the Advice Process decisions in the documentation for the wallet, under /contributor/decisions tree
  • Add release checklist template

#4934

This PR executes on the decision made on the 3rd of December, 2024, to
store documentation alongside code.

* Create a detailed description of the release process in its own page
* Start recording some of the Advice Process decisions in the
documentation for the wallet, under /contributor/decisions tree
* Add release checklist template
Copy link
Contributor

@HeinrichApfelmus HeinrichApfelmus left a comment

Choose a reason for hiding this comment

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

Looks good to me. Optional suggestions.

| Release archive | E2E tests | nightly | Github Action | 🔵 |
| Docker image | . | post-commit | Buildkite | 🔵 |

Legend: Status 🔵\= working; 🟡= needs work; 🔴\= not working
Copy link
Contributor

Choose a reason for hiding this comment

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

The original decision included more details and a rationale — we don't want to keep those?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No, we want to keep those but I think I moved them to the actual documentation, not in the decision record. Let me check.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

While I did keep the details and rationale for other AP decisions, I removed that one because I felt it was referencing a state of affair that does not make much sense anymore with lot of now irrelevant details, but I am fine with putting it back as after all it's the nature of decisions to become obsolete.

docs/site/src/SUMMARY.md Outdated Show resolved Hide resolved
abailly and others added 3 commits January 16, 2025 18:29
…gration.md

Co-authored-by: Heinrich Apfelmus <apfelmus@quantentunnel.de>
…e.md

Co-authored-by: Heinrich Apfelmus <apfelmus@quantentunnel.de>
Co-authored-by: Heinrich Apfelmus <apfelmus@quantentunnel.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Changing the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants