Re: [Tails-dev] Stop shipping bugs/* and todo/* in ISO?

Delete this message

Reply to this message
Author: intrigeri
Date:  
To: The Tails public development discussion list
Old-Topics: Re: [Tails-dev] Stop shipping bugs/* and todo/* in ISO?
Subject: Re: [Tails-dev] Stop shipping bugs/* and todo/* in ISO?
Hi,

intrigeri wrote (30 Nov 2012 13:51:12 GMT) :
> anonym wrote (30 Nov 2012 13:10:52 GMT) :
>> However, an issue this would bring is that bugs/ and todo/ are
>> referenced on several places in doc/ and contribute/. Check e.g.


>>     git grep 'bugs/\|todo/' wiki/src/{doc,contribute}


>> Without having checked whether these references are all necessary, this
>> is something we'd have to take into account.


> Good catch. I've had a quick look, and the only one that seems really
> problematic is the link to bugs/pending from the bug reporting doc.


I've had a closer look.

- contribute/roadmap: is totally broken once we don't build todo/*.
I find it sad, but acceptable as a temporary solution. If someone
is really worried, we might bother hacking the source page to
replace its text with a line that points to the online version,
when building the bundled offline documentation.

- contribute/*,
doc/advanced_topics/mac_changer,
doc/anonymous_internet/networkmanager,
doc/encryption_and_privacy/secure_deletion,
doc/encryption_and_privacy/truecrypt,
support/known_issues:
have a few links to todo/* and bugs/*.

How about we use [[!tails_todo NAME]] and [[!tails_bug NAME]]
ikiwiki shortcuts to point to the online version of these tickets?
It would be a bit painful, but we'll have to use a similar shortcut
once we've moved to a better task manager, so one can consider it
is a useful training step :p

If we go this way, I fear we forget about it and add more broken
links in the near future, so I suggest we add a check to our build
process that greps for such falsely "internal" links.

- doc/first_steps/bug_reporting, support/found_a_problem: link to
bugs/pending; here also, using an ikiwiki shortcut looks good
enough a temporary solution.

=> I propose we go the ikiwiki shortcuts way to link to the online
version of bugs/* and todo/*, and add the build-time check
suggested above.

Thoughts?

(Deadline if nobody objects: January 26th.)

Cheers,
--
intrigeri
| GnuPG key @ https://gaffer.ptitcanardnoir.org/intrigeri/intrigeri.asc
| OTR fingerprint @ https://gaffer.ptitcanardnoir.org/intrigeri/otr.asc