Skip to content

Docs changes needed when 2.0 goes stable #596

Description

@karl-bullock

Several pages are written for the release-candidate period and become wrong the moment 2.0 is tagged stable. Collecting the exact spots here so they can be ticked off on release day rather than found afterwards. If this is already tracked somewhere I cannot see, ignore me.

  • install.md, the :::warning near the top: "Flarum 2.0 is in its release-candidate phase ... it isn't the final stable release yet, so back up your data and test before relying on it."
  • install.md, the install command: composer create-project flarum/flarum:^2.0.0 --stability=beta . no longer needs --stability=beta.
  • install.md, the archive table, which currently lists 2.0.0-rc.8 across twelve rows. This already has a routine (Update 2.x install download links for v2.0.0-rc.6 #580, Update 2.x install download links for v2.0.0-rc.7 #582, Update 2.x install download links for v2.0.0-rc.8 #583), so presumably one more run of it against the stable tag.
  • update.md, the matching :::warning at the top of the page.
  • update.md, step 5 "Set minimum-stability to beta". Its own :::info already tells people to change it back to stable once 2.0 is out, so the step itself probably wants removing, which renumbers steps 6 to 8.
  • extend/update-2_0.md: "Set flarum/core package requirement to ^2.0.0-beta" becomes ^2.0.

Two optional notes while in the area:

  • releases.md is currently a heading plus a link to the forum, with an older TODO commented out above it. A stable release seems like the moment that page gets attention, if it is going to.
  • Nothing appears to be needed for the Docusaurus versioning itself: docs/ is already the current version labelled 2.x with 1.x archived alongside it, which is the right shape for a stable 2.0.

The first six are all mechanical. I am happy to open that PR once the tag exists if it saves anyone the trouble, just say so.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions