Ad Placeholder (728×90)

Project Structure

Overview of the architecture and structure of Namaste Salesforce

Project Structure

Namaste Salesforce follows a modular and organized architecture to ensure scalability, maintainability, and ease of collaboration. Below is an overview of the project’s structure.

Directory Layout

namaste-salesforce/
│-- _config.yml          # Jekyll configuration file
│-- index.md             # Homepage content
│-- assets/              # Static assets like images, CSS, JS
│   │-- css/             # Stylesheets
│   │-- js/              # JavaScript files
│   │-- images/          # Project images and icons
│-- _layouts/            # Jekyll layout templates
│   │-- default.html     # Base layout
│   │-- docs.html        # Documentation layout
│-- _includes/           # Reusable components like headers, footers
│-- _data/               # YAML files for structured data
│-- _posts/              # Blog articles and tutorials
│-- _docs/               # Documentation files
│   │-- getting-started.md   # Getting started guide
│   │-- architecture.md      # Detailed architecture explanation
│-- _tools/              # Open-source Salesforce tools directory
│-- _contributors/       # Contributor guidelines and credits
│-- scripts/             # Utility scripts for automation
│-- README.md            # Project overview and setup guide
│-- CONTRIBUTING.md      # Contribution guidelines
│-- LICENSE             # Project license

Key Components

  • _config.yml: Stores global site settings and configurations.
  • index.md: The landing page of the website.
  • assets/: Contains stylesheets, JavaScript files, and images.
  • _layouts/: Defines different page structures used in the project.
  • _includes/: Holds reusable UI components for consistent design.
  • _data/: YAML files containing structured data used across the site.
  • _posts/: Blog posts and tutorials about Salesforce.
  • _docs/: Contains learning materials, guides, and reference documentation.
  • _tools/: Directory for various open-source Salesforce tools.
  • scripts/: Contains automation and helper scripts.
  • README.md: Provides an overview of the project, setup instructions, and contribution details.

Architecture

Namaste Salesforce is built using Jekyll, a static site generator, to provide a lightweight, fast, and scalable solution for open-source learning. The content is written in Markdown and processed into a static website.

  • Jekyll-based: Enables easy content management with Markdown.
  • Modular design: Components are structured to support future scalability.
  • Open-source contributions: Built to allow community participation.

Extending the Project

You can extend Namaste Salesforce by:

  • Adding new tutorials or modifying existing ones in _docs/
  • Creating new blog posts in _posts/
  • Enhancing the UI through _layouts/ and _includes/
  • Contributing tools and resources to _tools/

📌 This structured approach ensures Namaste Salesforce remains easy to maintain, expand, and contribute to.

Table of Contents

Contents