Skip to content

Conversation

@sonupreetam
Copy link
Contributor

@sonupreetam sonupreetam commented Nov 21, 2025

Description

This PR introduces the foundational documentation infrastructure for Gemara with a Jekyll-based site and automated GitHub Pages deployment. This establishes the framework for comprehensive documentation including automated CUE schema generation (to be completed in follow-up PRs).

  1. Provides a documentation website
  2. Automatically deploys to GitHub Pages
  3. Dependabot bundler configuration
  4. Includes comprehensive tutorials for users and contributors

Implementation Status: 4 of 4 tasks completed

  • Jekyll infrastructure
  • Deployment workflow
  • Dependabot configuration
  • Makefile targets

Changes

1. Jekyll Documentation Site (docs/)

2. GitHub Actions Workflows

Jekyll Site Workflow (.github/workflows/jekyll-site.yml):

3. Dependabot Configuration

Adds bundler ecosystem to .github/dependabot.yaml to ensure Jekyll Gems stay up-to-date with security patches and updates.

4. Makefile Enhancements

New targets for documentation workflow:

make serve      # Start local Jekyll development server
make build      # Build static site locally
make stop       # Stop Jekyll server
make clean      # Clean generated files and containers

Testing

Local Testing

make serve
# Visit http://localhost:4000
make stop

Verified:

  • Site builds without errors
  • Navigation works correctly
  • Styling renders properly

CI Testing

  • Jekyll site builds successfully in GitHub Actions
  • Security checks passed
  • Path filtering triggers correctly

Related Issues

Partially resolves issue #155

Checklist

  • Clear title conforming to Conventional Commits spec
  • Descriptive commit message
  • DCO signoff on commits (git commit -s)
  • All CI checks pass (will verify after push)
  • No breaking changes
  • Security best practices followed

Additional Notes

For Reviewers:

  • Bulk of changes are in docs/ directory (Jekyll site structure)
  • Local preview recommended: make serve
  • This is a foundational PR; automated schema documentation will follow
  • Scope: Comprehensive documentation infrastructure with automation

Design Decisions:

  • Jekyll over MkDocs: Chosen for consistency with potential OpenSSF Security Baseline styling and GitHub Pages integration
  • Maintenance Plan: Dependabot configured for Gem updates; other maintenance process will be documented

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 21, 2025
Introduces foundational documentation infrastructure for Gemara:
- Jekyll-based documentation site (docs/)
- GitHub Actions workflow for automated deployment
- Makefile targets for local development
- Dependabot bundler configuration

Partially resolves ossf#155

Signed-off-by: sonupreetam <[email protected]>
@sonupreetam sonupreetam force-pushed the docs/jekyll-documentation-site branch from 51faea7 to 2f94ee8 Compare November 21, 2025 12:26
Copy link
Collaborator

@eddie-knight eddie-knight left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great!

Copy link
Contributor

@jpower432 jpower432 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! I'm running into issues get this to serve locally, but I think it might be isolated. I was able to with a couple changes to the container command. Just left a minor suggestion on the author in the config.

@sonupreetam sonupreetam marked this pull request as ready for review December 2, 2025 10:55
@sonupreetam sonupreetam requested a review from a team as a code owner December 2, 2025 10:55
Co-authored-by: Jennifer Power <[email protected]>
Co-authored-by: Eddie Knight <[email protected]>
Signed-off-by: t_hat <[email protected]>
@sonupreetam
Copy link
Contributor Author

@jpower432 Thank you for your review. If required, I can update the Makefile to automatically detect the host architecture for the local serving issues in a separate PR.

@jpower432
Copy link
Contributor

@jpower432 Thank you for your review. If required, I can update the Makefile to automatically detect the host architecture for the local serving issues in a separate PR.

Thanks @sonupreetam . It was not an architecture issue. It was around mismatch between the UID/GID between the host and container user when writing to the mounted volume. I can submit a GitHub Issue to describe my environment.

@jpower432 jpower432 merged commit 9039532 into ossf:main Dec 2, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consider adding a website for Gemara

3 participants