Project

General

Profile

Feature #14579

Feature #12615: Consider basing Tails on quarterly snapshots of Debian testing

Tell the Technical Writers what part of our doc needs to be updated for Buster

Added by intrigeri 3 months ago. Updated 17 days ago.

Status:
In Progress
Priority:
Normal
Assignee:
Category:
-
Target version:
Start date:
08/30/2017
Due date:
% Done:

50%

QA Check:
Ready for QA
Feature Branch:
Type of work:
Code

Description

… if we decided to release Tails based on Buster soon.

tails-amd64-3.0.build-manifest (127 KB) anonym, 10/09/2017 12:41 PM

tails-amd64-3.2.build-manifest (127 KB) anonym, 10/09/2017 12:41 PM


Related issues

Blocked by Tails - Feature #14578: Decide when we want to release Tails based on Debian Buster In Progress 08/30/2017
Blocks Tails - Feature #13244: Core work 2017Q4: Foundations Team Confirmed 06/29/2017
Blocked by Tails - Feature #14791: Design how the Foundations Team will tell the Technical Writers what part of our doc needs to be updated Resolved 10/05/2017

Associated revisions

Revision c972d648 (diff)
Added by intrigeri 2 months ago

Identifying doc that needs updates: initial research (refs: #14579).

Revision 1d66500b (diff)
Added by intrigeri 2 months ago

Identifying doc that needs updates: take into account anonym's feedback (refs: #14579).

Revision fbbfe9f4 (diff)
Added by intrigeri 2 months ago

Identifying doc that needs updates: dump metadata store ideas (refs: #14579).

Revision a44ff9e9 (diff)
Added by intrigeri 2 months ago

Identifying doc that needs updates: report back about XMPP discussion (refs: #14579).

Revision d4ad14ce (diff)
Added by intrigeri 2 months ago

Identifying doc that needs updates: add another bonus (refs: #14579).

Revision 25a80c2c (diff)
Added by intrigeri 2 months ago

Identifying doc that needs updates: discuss more open questions and provide an example metadata file (refs: #14579).

Revision 2db5ef74 (diff)
Added by intrigeri 2 months ago

Identifying doc that needs updates: add a few more examples (refs: #14579).

Revision b8004722 (diff)
Added by anonym 2 months ago

Introduce doc-impacted-by: tracks potential needs for updating docs.

This tool is given the following inputs:

- a Git commit and corresponding .build-manifest (from a build from
that commit) representing the "old" state

- another Git commit and .build-manifest representing the "old" state

- a database of metadata that describes the relationship of which
source changes impacts which documentation pages

and it will list documentation pages that are potentially impacted by
changes in the source files or packages we install, and thus should be
investigated whether they need to be updated.

Will-fix: #14579

Revision e0451d3f (diff)
Added by intrigeri 2 months ago

Reference anonym's implementation (refs: #14579)

Revision 8df75fc4 (diff)
Added by intrigeri 2 months ago

Fix typos (refs: #14579).

History

#1 Updated by intrigeri 3 months ago

#2 Updated by intrigeri 3 months ago

  • Blocked by Feature #14578: Decide when we want to release Tails based on Debian Buster added

#3 Updated by intrigeri 3 months ago

  • Subject changed from Tell the Foundations Team what needs to be updated for Buster to Tell the Technical Writers what part of our doc needs to be updated for Buster

#4 Updated by intrigeri 3 months ago

#5 Updated by intrigeri 3 months ago

#6 Updated by intrigeri 2 months ago

  • Status changed from Confirmed to In Progress
  • % Done changed from 0 to 10
  • Blueprint set to https://tails.boum.org/blueprint/Debian_testing#doc-update

#7 Updated by intrigeri 2 months ago

  • Blocked by Feature #14791: Design how the Foundations Team will tell the Technical Writers what part of our doc needs to be updated added

#8 Updated by anonym 2 months ago

I implemented the tool specified on the blueprint in b80047222b4ce5f3634c5ae762aec7aeb07e0a99 which is already pushed to master. For convenience's sake, attached you'll find the needed @.build-manifest@s to run the command below:

bin/doc-impacted-by 3.0 3.2 tails-amd64-3.0.build-manifest tails-amd64-3.2.build-manifest

which should give this output:

The following documentation pages need investigation:

wiki/src/doc/advanced_topics/virtualization/virtualbox.mdwn
- Updated package: virtualbox-guest-utils: 5.1.22-dfsg-1 → 5.1.28-dfsg-1
- Updated package: virtualbox-guest-x11: 5.1.22-dfsg-1 → 5.1.28-dfsg-1

wiki/src/doc/first_steps/accessibility.mdwn
- Changes in file: config/chroot_local-includes/etc/dconf/db/local.d/00_Tails_defaults
- Introduced package: caribou

wiki/src/doc/first_steps/persistence/configure.mdwn
- Updated package: tails-persistence-setup: 1.1.9-1 → 1.1.11-1

wiki/src/doc/first_steps/persistence/delete.mdwn
- Updated package: tails-persistence-setup: 1.1.9-1 → 1.1.11-1

wiki/src/doc/first_steps/persistence/use.mdwn
- Updated package: tails-greeter: 1.0.2 → 1.0.3

wiki/src/doc/first_steps/startup_options.mdwn
- Changes in file: config/binary_local-hooks/40-include_syslinux_in_ISO_filesystem
- Changes in file: config/chroot_local-includes/etc/dconf/db/local.d/00_Tails_defaults
- Updated package: tails-greeter: 1.0.2 → 1.0.3

wiki/src/doc/first_steps/startup_options/administration_password.mdwn
- Updated package: tails-greeter: 1.0.2 → 1.0.3

wiki/src/doc/first_steps/startup_options/bridge_mode.mdwn
- Changes in file: config/chroot_local-includes/usr/share/tails/tbb-sha256sums.txt
- Updated package: tor: 0.3.0.8-1 → 0.3.0.10-1~d90.stretch+1

#9 Updated by intrigeri 2 months ago

  • Assignee changed from intrigeri to anonym
  • QA Check changed from Ready for QA to Dev Needed

I implemented the tool specified on the blueprint in b80047222b4ce5f3634c5ae762aec7aeb07e0a99 which is already pushed to master.

Great! I'll do a code review and once happy I'll send this to sajolida who'll need to use this tool quite a bit.

  • I quickly gave up trying to understand all the algorithms, sorry. At least the program is very well structured so I'm confident I'll be able to hack on it if needed, even though it might be not so easy.
  • We need documentation about using this tool (contribute/how/doc?) e.g. how to install dependencies that might not be in Tails. On my (pretty bloated) sid system I had to install ruby-git. On Tails one might need more.
  • The program seems to support Git commitish and not only commits, e.g. one can pass a branch name or a tag. But the output of --help pretends only commits are supported, so I suspect some users will go through additional, useless steps to use it.
  • I don't understand "containing the remaining package fields".
  • I'd rather see variables express what they contain instead of yaml_struct :)

Once this is addressed, please send this to sajolida so he can review actual usage of the tool :)

#10 Updated by anonym 2 months ago

  • Assignee changed from anonym to sajolida
  • QA Check changed from Dev Needed to Ready for QA

intrigeri wrote:

  • I quickly gave up trying to understand all the algorithms, sorry. At least the program is very well structured so I'm confident I'll be able to hack on it if needed, even though it might be not so easy.

I'm open to any suggestion of making the situation better, if necessary.

  • We need documentation about using this tool (contribute/how/doc?) e.g. how to install dependencies that might not be in Tails. On my (pretty bloated) sid system I had to install ruby-git. On Tails one might need more.

Done in 5da6a81c3db478b94b16bfc1a735fd2cd0b33e46.

  • The program seems to support Git commitish and not only commits, e.g. one can pass a branch name or a tag. But the output of --help pretends only commits are supported, so I suspect some users will go through additional, useless steps to use it.

Fixed in 75bd1de767662b8090c6c6914af3a52ef21a7374.

  • I don't understand "containing the remaining package fields".

Is f0b13a69d515edb5ee8d0d25c1f9f88e72c2a815 making it clearer? I tried to describe it generally, since the code is general, and would survive if more fields were added into the .build-manifest format... hehe :)

  • I'd rather see variables express what they contain instead of yaml_struct :)

Fixed in 124da179b77c2febb99006e027ce024b8f6dec07.

I pushed a bunch of other commits, too, fixing a few serious issues, but generally improving the usefulness of the tool.

Once this is addressed, please send this to sajolida so he can review actual usage of the tool :)

What do you think, sajolida? Do you feel confident adding a few more relationships and actually giving this a go? Or perhaps you need a few more for this to not be as much of a toy example?

#11 Updated by sajolida 2 months ago

Before digging to this I'd like to have a better understand of the timeline and blocking relationships at sake: for when should I review you work?

Because right now this ticket is blocked by #14578 and we've been discussing on the relationship with #14578 and a technical writing sprint that we want to do to deal with this update (and have more people on board).

So, if I understand well, I'd rather wait until we #14578 is solved to put time into this, especially since times are quite hectic for me now.

#12 Updated by sajolida 2 months ago

  • Assignee changed from sajolida to anonym
  • QA Check changed from Ready for QA to Info Needed

#13 Updated by intrigeri about 2 months ago

  • Assignee changed from anonym to intrigeri
  • QA Check changed from Info Needed to Ready for QA

I'll review the recent changes and then will let anonym answer sajolida.

#14 Updated by intrigeri about 2 months ago

  • Assignee changed from intrigeri to sajolida

Code & doc review passes!

sajolida wrote:

Before digging to this I'd like to have a better understand of the timeline and blocking relationships at sake: for when should I review you work?

End of November IMO, see below for the reason why.

So, if I understand well, I'd rather wait until we #14578 is solved to put time into this, especially since times are quite hectic for me now.

I think "blocked by #14578" was correct for the original purpose of this ticket, but anonym repurposed it in a way that makes it hard to express the blocking relationships in Redmine.

IMO, in order to make a decision on #14578, we need to gather info about the biggest foreseeable issues wrt. the whole plan. One of these issues is communicating changes to tech writers. So I think we do need your input here before we make a decision on #14578, i.e. by the end of November; it would be nice if we could learn a bit in advance if there's more work we need to do here by the end of November (let's try to avoid the domino effect i.e. your own hectic times create a timeline that's hectic for other people), but well, I know you'll do what you can and I'm quite confident we got it mostly right :)

And once we've made a decision on #14578 we'll be able to actually do what this ticket was originally about. If the fact that all this is poorly encoded in Redmine right now is a serious problem for you, please ask anonym to fix it.

#15 Updated by intrigeri 17 days ago

  • Target version changed from Tails_3.5 to Tails_3.7

Also available in: Atom PDF