README.md 2.61 KB
Newer Older
1
2
# Community portal

nyxnor's avatar
nyxnor committed
3
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](http://xmrhfasfg5suueegrnc4gsgyi2tyclcy5oz7f5drnrodmdtob6t2ioyd.onion/).
4
5
6

To clone the code use either of 

Gus's avatar
Gus committed
7
```git clone https://gitlab.torproject.org/tpo/web/community.git```
8

Gus's avatar
Gus committed
9
```torify git clone http://eweiibe6tdjsdprb4px6rqrzzcsi22m4koia44kc5pcjr7nec2rlxyad.onion/tpo/web/community.git/``` 
10

Gus's avatar
Gus committed
11
or browse it [online](https://gitlab.torproject.org/tpo/web/community).
12
13
14

## How to report bugs or feedback 

nyxnor's avatar
nyxnor committed
15
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](https://gitlab.onionize.space/) to access Tor Project's GitLab instance and [find the right repository](https://gitlab.torproject.org/tpo) to report your issue. Issues related to our websites should be filed under the [Web issue tracker](https://gitlab.torproject.org/groups/tpo/web/-/issues).
16
17
18
19
20
21
22
23
24
25
26

## What is Lektor

[Lektor](https://www.getlektor.com/) is a framework to generate and serve websites from Markdown files.

Its code can be found at [GitHub](https://github.com/lektor/lektor).

## How to contribute

### (Easy) Edit this page button

27
You can click ```Edit this page``` and submit your content changes in a [Pull Request in GitLab](https://gitlab.torproject.org/tpo/web/community/-/merge_requests/).
28
29
30
31
32
33
34
35
36

### (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](https://github.com/numericube/lektor-i18n-plugin#prerequisites).

3. Clone the repository:

Gus's avatar
Gus committed
37
```git clone https://gitlab.torproject.org/tpo/web/community.git```
38
39
40

4. Init the building blocks submodule: 

Enjeck Cleopatra's avatar
Enjeck Cleopatra committed
41
```$ cd community/lego && git submodule update --init --recursive```
42

Dimitris Apostolou's avatar
Dimitris Apostolou committed
43
5. 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.
44

45
6. Finally:
46
47
48
49
50
51
52

To run a local continuous builder: ```$ lektor server```

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

#### How to develop on the website

hadymaggot's avatar
hadymaggot committed
53
Check our [wiki pages](https://gitlab.torproject.org/tpo/web/wiki/-/wikis/How-to-develop-on-the-website).
54
55
56
57
58
59
60
61

### Translations

To help us to translate, please join the Tor Project team in [Transifex](https://www.transifex.com/).

### 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](https://www.oftc.net).