port tb-manual to lektor

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.)

added component::community/tor browser manual priority::medium resolution::fixed severity::normal status::closed type::project labels

+1 - I think this is a good idea!

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.

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.

Trac:
Cc: hiro, alison, emmapeel, antonela, ggus to hiro, alison, emmapeel, antonela, ggus, mcs

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.

Trac:
Type: task to project
Summary: Idea: port tb-manual to lektor to port tb-manual to lektor
Status: new to needs_review

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/

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

Trac:
Status: needs_review to assigned
Owner: phoul to traumschule

The text files are apparently done already.

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

• org/operations/services/support#Addanewlanguagetothesupportportal (doc i18n plugin)
• generate screenshots
• write a README

Will take care of the last two.

Created children to be able to release this.

Trac:
Status: assigned to new

unassigning

Trac:
Status: new to assigned
Owner: traumschule to N/A

this has been done

Trac:
Status: assigned to closed
Resolution: N/A to fixed

closed

mentioned in issue #28235 (moved)

moved to tpo/web/manual-trac#27621 (closed)