Add a help page for updating files managed with modulesync #245
Conversation
There was a problem hiding this comment.
Should we mention that https://github.com/voxpupuli/voxpupuli-test and https://github.com/voxpupuli/voxpupuli-acceptance exist to reduce the amounts of code we sync between modules? That in general it's better to use a library than to sync code?
|
|
||
| At the root of this repository, is a directory named `moduleroot` which contains all the templates used to generate the files ModuleSync manages. Fill-in a PR against the [modulesync_config] repository to make changes to files managed by ModuleSync. | ||
|
|
||
| If your changes do not apply to *all* modules managed by Vox Pupuli, use `@config['your_custom_key']` to tune the templates expansion. The default value of `your_custom_key` can be set in ` config_defaults.yml` in the [modulesync_config] repository, and the custom value for a specific module in a `.sync.yml` file at the root of that module repository. |
There was a problem hiding this comment.
what? where? :) An example would be helpful since this requires changing things in two different repos.
There was a problem hiding this comment.
Added an example. I really feel unable to write comprehensible English, rewording in proper words would be appreciated!
|
@ekohl I don't think this post is about design as much as how do you update a module without your PR getting held up because you modified some magic file that you are not supposed to. Believe that @smortex is writing this so we can link to it from files that are synced. See voxpupuli/modulesync_config#722 |
|
Still, if they do submit a PR to modulesync_config, we don't want to then immediately close it just to redirect them to some other repository. That's my point. |
We can. The idea being to link to this page from files managed by modulesync, maybe we should emphasis that if the requested changes are specific to a single module, it probably does not belong to modulesync and a better way might probably already exist in these repositories. |
kenyon
changed the title
smortex
force-pushed
the
updating-files-managed-with-modulesync
branch
from
85f2d87
to
d1bd3f4
Compare
|
I somehow managed to take a long time for writing my previous message and did not see the answer form @ekohl which arrived in the mean time. I added a section "Should I update files managed by ModuleSync?" to give pointers to contributors who reach this page about where to ask for help if they are not sure that tuning modulesync_config is the right thing to do. |
|
@smortex added a typo fix and a small suggestion though this looks great! Thanks for putting this together. |
smortex
force-pushed
the
updating-files-managed-with-modulesync
branch
from
d1bd3f4
to
2ece6b0
Compare
smortex
force-pushed
the
updating-files-managed-with-modulesync
branch
from
2ece6b0
to
c980336
Compare
Feel free to contribute to this PR by adding commits :-)