Opened 9 months ago

Last modified 6 months ago

#27621 assigned project

port tb-manual to lektor

Reported by: arthuredelstein Owned by:
Priority: Medium Milestone:
Component: Community/Tor Browser Manual Version:
Severity: Normal Keywords:
Cc: hiro, alison, emmapeel, antonela, ggus, mcs Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

I was discussing with emmapeel how to make it easier to maintain the Tor Browser manual. One idea is to port the content to lektor. That way we would have common styling and codebase with the support portal. And the content will probably be easier to maintain in lektor files than in the mallard XML.

(I could be of assistance if people think this is a good idea.)

Child Tickets

TicketStatusOwnerSummaryComponent
#28235assignedarthuredelsteinGenerate screenshots for the Tor Browser manualCommunity/Tor Browser Manual
#28236closedemmapeelAdd translations to the new TB manualCommunity/Tor Browser Manual
#28237closedtraumschuleWrite README for TB manual repositoryCommunity/Tor Browser Manual

Change History (10)

comment:1 Changed 9 months ago by ggus

+1 - I think this is a good idea!

comment:2 Changed 9 months ago by emmapeel

I think it will decrease much more the maintenance if we don't use a different SSG for each of our fqdn.

As the tb-manual needs to be adopted by somebody, this is a good moment to review the pros and cons of using Mallard.

If we keep using Mallard, we would need to:

  • Adapt Mallard to the new style guide
  • Code features in Mallard, like automatic language negotiation.

This effort could be put instead on moving the content to markdown, and with the shared codebase we save developers / designers time for the future.

Last edited 9 months ago by emmapeel (previous) (diff)

comment:3 Changed 9 months ago by alison

Some of us had a meeting today and agreed that tb.manual.tpo should be ported to Lektor.

Phoul is asking hiro about setting up a tb-manual Lektor instance.

After that, the tb-manual content should be interlinked to support.torproject.org.

The eventual goal is a merged tb-manual.tpo and support.tpo, but first the Lektor migration.

comment:4 Changed 8 months ago by mcs

Cc: mcs added

comment:5 Changed 7 months ago by traumschule

Status: newneeds_review
Summary: Idea: port tb-manual to lektorport tb-manual to lektor
Type: taskproject

So it is decided that we want this it seems.

Here is a draft repository with markdown files based an the current user-manual:
https://github.com/traumschule/user-manual-lektor

You can see an example here:
https://github.com/traumschule/user-manual-lektor/blob/master/content/en-US/first-time.md

This has been created automatically by a script that can be found in the repo as well. It is of course not yet perfect:

  • not all languages are created
  • links point to html pages

If you agree with this approach i'll continue and create an adapted lektor structure based on the support instance.

comment:6 Changed 7 months ago by emmapeel

sorry, i should have updated this ticket before.

there is a first draft of the lektor-based user manual at

https://gitweb.torproject.org/project/web/manual.git/

comment:7 Changed 7 months ago by traumschule

Owner: changed from phoul to traumschule
Status: needs_reviewassigned

Okay, no worries, i remember you sent me the link before.

comment:8 Changed 7 months ago by traumschule

The text files are apparently done already.

Just got an update by emmapeel on what's left:

Will take care of the last two.

Last edited 6 months ago by traumschule (previous) (diff)

comment:10 Changed 7 months ago by traumschule

Status: assignednew

Created children to be able to release this.

comment:11 Changed 7 months ago by traumschule

Owner: traumschule deleted
Status: newassigned

unassigning

Note: See TracTickets for help on using tickets.