Including constitutions in docs

[XertroV]

@pwhipp - re: constitutions and docs, would it be possible to add voteflux/flux as a submodule of voteflux/flux-docs? I haven't worked with submodules much so not sure how they'd play with sphinx or readthedocs, but that might allow us to keep the constitutions always being build from the POT source - otherwise we'll need to put a notice or something on each of the constitutions in this repo since they're not "official"

(the other problem is that synchronisation is manual atm which is obvs not great)

(another note: not sure if markdown plays well with restructured if they're used at the same time in sphinx; constitutions are all in markdown)

[pwhipp]

Yes, but submodules are a nightmare - best avoided.

I used pandoc to convert the constitutions. It works very well for markdown -> restructured text.

If we make this repo our POT and control edits on it appropriately, the constitutions should be here. In fact, everything public should be here.

We should handle write permissions through the organisation of contributors, forks and pull requests over time. We can always undo things and the revision history is a nice audit trail with blame potential to keep us honest.

[XertroV]

If we make this repo our POT and control edits on it appropriately

I don't know if github gives us enough granularity to do that safely. The ONLY people who should be physically able to merge constitution changes on github are Nathan and I. No other docs have that restriction. I'd prefer the docs repo be more open than that.

My thoughts:

• Use a small python script (or whatever) to copy the constitutions from voteflux/flux when compiling (and use pandoc and whatever)
• Add a warning at the top mentioning that these files are autogenerated and this is not the official location of the constitutions, with a link

flux-docs can be a POT for all other things, but I don't see a practical way to make it the POT for constitutional matters.

We should handle write permissions through the organisation of contributors, forks and pull requests over time. We can always undo things and the revision history is a nice audit trail with blame potential to keep us honest.

This works well for most things, but constitutions are special, unless we can guarentee that no-one else can ever make a merge I don't think we can move the constitutions into this repo.

[XertroV]

Note: constitutional changes can be made by a number of ppl based on their roles in the various parties. The reason it's locked down to Nathan and I currently is that we can't give the QLD steerco permission to merge into the constitution without also giving them access to the other constitutions. In any case it's v low overhead currently.

[pwhipp]

As long as pull requests to the POT are only accepted when the doc is signed this problem would go away. We could probably automate this in the long term - approved signatories have to have signed off certain parts of the doc tree and if that is done the pull request is automatically accepted.