+1, I think it could be added to developer handbook [1] or new section at [2] or to plugins page [3]
[1] https://theforeman.org/contribute.html [2] https://theforeman.org/documentation.html [3] https://theforeman.org/plugins/ -- Marek On čtvrtek 22. června 2017 8:48:39 CEST [email protected] wrote: > Hi all, > > Recently I have created a couple of PR's that added extension point to > plugins. These extension point needed to be documented in the > http://projects.theforeman.org/projects/foreman/wiki/How_to_Create_a_Plugin > document. > The problem is that between the time I have created the code PR and the > time it got merged (and the doc change was necessary) passed a couple of > months. I had to remember the context when I was writing the PR in order to > write the wiki page. > > I suggest creating a docs PR side by side with the code PR and creating a > reference between them. > Benefits: > 1. The documentation would be created in the same context by the developer, > while it's fresh in his memory and he remembers all the caveats for the > user. > 2. The reviewers could better understand what the PR is offering. > 3. There is less chance for the developer to forget to update the docs > > In order to do that, we have to move the page to github (somewhere in > theforeman.org <https://github.com/theforeman/theforeman.org> repo). > To mitigate a concern about the ease of change, we can put a link to edit > the page in the header/footer of the page itself, so it will be one click > away for anyone who wants to edit it. > > Comments? -- You received this message because you are subscribed to the Google Groups "foreman-dev" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/d/optout.
