Skip to content

broduer/community

 
 

Repository files navigation

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

  1. Download and install Lektor: https://www.getlektor.com/downloads/

  2. Install the lektor-i18n plugin and its dependencies.

  3. Clone the repository:

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

  1. Init the building blocks submodule:

$ cd community/lego && git submodule update --init --recursive

  1. Translations for the website are imported by Jenkins when building the page, but if you want to test them, download the correct branch of the translations repo to the ./i18n/ folder.

  2. Finally:

To run a local continuous builder: $ lektor server

To just build the website once: $ lektor build -O <folder>

How to develop on the website

Check our wiki pages.

Translations

To help us to translate, please join the Tor Project team in Transifex.

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.

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.

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

About

Tor community website

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 46.1%
  • HTML 34.8%
  • SCSS 13.5%
  • Python 3.1%
  • Jinja 2.2%
  • CSS 0.3%