Since the SRW App is planning a switch to Git submodules in place of the manage_externals tool, developers need guidance on how to use Git submodules.
Solution
Add a Contributor's Guide to our current documentation. This would include the current Contributor's Guide content from the wiki (updated) and a chapter on Git submodules.
This guide can be linked in the wiki and also aligns our documentation with UW and METplus, which place a User's Guide and Contributor's Guide together in the documentation.
Alternatives (optional)
Keep all information in the wiki and simply add information on Git submodules in the Developer section. This may be easier in the short term, but it makes it difficult to crosslink or format information and sprinkles related information across different pages of the wiki.
Description
Since the SRW App is planning a switch to Git submodules in place of the
manage_externalstool, developers need guidance on how to use Git submodules.Solution
Add a Contributor's Guide to our current documentation. This would include the current Contributor's Guide content from the wiki (updated) and a chapter on Git submodules. This guide can be linked in the wiki and also aligns our documentation with UW and METplus, which place a User's Guide and Contributor's Guide together in the documentation.
Alternatives (optional)
Keep all information in the wiki and simply add information on Git submodules in the Developer section. This may be easier in the short term, but it makes it difficult to crosslink or format information and sprinkles related information across different pages of the wiki.