ubports/docs.ubports.com

Move to gitlab for finer grained review permissions

doniks opened this issue · 1 comments

Discussed with @Flohack74 the other day: apparently review permissions on Github are organization wide, which is kinda inconvenient in that it makes the bar to promote someone to reviewer artificially high. And the docs could really do with more reviewers.

On Gitlab it's supposed to be possible to have finer grained permissions, so it should be easier to add contributors as reviewers on docs only, rather than on org.

Exploration

So, to explore/prepare for such a move, let me:

TODO

  • make sure we keep translated versions of the website
  • make sure weblate still works
  • rtd subproject ubportsicondocs -> why is this a subproject?
  • do we need an announcement / downtime warning? forum & writers TG
  • check whether importing into GL with "GH access" would also take issues/PRs?! as opposed to just import "url"

Checklists for the actual move

move

  • fork/clone/update docs into GL ubports (Import->Repo from URL, public)
  • rtd: "Connect Service" GL
  • add to ubports rtd, name "docs.ubports.com.gitlab" NB: dots are removed from rtd url
  • settings: Admin->Advanced->build PR - on that note: currently PR's and branches are built by Jenkins - rtd can build PR's/MRs I guess that's good enough
  • settings: copy from current
  • make sure hostname redirects to that other new rtd page

verify

  • make a dummy PR
  • make a weblate PR

followup in new docs

  • review/update documentation-contribution section as needed (GL link, Editing, MR->Pipeline->External)

cleanup in old docs

as far as I can see closing all issues is too complicated https://docs.github.com/en/actions/managing-issues-and-pull-requests/closing-inactive-issues or uncommented (Issues -> select all -> Mark as -> closed) so I suggest no general action to close/comment on PR/Issue