Opened 11 months ago

Closed 10 months ago

Last modified 9 months ago

#24275 closed defect (fixed)

Testing Lecktor as a possible framework to be used for all portals related to website redesign project

Reported by: isabela Owned by: hiro
Priority: Medium Milestone: website redesign
Component: Webpages/Website Version:
Severity: Normal Keywords: ux-team,
Cc: isabela, mcs, hiro, antonela, intrigeri Actual Points:
Parent ID: #21222 Points:
Reviewer: Sponsor:

Description

Requirements

We are looking for a framework that:

  • makes it easy for folks to update content
  • makes it easy for having mirrored static content
  • the internationalization of it works with Transifex
  • its easy to haver our styleguide bootstrap working with it (for building the site theme)

How to test it

The live test can be accessed here: http://pipeline.torproject.net:9900/

Here is the git repository: https://oniongit.eu/infra/portal

Here is the framework home page: https://www.getlektor.com

Lektor can work as a console tool, like Jekyll. Also, if you have a mac though, you do not have to install anything from the console. You can use the mac desktop app.

https://github.com/lektor/lektor/releases/tag/3.0.1

What the app does is run the local lektor server that will allow you to edit the website as you would in a normal cms.

If you would like to give it a try, you have to clone the git repository for the project first and then open the lektor app and browse to the repository folder.

The idea is that once you make your changes you will be able to make a push and a merge request to the oniongit repository. I understand a small familiarity with git is required in this case.

Please leave any questions or feedback as a comment on this ticket, if you feel working with this framework and if you think it can make your life easier.

Child Tickets

Change History (8)

comment:1 Changed 11 months ago by steph

Cc: steph@… added

comment:2 Changed 11 months ago by hiro

Cc: steph@… removed

Some of you might find more convenient to try a graphical tool to use git. Github has a nice package for windows and mac: https://desktop.github.com/

With a step by step guide on how to install it and how to contribute to projects:

https://help.github.com/desktop/guides/

Let's say that you are using the mac client. At this link you will have a mini guide on how to add a repository: https://help.github.com/desktop/guides/contributing-to-projects/adding-a-repository-from-your-local-computer-to-github-desktop/#platform-mac

With repository in git, we mean a link to where the code is stored. In the case of the lektor repository this is: http://oniongit.eu/infra/portal.git

Once the repository is "cloned" (i.e. imported to your computer) you can make changes. These changes will be local. If you want to "push" to the remote repository (in this case on oniongit) you will need an oniongit account first.

Once you have an account (you can ask me for one) you can follow the following steps: https://help.github.com/desktop/guides/contributing-to-projects/making-changes-in-a-branch/

Git might feel a bit complicate at first, but it is relatively easy to learn after a little bit. In any case feel free to ask questions.

comment:3 Changed 11 months ago by t0mmy

o/

I just spent some time tinkering with Lektor -- it seems like a good way of editing the site! I haven't tinkered with oniongit yet because I need an account, but I got Lektor up and running!

comment:4 Changed 11 months ago by alison

I tested it and it works great for me!

comment:5 Changed 11 months ago by steph

I tried out lektor without oniongit; I like it!

comment:6 Changed 10 months ago by intrigeri

Cc: intrigeri added

comment:7 Changed 10 months ago by isabela

Resolution: fixed
Status: assignedclosed

Everyone tested and loved it! We will use Lecktor to build our sites.

comment:8 Changed 9 months ago by cypherpunks

to be used for all portals

  • easy for folks to update content

Specifically concerning the FAQ, Trac wiki, proposed knowledge base, or a merger of them, the documentation websites for other software projects that I consider the easiest to update are wikis. Wikis are particularly easy for communities of projects with extensive websites and sub-projects to contribute quickly and broadly toward updating their documentation content even if the administration teams are small in comparison or preoccupied.

A framework like Lecktor will aid in redesigning the theme, style, and underlying construction of the website which appears to be the goal of the website redesign project, but I don't think it would aid lesser-skilled folks who might wish to contribute by keeping the textual documentation updated. Git, local servers, and workspace interfaces pile steep learning curves onto simply updating a sentence or two.

Here is the git repository: ​https://oniongit.eu/infra/portal

Why not on https://gitweb.torproject.org/? It's also accessible on hidden services administrated by TorProject ( https://onion.torproject.org/ ) which means that Tor users skeptical of exit nodes, third-party hosts, or certificate authorities would have a pathway to contribute with less reluctance. An alternate but less reassuring (and harder for you) option could be maintaining a hidden service on oniongit.eu.

Note: See TracTickets for help on using tickets.