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

Update version information in docs (+ minor other fixes) #1051

Merged
merged 4 commits into from
Jul 5, 2024

Conversation

osnyx
Copy link
Member

@osnyx osnyx commented Jul 5, 2024

Note that this PR only contains information from the upstream NixOS changelog affecting one of our roles.
Other (breaking or noteworthy) changes are left for PL-132661.

PL-132670

@flyingcircusio/release-managers

Release process

Impact: -

Changelog: -

PR release workflow (internal)

  • PR has internal ticket
  • internal issue ID (PL-…) part of branch name
  • internal issue ID mentioned in PR description text
  • ticket is on 24.05 agile board
  • ticket state set to Pull request ready
  • if ticket is more urgent than within the next few days, directly contact a member of the Platform team

Design notes

  • Provide a feature toggle if the change might need to be adjusted/reverted quickly depending on context. Consider whether the default should be on or off. Example: rate limiting.
  • All customer-facing features and (NixOS) options need to be discoverable from documentation. Add or update relevant documentation such that hosted and guided customers can understand it as well.

Security implications

  • Security requirements defined? (WHERE)
    • documentation needs to reflect the current state of the release
    • provide information about major version changes an breaking changes
    • availability: documentation still builds
  • Security requirements tested? (EVIDENCE)
    • skimmed the build result of the docs

osnyx added 4 commits July 5, 2024 02:28
I went through the docs and update all outdated version numbers I could
find, both of the platform itself as well as components and packages.

Additionally:
- fix some typos
- improve some unclear phrasing
- refer to search.flyingcircus.io as well

PL-132670
We've massively rebuilt the devhost away from containers towards VMs.
But for now that component still runs on 21.05 hardware, so
documentation is just copied from there.

Leaving this file as rst to allow keeping both branches synchronised.

PL-132670
Copy link
Member

@dpausp dpausp left a comment

Choose a reason for hiding this comment

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

re-check/update channel URLs after first release (also in release checklist)

@dpausp dpausp merged commit 2e526ea into fc-24.05-dev Jul 5, 2024
2 checks passed
@dpausp dpausp deleted the PL-132670-doc-versions branch July 5, 2024 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants