Skip to content

Latest commit

 

History

History
148 lines (107 loc) · 5.49 KB

README.md

File metadata and controls

148 lines (107 loc) · 5.49 KB
Raw

Community portal

This is the repository of Community portal. The current online version of this portal can be found at https://community.torproject.org or Community Onion Service.

To clone the code use either of

git clone https://gitlab.torproject.org/tpo/web/community.git

torify git clone http://eweiibe6tdjsdprb4px6rqrzzcsi22m4koia44kc5pcjr7nec2rlxyad.onion/tpo/web/community.git/

or browse it online.

How to report bugs or feedback

First, check if the bug is already known. You can search and read all the issues at https://gitlab.torproject.org/. To create a new issue, please request a new account to access Tor Project's GitLab instance and find the right repository to report your issue. Issues related to our websites should be filed under the Web issue tracker.

What is Lektor

Lektor is a framework to generate and serve websites from Markdown files.

Its code can be found at GitHub.

How to contribute

(Easy) Edit this page button

You can click Edit this page and submit your content changes in a Pull Request in GitLab.

(Advanced) Compiling a local version of the website

See this guide on our wiki: https://gitlab.torproject.org/tpo/web/team/-/wikis/documentation/Compiling-a-local-version-of-the-website

Translations

To help us to translate, please join the Tor Project team on Weblate.

Getting help

If you want to contribute to the Community portal, we will be happy to help you. Join us at #tor-www in irc.oftc.net.

Section-specific instructions

Instructions for maintaining specific sections of the website.

Adding user stories

User stories are located under content/outreach/stories.

To add a new user story, add a new directory with the story's pseudonymous name. In that directory two files are required, portrait.png and contents.lr containing the story text.

For the portrait, generate one manually from the CC0 OpenPeeps illustration library. It should be resized to a 220px-sided square. A portrait from another story may also be re-used.

For the story content, the contents.lr file should be formatted as follows:

---
_model: story
---
html: outreach-story.html
---
section: Stories
---
section_id: stories
---
title: <title>
---
category:

<category>
---
summary: <summary>
---
body:

<body>

Replace the placeholders as follows:

  • <title>: Capitalized pseudonymn for this story
  • category: one or more of activism, anti-censorship, civic-participation, encryption, freedom-of-information, healthcare, lgbtqia, online-safety, preace-of-mind, press-freedom, privacy (as defined in databags/story-categories.ini), one category per line
  • <summary>: text shown on the index page below the portrait (one or two short phrases)
  • <body>: full story content (the first paragraph will be automatically "featured")

These steps can be done directly in the GitLab Web IDE: simply create a new branch, enter the editor environment, create the directory, add/edit the needed files and finally, create and push a new commit. GitLab will then offer the option to create a merge request. Once the MR is created, a "review app" will be deployed allowing to preview the changes.

Adding training guides for training resources

Each training resource can optionally have a training guide. You can create a training guide for a particular resource by creating a new lektor contents file with the path content/training/resources/<resource name>-guide/contents.lr. So to create a guide for a resource called all-about-tor, you would create content/training/resources/all-about-tor-guide/contents.lr. Here's an example contents file for a training guide:

_model: resource
---
title: All About Tor Training Guide
---
author: Tor Project
---
cover:
---
background: white
---
image: /static/images/onion.png
---
body: body test goes here!
---
external_sources:
https://www.acsac.org/2011/program/keynotes/syverson.pdf
https://matt.traudt.xyz/posts/2021-02-22-tor-spelling/
---
objectives:
Understand the privacy advantages of the Tor network.
Understand the breadth of the Tor ecosystem of tools.
Identify properties important in privacy-preserving technologies.
---
topics:
foo
bar
baz
---
sample_slides:

#### sample_slide ####
language: English
----
view_link: link to view the training guide
----
pdf_link: link to the pdf guide
----
odp_link: link to the odp guide
----

#### sample_slide ####
language: Español
----
view_link: link to view the training guide
----
pdf_link: link to the pdf guide
----
odp_link: link to the odp guide

Design

The community-generator plugin

This lektor site uses a special plugin called community-generator, you can find it in the packages directory. This plugin generates a special set of lektor contents files used for a js-free filtering system on the training resources page.

You shouldn't need to do anything or know anything about this plugin in order to use it. If you want to develop on this plugin, see the plugin's README.