Skip to content

J-MaFf/Guides

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

IT Support Documentation Repository

Welcome to the Guides repository! This is a collection of step-by-step documentation and quick-start guides for end users, with a primary focus on security and authentication setup procedures.

📋 Contents

🔐 Authentication Guides

Located in Windows Hello & Passkeys/src/:

📚 Additional Resources

Root directory contains departmental guides and reference materials:

  • JDL UPS Installation guide
  • KC VPN connection steps
  • SFA Alphabetical Customer ID Entry
  • Zebra RMA guide
  • And more...

🎯 Guide Philosophy

All guides in this repository follow a quick-start approach designed for 5-minute setup with:

  • ✅ Numbered, easy-to-follow steps
  • 🎨 Visual hierarchy with emoji section headers
  • 🔧 Troubleshooting tables for common issues
  • 📱 Multi-platform coverage (Windows 10 & 11 differences noted)
  • 📞 Clear support contact information

📝 Creating New Guides

Use the provided _TEMPLATE_guide.md as your starting point for consistency. The template includes:

  • Standard structure with numbered sections
  • Pre-requisites section
  • Troubleshooting table format
  • Support contact section

⚙️ Repository Setup

Configuration Files

  • .markdownlint.jsonc - Markdown linting rules (allows HTML tags for PDF generation)

File Structure

guides/
├── _TEMPLATE_guide.md                 # Template for new guides
├── .markdownlint.jsonc                # Linting configuration
├── Windows Hello & Passkeys/
│   ├── src/                           # Source markdown files
│   │   ├── Windows Hello setup guide.md
│   │   └── Google Passkey setup guide.md
│   ├── Windows Hello setup guide.pdf
│   └── Google Passkey setup guide.pdf
└── [Additional departmental guides]

🔄 Development Workflow

Updating Documentation

  1. Edit markdown source files in src/ directories
  2. Generate PDF outputs using pandoc: pandoc input.md -o output.pdf
  3. Update cross-reference links between related guides
  4. Maintain consistent formatting and contact information

Review Checklist

  • ✓ Contact information is current
  • ✓ All cross-reference links are valid
  • ✓ Steps verified on Windows 10 and Windows 11
  • ✓ Following template structure and emoji patterns
  • ✓ Troubleshooting section includes common issues

📞 Support Contacts

Primary Contact

Joey Maffiola - 650-581-4478

Secondary Contact

KMS - 650-581-4500

🔗 Integration Points

  • Google Drive for file sharing and PDF hosting
  • Windows Hello system capabilities
  • Google Passkey service availability

Repository: Guides Last Updated: October 2025

Ruleset Test

This is test content added by running the test PR script.

About

Various guides

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •