mirror of https://github.com/torproject/community.git synced 2024-11-23 18:00:02 +00:00

Tor community website

Go to file

kez baa8fc2d76 Better README documentation for community-generator		2023-01-12 15:50:27 +00:00
.github	Add .github/FUNDING.yml	2019-09-12 15:40:18 +02:00
.gitlab/issue_templates	Adds issue creation templates for bugs, features, proposals and documentation.	2020-12-22 08:45:58 -03:00
assets	Fix training guide font size	2023-01-12 15:50:27 +00:00
configs	Use lektor-scss to compile scss	2023-01-12 15:50:27 +00:00
content	Initial commit of community page generator plugin	2023-01-12 15:50:27 +00:00
databags	Implement sorting resources by topic	2023-01-12 15:50:27 +00:00
flowblocks	Add sample slides element	2023-01-12 15:50:27 +00:00
i18n	First commit	2019-03-13 17:35:58 +01:00
lego@8ab1406ed1	update lego	2023-01-06 12:29:09 -08:00
models	Move file generator templates to their own file	2023-01-12 15:50:27 +00:00
packages	Better README documentation for community-generator	2023-01-12 15:50:27 +00:00
templates	Small cleanup, add more comments	2023-01-12 15:50:27 +00:00
.gitignore	Move file generator templates to their own file	2023-01-12 15:50:27 +00:00
.gitlab-ci.yml	Use lektor-scss to compile scss	2023-01-12 15:50:27 +00:00
.gitmodules	Remove lego branch param in .gitmodules	2022-01-19 14:02:51 -05:00
babel.cfg	remove outdated config that breaks babel	2022-12-19 18:00:02 +00:00
community.lektorproject	add ru translation	2022-05-17 12:47:57 +00:00
README.md	Better README documentation for community-generator	2023-01-12 15:50:27 +00:00
requirements.txt	Use requirements.txt for packages	2022-12-20 10:14:26 -08:00

README.md

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

Download and install Lektor: https://www.getlektor.com/downloads/
Install the lektor-i18n plugin and its dependencies.
Clone the repository:

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

Init the building blocks submodule:

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

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