Repository navigation
Lists the upgrading page in the HexDocs sidebar - #268
Merged
Merged
Conversation
docs/upgrading.md was not among the docs extras, so a host reading HexDocs never reached the upgrade guide. It is now an extra under its own Upgrading group, after the How-to guides, Reference and Explanation groups, as the router lists its own upgrading page. The README links the page by its GitHub URL, so package()'s files: list is unchanged. Docs only: no changelog fragment (changelog.d/README.md excludes documentation). Refs: sp-ricm
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
1 participant
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.
What
docs/upgrading.mdis now a HexDocs extra, listed inmix.exs'sdocs()under its ownUpgradinggroup after the How-to guides, Reference and Explanation groups. Before this change the page was not an extra, so a host reading HexDocs never reached the upgrade guide; only GitHub links did. The router lists its own upgrading page the same way (Upgrading: ["docs/upgrading.md"]).The comment above the groups names the new group in the family order and is rewrapped; nothing else in
mix.exschanges.What stays the same
package()'sfiles:list is unchanged. The comment aboveextrasasks for a guide infiles:only when the README links it relatively, and the README linksdocs/upgrading.mdby its GitHub URL.changelog.d/README.mdexcludes documentation changes.lib/change and no test change.Verification
mix qualityran green on this tree: Docs reported no warnings, and Doc links passed.mix docsbuild putupgrading.htmlin the sidebar'sUpgradinggroup. The page's three relative links resolve on HexDocs:../CHANGELOG.mdtochangelog.html,retention.md#pruning-one-partitionto an anchor that exists onretention.html, andchart-lock.mdtochart-lock.html.Gate run against a local Postgres on port 5432.
Refs: sp-ricm