Feature #7185

Document the interface for editing network connections

Added by sajolida 2014-05-09 19:04:49 . Updated 2015-04-19 18:08:37 .

Status:
Resolved
Priority:
Elevated
Assignee:
Category:
Target version:
Start date:
2014-09-19
Due date:
% Done:

60%

Feature Branch:
doc/7185-network_connections
Type of work:
End-user documentation
Blueprint:

Starter:
1
Affected tool:
Deliverable for:

Description

It is possible to edit special configuration for each recorded network
connections. But this interface is not straightforward to find,
especially in GNOME 3.

It would be good to document that in maybe
/doc/anonymous_internet/networkmanager/ and
/doc/first_steps/persistence/configure/.


Subtasks


Related issues

Related to Tails - Bug #7165: NetworkManager autoconnects to persistent wireless networks In Progress 2014-07-20

History

#1 Updated by Vox 2014-09-19 10:12:52

  • Assignee set to Vox
  • Start date set to 2014-09-19

#2 Updated by intrigeri 2014-09-19 18:20:57

> Assignee set to Vox

:)

> It would be good to document that in maybe
> /doc/anonymous_internet/networkmanager/ and
> /doc/first_steps/persistence/configure/.

Note that pointing to the relevant GNOME documentation should be enough.

#3 Updated by sajolida 2014-09-20 03:18:24

Actually, I’m not sure what this ticket was about exactly because the
detailed network configuration is at the place in Tails 1.1 than in
Tails 1.0, either:

- Right-click on NetworkManager
- System → Preferences → Network Connections

So I’d describe those path in /doc/anonymous_internet/networkmanager/
and point to upstream documentation if we can find any.

#4 Updated by BitingBird 2015-01-08 05:02:36

Ping ? Vox, you assigned this ticket to yourself, are you still planning on working on it ?

#5 Updated by BitingBird 2015-03-15 23:12:57

  • Assignee changed from Vox to BitingBird
  • Target version set to Tails_1.3.2

No answer from Vox in 6 months -> I take this ticket :)

#6 Updated by BitingBird 2015-03-17 14:08:56

  • Status changed from Confirmed to In Progress
  • Feature Branch set to bitingbird:doc/7185-network_connections

#7 Updated by BitingBird 2015-03-17 14:34:25

  • Assignee changed from BitingBird to sajolida
  • QA Check set to Ready for QA

Added System → Preferences → Network Connections since the other path was already there. Added a link to upstream’s doc.

Built, looks good. Please review :)

#8 Updated by BitingBird 2015-03-19 14:28:25

  • Target version changed from Tails_1.3.2 to Tails_1.4

#9 Updated by intrigeri 2015-04-04 11:46:40

  • Assignee changed from sajolida to BitingBird
  • % Done changed from 0 to 30
  • QA Check changed from Ready for QA to Dev Needed

The link to the upstream doc feels wrong: that’s a wiki, so best case it’ll be kept up-to-date and document the latest version of NetworkManager, and worst case it’ll be outdated. The GNOME Help system (at least on Jessie, didn’t check on Wheezy) has lots of chapters and tips and all about networking configuration, that supposedly matches the installed version of NM => IMO we should instead point to it.

> Added System → Preferences → Network Connections since the other path was already there

I can’t see where the other path (that starts with right-clicking on the NM icon) is documented. Not sure which path is best to document, perhaps the one that’ll take less effort to port to Jessie will be best?

#10 Updated by BitingBird 2015-04-04 15:39:31

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

Corrected everything, buil (a few times), please review again :)

#11 Updated by intrigeri 2015-04-06 09:17:53

  • Assignee changed from intrigeri to BitingBird
  • % Done changed from 30 to 40
  • QA Check changed from Ready for QA to Dev Needed

Indeed, that’s much better!

  • At least one occurrence of “NetworkManager” lacks CSS styling.
  • What’s the need to document two ways of opening NM’s connection editor?
  • I think “To access NetworkManager choose” is pretty vague. It could be phrased a bit better, to express what actual use case can be addressed by following these instructions. See this very ticket’s description for hints :)
  • IMO the paragraph you’re adding is for people who need advanced, non-default configuration. So it should not be added on top of the page, before we’ve even described what NM is for and its basic usage. I’m not sure exactly where it should go, but further down the page I’m positive.

#12 Updated by BitingBird 2015-04-06 23:52:25

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

Corrected everything as you suggested :)

#13 Updated by intrigeri 2015-04-07 08:36:24

  • Assignee changed from intrigeri to BitingBird
  • % Done changed from 40 to 50
  • QA Check changed from Ready for QA to Dev Needed

It’s improving!

  • Better avoid “on the top right on the screen” since it won’t be correct in right-to-left languages.
  • “It is possible to edit a special configuration” doesn’t feel very clear to me. I think it should be reworded, and perhaps an example would help (not sure).
  • “Edit Connections…” lacks the proper CSS styling.

#14 Updated by BitingBird 2015-04-08 23:18:50

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

Corrected everything asked, please re-re-review :)

#15 Updated by intrigeri 2015-04-09 11:50:48

  • Assignee changed from intrigeri to BitingBird
  • % Done changed from 50 to 60
  • QA Check changed from Ready for QA to Dev Needed

I think the styling you’ve set for “Edit Connections…” is incorrect, and should use guimenuitem instead: see https://tails.boum.org/contribute/how/documentation/guidelines/#index3h1.

Otherwise, alright for me, please reassign to sajolida for a (hopefully) final review once you’ve fixed that. Congrats!

#16 Updated by BitingBird 2015-04-09 16:03:52

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

Done :)

#17 Updated by BitingBird 2015-04-11 16:06:52

  • Priority changed from Normal to Elevated

Setting priority elevated, as it’s already been reviewed by intri and the final review could probabaly be quick

#18 Updated by sajolida 2015-04-19 09:33:26

  • related to Bug #7165: NetworkManager autoconnects to persistent wireless networks added

#19 Updated by sajolida 2015-04-19 10:06:25

  • Status changed from In Progress to Resolved
  • % Done changed from 60 to 100

Applied in changeset commit:876491ac4d026cae4379950d509d9635bc978bb9.

#20 Updated by sajolida 2015-04-19 10:09:20

  • Assignee deleted (sajolida)
  • % Done changed from 100 to 60
  • QA Check changed from Ready for QA to Pass
  • Feature Branch changed from bitingbird:doc/7185-network_connections to doc/7185-network_connections

Thanks for the branch, I merged it.

I did a bunch of minor fixes on top of yours, see 138d64a..5eb47bc:

  • Shorten a few things
  • Apply GDSG on a few other things
  • Fixed your example which was wrong (autoconnect is already by default in Tails Wheezy)

Ah, and I highly recommend you to active spellchecking by default on your text editor. You would have catched an easy one…

#21 Updated by BitingBird 2015-04-19 18:08:37

Thanks for the merge, I looked at your edits and I see nothing to nitpick :)