Bug #10719

Document how we use Redmine fields

Added by sajolida 2015-12-07 07:06:34 . Updated 2016-09-23 03:07:42 .

Status:
Resolved
Priority:
Normal
Assignee:
Category:
Target version:
Start date:
2015-12-07
Due date:
% Done:

100%

Feature Branch:
emmapeel:doc/10719-redmine_fields
Type of work:
Contributors documentation
Blueprint:

Starter:
Affected tool:
Deliverable for:

Description

Over the time, we’ve developed common practices and shared semantics behind the fields available in Redmine. But it’s been hard for newcomers to find their way around and understand how things are working on Redmine.

We have a page to document Redmine on /contribute/working_together/Redmine but it’s not explaining most of these practices. The Git merge (/contribute/merge_policy/review) policy also mentions some fields but is very partial.


Files


Subtasks


History

#1 Updated by sajolida 2015-12-07 08:41:25

We also have /contribute/working_together/document_progress.

#2 Updated by sajolida 2016-01-03 20:10:15

sajolida and intrigeri use the “Discuss” field differently.

#3 Updated by emmapeel 2016-01-17 14:20:12

  • Assignee set to emmapeel

#4 Updated by sajolida 2016-02-06 16:12:12

In the right sidebar, when logged in, on an existing ticket’s page,
I see a “Watchers” section, with an “Add” button.

When creating a ticket, there’s a “Watchers” field at the bottom of
the form: https://labs.riseup.net/code/projects/tails/issues/new

#5 Updated by emmapeel 2016-02-19 18:28:34

  • Feature Branch set to emmapeel:doc/10719-redmine_fields

I have started to do it and I see that it can get a bit redundant, as it is a different approach to the merge process. So for example there are options related to developers that commit to repositories, but there are options for normal users that want to report a bug, etc. So maybe some tagged explanations will be better.

Branch is always for review, comments about fields welcome here in this ticket.

#6 Updated by emmapeel 2016-02-20 08:47:03

Not sure if I should explain Categories and Affected tools. Maybe a paragraph defining the taxonomy… any sugggestions?

By now it looks like this:

https://git-tails.immerda.ch/emmapeel/tails/tree/wiki/src/contribute/working_together/Redmine.mdwn?h=doc/10719-redmine_fields#n81

#7 Updated by muri 2016-02-21 18:34:46

hi,

great, thanks for doing that, i’m always a bit insecure about setting the fiels.

not part of this tickets scope, but part of the page: i think in the How to use Redmine’s Atom feeds section a user doesn’t have to use the atom access key (at least in my case it works without that).
in the Create a ticket by email section, we should make clear, that a user has to have an account on labs.riseup.net with the email address used.

fields:
Subject: The Subject should be a short but clear description what the ticket is about. Some people are case sensitive, please try to consider that.

i’ve added these and some small changes in a patch on top of your branch.

i would explain both categories and affected tool (i don’t really know the meanings of most of these or the difference, i think ‘camouflage’ could also be a tool and ‘instant messaging’ a category; whats the i18n version vs the t10n type of work…?)

#8 Updated by emmapeel 2016-02-22 07:36:13

muri wrote:
> hi,
>
> great, thanks for doing that, i’m always a bit insecure about setting the fiels.
>
> not part of this tickets scope, but part of the page: i think in the How to use Redmine’s Atom feeds section a user doesn’t have to use the atom access key (at least in my case it works without that).

I think some queries will not work, like ‘Tickets assigned to me’, but others may not need the access key.

> in the Create a ticket by email section, we should make clear, that a user has to have an account on labs.riseup.net with the email address used.
>
> fields:
> Subject: The Subject should be a short but clear description what the ticket is about. Some people are case sensitive, please try to consider that.
>
> i’ve added these and some small changes in a patch on top of your branch.
>

thanks, I added caps to Redmine (I should put it on a application span) and took out the eclamation signs from the watchers addition… I think you are being partial :D

> i would explain both categories and affected tool (i don’t really know the meanings of most of these or the difference, i think ‘camouflage’ could also be a tool and ‘instant messaging’ a category; whats the i18n version vs the t10n type of work…?)
yeah maybe i should explain each of them… not sure… branch has been updated with your patch.

#9 Updated by sajolida 2016-02-23 13:23:49

> I should put it on a application span

Please don’t bother doing this!

#10 Updated by emmapeel 2016-08-26 12:29:40

so, it looks like it is ready for a QA, although it would have been nice to have some more input first…

#11 Updated by intrigeri 2016-08-26 14:47:23

> so, it looks like it is ready for a QA, although it would have been nice to have some more input first…

(IIRC I’ve also provided some on tails-dev@.)

#12 Updated by emmapeel 2016-08-27 11:25:45

intrigeri wrote:
>
> (IIRC I’ve also provided some on tails-dev@.)

Oops I overlooked that mail…

https://mailman.boum.org/pipermail/tails-dev/2016-April/010597.html

I am applying most changes, and will answer the email to discuss some doubts.

#13 Updated by emmapeel 2016-09-08 05:14:47

  • Assignee deleted (emmapeel)
  • QA Check set to Ready for QA

#14 Updated by intrigeri 2016-09-09 15:04:42

  • Assignee set to intrigeri
  • Target version set to Tails_2.7

(I’ll keep following-up on it.)

#15 Updated by intrigeri 2016-09-23 01:42:34

  • Status changed from Confirmed to Resolved
  • Assignee deleted (intrigeri)
  • % Done changed from 0 to 100
  • QA Check changed from Ready for QA to Pass

Thank you. Merged!

A few comments:

  • Anchors generated by the TOC like contribute/working_together/roles/front_desk#index2h1 are not OK (they will become broken at some point); in this case the page that’s the target of the link is short enough to not bother, so I’ve reverted commit:4f0ce666884e1c11e9148455f183cf3b2ca0bf2c; if you disagree, please create a new anchor manually.
  • FYI the branch had a (trivial) conflict with current master. In general, please do merge the branch your topic branch should be merged into, into your topic branch, before asking for review: resolving such conflicts is the responsibility of the branch submitter, not of the reviewer :)
  • I’ve done quite a bit of polishing before pushing: fixed a typo in commit:6919264, dropped trailing whitespace in commit:36fc500, improved HTML in commit:bbb882c, fixed ikiwiki link syntax in commit:95b4820, nitpicked a bit in commit:0273335, improved a definition in commit:75e2784, improved phrasing in commit:beba18f and commit:336c3a7, fixed some terminology in commit:99fde79, fixed grammar in commit:b797a04. Please have a good look at them, it might teach you a thing or three :)

#16 Updated by emmapeel 2016-09-23 02:33:16

intrigeri wrote:

Thanks for input!:

> * Anchors generated by the TOC like contribute/working_together/roles/front_desk#index2h1 are not OK (they will become broken at some point); in this case the page that’s the target of the link is short enough to not bother, so I’ve reverted commit:4f0ce666884e1c11e9148455f183cf3b2ca0bf2c; if you disagree, please create a new anchor manually.

touchee… i was lazy on that one I have to admit

> * FYI the branch had a (trivial) conflict with current master. In general, please do merge the branch your topic branch should be merged into, into your topic branch, before asking for review: resolving such conflicts is the responsibility of the branch submitter, not of the reviewer :)

I was a bit scared of this branch cause it touches a lot of files and we were working on it for long… so I guess I should have imagined there will be conflicts.

So you say that the last commit should be this ‘merge commit’, caused by me doing `git pull tails master` on the topic branch? I thought that was too spammy but I can try it next time.

> * I’ve done quite a bit of polishing before pushing: fixed a typo in commit:6919264, dropped trailing whitespace in commit:36fc500, improved HTML in commit:bbb882c, fixed ikiwiki link syntax in commit:95b4820, nitpicked a bit in commit:0273335, improved a definition in commit:75e2784, improved phrasing in commit:beba18f and commit:336c3a7, fixed some terminology in commit:99fde79, fixed grammar in commit:b797a04. Please have a good look at them, it might teach you a thing or three :)

Checked them, yeah I like much better the ‘In progress’ now… more easy-going.

I see the long list of fields a bit tiring/monocrome/boring now, I will try to add more styling and highlights to make it easier to parse.

#17 Updated by intrigeri 2016-09-23 03:07:42

> So you say that the last commit should be this ‘merge commit’, caused by me doing `git pull tails master` on the topic branch?

Yes.