Learning Resources Library

By Amr Abdel Eissa

Reference documentation and learning resources for tools and technologies used in IT-Journey

Estimated reading time: 10 minutes

Learning Resources Library

Welcome to the IT-Journey Learning Resources Library - your reference documentation for the tools and technologies that power the IT-Journey platform.

About This Library

Purpose: This library contains educational content and reference documentation for external tools, frameworks, and technologies used in IT-Journey. It serves as a learning resource for IT-Journey users and contributors.

Audience: Learners, students, and anyone exploring the technologies used in building and maintaining the IT-Journey platform.

Developer Documentation

Note for Contributors: If you’re looking for technical documentation about the IT-Journey repository structure, contribution workflows, or development setup, please see the Developer Documentation in the repository root (/docs/ directory).

Available Documentation

Jekyll

The IT-Journey platform is built with Jekyll, a static site generator. The Jekyll documentation covers how IT-Journey specifically implements and uses Jekyll features.

Topics:

Future Documentation Areas

This library will expand to include reference documentation for:

Planned Topics:

  • Ruby - Ruby programming language fundamentals
  • Liquid - Advanced Liquid templating techniques
  • Bootstrap - Bootstrap framework usage
  • GitHub Pages - GitHub Pages deployment and configuration
  • Markdown - Advanced Markdown techniques
  • Git - Version control workflows

Documentation Philosophy

What Belongs Here

This /docs/ learning library contains:

  • External tool and technology references
  • Educational tutorials and guides
  • Framework and library documentation
  • Technology overviews and comparisons
  • Learning paths and resources

What Belongs in Developer Docs

The repository /docs/ directory contains:

  • IT-Journey repository structure and architecture
  • Development environment setup
  • Contribution workflows and standards
  • Testing frameworks and automation
  • Scripts and tools documentation
  • GitHub Actions and CI/CD workflows

How to Use This Library

For Learners

  1. Explore by Topic - Browse available technology documentation
  2. Follow Learning Paths - Use resources to build understanding
  3. Practice with IT-Journey - Apply concepts in the IT-Journey codebase
  4. Contribute Back - Share your learning by improving documentation

For Contributors

  1. Reference While Developing - Use as quick reference for tools
  2. Learn New Technologies - Understand technologies before contributing
  3. Add New Resources - Contribute documentation for new tools
  4. Keep It Updated - Help maintain accuracy and relevance

Contributing to This Library

Adding New Documentation

To add documentation for a new tool or technology:

  1. Create Directory - Add subdirectory under pages/_docs/
    mkdir pages/_docs/new-tool/
    
  2. Create Index - Add index.md with overview
    touch pages/_docs/new-tool/index.md
    
  3. Add Content - Create topic-specific markdown files
    touch pages/_docs/new-tool/getting-started.md
    
  4. Follow Standards - Use Frontmatter Standards

  5. Update Navigation - Add to _data/navigation/docs.yml

Content Guidelines

  • Focus on IT-Journey Context - Show how the tool is used in IT-Journey
  • Include Examples - Provide practical, working examples
  • Link to Official Docs - Reference authoritative sources
  • Keep It Current - Update when technologies change
  • Be Educational - Write for learners, not just reference

See Content Guidelines for detailed writing standards.

Documentation Sources

Git Submodules (Future)

The goal is to integrate official documentation from tool repositories using Git submodules:

# Example: Adding Jekyll official docs
git submodule add https://github.com/jekyll/jekyll.git jekyll-docs

# Configure sparse checkout for specific directories
cd jekyll-docs/docs/_docs
git sparse-checkout init --cone
git sparse-checkout set docs/_docs

This approach allows:

  • Always up-to-date official documentation
  • Clean separation of sources
  • Easy updates via Git

Manual Documentation

For tools without suitable official docs, we create our own:

  • Custom tutorials and guides
  • IT-Journey-specific implementations
  • Integration examples and patterns

Technology Stack

IT-Journey is built with:

Core Technologies

  • Jekyll 3.9.5 - Static site generator
  • Ruby 3.2.3 - Programming language
  • Liquid - Template language
  • Kramdown - Markdown processor
  • Bootstrap 5.2.0 - CSS framework

Development Tools

  • Git - Version control
  • Docker - Containerization
  • GitHub Actions - CI/CD automation
  • Python 3.11 - Scripting and automation

Services

  • GitHub Pages - Hosting
  • OpenAI GPT-4 - AI-powered analysis
  • Giscus - Comments via GitHub Discussions

For detailed information, see Jekyll Implementation.

Getting Help

Questions About This Library

  • Create issue with documentation label
  • Suggest improvements via pull requests
  • Start discussion in GitHub Discussions

Questions About Contributing

Additional Resources

IT-Journey Resources

External Resources


Last Updated: 2025-10-13
Version: 2.0.0

The Learning Resources Library is part of the IT-Journey project. For technical developer documentation, see the /docs/ directory.

Collection Index - docs

Default preview image
Jekyll - Liquid

Useful tricks of Liquid, which are used in Jekyll.

Default preview image
Jekyll - Math Symbols with MathJax

Display mathematical notation in web pages with MathJax.

Default preview image
Learning Resources Library

Learning Resources Library

Default preview image
Jekyll Frontmatter CMS

This is a comprehensive guide on how to use Jekyll and Frontmatter to build a powerful Content Management System (CMS).

Default preview image
Jekyll - Diagram with Mermaid

Use Mermaid in Markdown to draw diagrams.

Default preview image
Jekyll Documentation

Jekyll in IT-Journey