torproject/community
1
0
Fork 0
mirror of https://github.com/torproject/community.git synced 2024-11-23 18:00:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

README: reorganize sections

Browse Source
This commit is contained in:
Jérôme Charaoui 2023-12-13 11:09:04 -05:00
parent 2f00a07c4c
commit d026735580
No known key found for this signature in database
GPG Key ID: 69C52F658E988542
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -38,11 +38,9 @@ To help us to translate, please join the [Tor Project team](https://hosted.webla
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).
### The community-generator plugin
### Section-specific instructions
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](packages/community-generator/README.md).
Instructions for maintaining specific sections of the website.
#### Adding training guides for training resources
@ -98,3 +96,11 @@ 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](packages/community-generator/README.md).