Page MenuHomePhorge
Differential D25465

Fix loop in contribution docs
ClosedPublic
Actions

Authored by waldyrious on Nov 11 2023, 11:13.

Details

Reviewers
speck
Group Reviewers
O1: Blessed Committers
Commits
rP296ce3956b81: Fix loop in contribution docs
Summary

The Contributor Introduction lists in the next steps the Contributing Code page;
in its turn, the Contributing Code page links back to the Contributor Introduction page.

This change fixes that infinite loop by adding an actual path forward, adding a link to the Developer Setup page in the Next Steps section of the Contributing Code page.

Test Plan

Open the /book/contrib/article/contributing_code/ URL and confirm that the Developer Setup is included in the Next Steps section.

Diff Detail

Repository
rP Phorge
Branch
docs-contributing-code
Lint
Lint Warnings
SeverityLocationCodeMessage
Warningsrc/docs/contributor/contributing_code.diviner:197TXT3Line Too Long
Unit
No Test Coverage
Build Status
Buildable 919
Build 919: arc lint + arc unit

Event Timeline

waldyrious created this revision.Nov 11 2023, 11:13
Owners added a reviewer: O1: Blessed Committers.Nov 11 2023, 11:13
Herald added subscribers: Cigaryno, Matthew, valerio.bozzolan, tobiaswiese. · View Herald TranscriptNov 11 2023, 11:13
Harbormaster completed remote builds in B908: Diff 1475.Nov 11 2023, 11:13
waldyrious requested review of this revision.Nov 11 2023, 11:13
waldyrious mentioned this in Z5: Phorge (flame).Nov 11 2023, 11:15
waldyrious edited the summary of this revision. (Show Details)
speck subscribed.Nov 11 2023, 15:48
speck added inline comments.
src/docs/contributor/contributing_code.diviner
197–198

What do you think of the phrasing “getting started with Developer Setup”?

waldyrious added inline comments.Nov 11 2023, 23:58
src/docs/contributor/contributing_code.diviner
197–198

No objection to the general idea, but I'd rather make it more explicit that it's about getting started with development specifically, to disambiguate with the "Contributor Introduction" page linked immediately after.

How about "preparing your development environment as described in the Developer Setup"?

speck added inline comments.Nov 12 2023, 00:51
src/docs/contributor/contributing_code.diviner
197–198

A little long but I’m fine with either option

waldyrious updated this revision to Diff 1490.Nov 12 2023, 20:52
  • Rephrase Next Steps entry
Harbormaster completed remote builds in B919: Diff 1490.Nov 12 2023, 20:52
waldyrious added inline comments.Nov 12 2023, 20:52
src/docs/contributor/contributing_code.diviner
197–198

I can't think of anything better, so I'll proceed with this one. Happy to make changes if anyone comes up with a better idea though :)

waldyrious updated this revision to Diff 1491.Nov 12 2023, 20:55
  • Wrap long line
Harbormaster completed remote builds in B920: Diff 1491.Nov 12 2023, 20:55
speck accepted this revision.Nov 12 2023, 21:03
This revision is now accepted and ready to land.Nov 12 2023, 21:03
Closed by commit rP296ce3956b81: Fix loop in contribution docs. · Explain WhyNov 12 2023, 21:07
This revision was automatically updated to reflect the committed changes.
waldyrious added a commit: rP296ce3956b81: Fix loop in contribution docs.

Revision Contents
Changeset List

PathSizePackages
src/
docs/
contributor/
3 linesO1: Blessed Committers

Diff 1490

View Options

src/docs/contributor/contributing_code.diviner

Loading...
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0