Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 3.5 KB

index.md

File metadata and controls

67 lines (50 loc) · 3.5 KB
Raw

Contribution guide

This contribution guide is designed to help you understand the structure of the project and how to contribute effectively.

Structure

A simplified structure with organized and relevant folders.

  • _data data and text of the project
  • _includes all the components *
    • c_some-component.html - reusable component
    • some-component.html - unique component (eg. Official acounts)
  • _sass SASS partials
  • _assets static assets
  • videos videos collections (Acme, Acme Clips, Guides and Surveillance Report)

Main configuration

_config.yml (source file)

Explained in more details here.

Content files in _data/_en/

Main content

content.yml (source file)

This file contains the copy for all pages of the project, including elements such as buttons and titles. Additionally, it includes content for the 'Feature Box' component (source file), which consists of an icon, title, text, and associated). It also lists the names of all social media platforms utilized in the project.

Navigation

navigation.yml (source file)

File contains data for site navigation, organized into two key sections:

  • mainNav - used to generate the main menu
  • hiddenNav - includes all other links used throughout the project globally, which do not appear in the main menu

Affiliates

This folder contains a list of all affiliate links (techlore.tech/affiliates), organized into two categories:

production.yml (source file) - production tools

tools.yml (source file) - privacy & security tools

ℹ️ Icons/logos (Icons guide) are located in the /assets/affiliates/icons folder. To associate the appropriate icon, the 'slugified name' of the tool is used (e.g., Acme Corporation => acme-corporation.svg).

Knowledgebase

Folder /knowledgebase contains all the data for the knowledge base on the Resources page (techlore.tech/resources). The data is organized into folders by section and files by category. The c_knowledgebase.html component (source file) processes this information, sorting it into sections and categories, and generates all the links as well as both navigations (section navigation and floating navigation panel on the right side).
The names of the categories, titles and other text is located in knowledgebase-text.yml (source file).

ℹ️ Icons/logos (Icons guide) are located in the /assets/knowledgebase/icons folder. To associate the appropriate icon, the 'slugified name' of the tool is used (e.g., Acme Corporation => acme-corporation.svg).

Other files

faq.yml (source file)

patreons.yml (source file) - list of patreons on the homepage

goincognitotable.yml (source file)

spa-quiz.yml (source file)

support.yml (source file) - section "We proudly support"

team.yml (source file)

testimonials.yml (source file) - Coaching testimonials

Video Markdown & Thumbnail Tool

Tool for administrators. Explained in more details here.