Update processes, workflow, and documentation
General notes
Sections of our website that we can safely ignore and leave as-is:
wiki/src/blueprint/
wiki/src/contribute/meetings/
wiki/src/contribute/reports/
wiki/src/news/
What needs to be updated
-
Identify what needs to be adjusted/updated (→ tasks below on this list) -
git grep
andfind
-
Look for more things to adjust in the blueprint -
Look for Git-repo related doc/process/workflows that need updating (e.g. contribute/git.mdwn
)
-
-
General Redmine doc ( wiki/src/contribute/working_together/Redmine.mdwn
in tails.git)-
Create a new GitLab page, move all relevant content there and adapt. -
Link from the old Redmine doc page to the new GitLab one. -
Update backlinks of https://tails.boum.org/contribute/working_together/Redmine/ (they are listed at the bottom of the page): most of them should probably point to the new GitLab doc; occasionally the text of the link needs to be updated accordingly. -
Document important GitLab-specific aspects, in particular when they greatly differ from our previous workflow. It's OK (and probably desirable) to point to the relevant page on the official GitLab doc instead of reinventing this wheel and having to maintain it. The blueprint has lots of details wrt. the workflow conversion, mapping "how we did it before in Redmine" to "how we'll do it in GitLab". In some cases, we can recycle some of the text from the blueprint. -
#15 (closed) -
Access to confidential issues -
Relationships between issues -
Other issues metadata -
Tracking of "Core work" (as per #31 (closed)) -
Access control
-
-
-
Adjust wrt. migrated Git repositories -
ikiwiki shortcuts: grep 'tails.*gitweb' wiki/src/shortcuts.mdwn
-
wiki/src/contribute/git.mdwn
-
URLs and remotes for migrated repositories -
Process for creating a new repo
-
-
All places that hard-code pre-GitLab Git URLs for migrated repositories: git grep -E 'git\.tails\.boum\.org|git-tails\.immerda\.ch|salsa\.debian\.org'
-
-
Submitting branches, reviewing and merging doc -
wiki/src/contribute/merge_policy/submit.mdwn
-
wiki/src/contribute/merge_policy/review.mdwn
-
All places that point to our Salsa project: git grep -i -w salsa
-
#14 (closed)
-
-
Other doc for contributors -
Adjust hard-coded links to Redmine (except links to issues & attachments, that will get redirected) on the website: git grep -F redmine.tails.boum.org -- wiki/src/**/*.{html,mdwn}
; in particular: links to custom queries. -
Hardcoded "Redmine", "Type of work", or "Needs Validation" in a bunch of pages: wiki/src/contribute{.mdwn,/**}
: most of the time it's a simple matter of s/Redmine/GitLab/ (or even removing the "Redmine" mention when it is an implementation detail), but occasionally more adjustments are needed for the new setup (different workflow, different permissions and roles) -
Script in the "Tickets linked from the website" section of wiki/src/contribute/release_process.mdwn
-
-
ikiwiki shortcuts (defined in wiki/src/shortcuts.mdwn
):-
tails_redmine_starter
→ replace definition and usage with a newtails_gitlab_starter
shortcut -
tails_ticket
→ point the URL template to GitLab -
tails_redmine
:git grep -w tails_redmine -- wiki/src/**/*.{html,mdwn}
→ replace definition and usage with a newtails_gitlab
shortcut
-
-
Remove obsolete bits of the blueprint -
Optional -
Hard-coded links to Redmine issues in the code: git grep -F 'redmine.tails.boum.org' config/
in tails.git (we'll have redirects in place)
-
Edited by intrigeri