Page MenuHomePhorge

Fix loop in contribution docs
ClosedPublic

Authored by waldyrious on Nov 11 2023, 11:13.
Tags
None
Referenced Files
Unknown Object (File)
Sun, May 19, 08:22
Unknown Object (File)
Wed, May 8, 05:56
Unknown Object (File)
Wed, May 1, 19:19
Unknown Object (File)
Wed, May 1, 19:19
Unknown Object (File)
Wed, May 1, 19:19
Unknown Object (File)
Wed, May 1, 19:19
Unknown Object (File)
Wed, May 1, 19:19
Unknown Object (File)
Tue, Apr 30, 21:40

Details

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
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

speck added inline comments.
src/docs/contributor/contributing_code.diviner
197–199

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

src/docs/contributor/contributing_code.diviner
197–199

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"?

src/docs/contributor/contributing_code.diviner
197–199

A little long but I’m fine with either option

  • Rephrase Next Steps entry
src/docs/contributor/contributing_code.diviner
197–199

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 :)

This revision is now accepted and ready to land.Nov 12 2023, 21:03
This revision was automatically updated to reflect the committed changes.