Skip to content

Commit

Permalink
Merge pull request #1 from rahulporuri/initial-setup
Browse files Browse the repository at this point in the history
FEAT: Initial setup of foss club handbook with mdbook
  • Loading branch information
rahulporuri authored Sep 17, 2024
2 parents afabd2d + 257a1f1 commit 58a7ede
Show file tree
Hide file tree
Showing 11 changed files with 63 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Deploy
on:
push:
branches:
- main

jobs:
deploy:
runs-on: ubuntu-latest
permissions:
contents: write # To push a branch
pages: write # To push to a GitHub Pages site
id-token: write # To update the deployment status
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install latest mdbook
run: |
tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
mkdir mdbook
curl -sSL $url | tar -xz --directory=./mdbook
echo `pwd`/mdbook >> $GITHUB_PATH
- name: Build Book
run: |
# This assumes your book is in the root of your repository.
# Just add a `cd` here if you need to change to another directory.
cd foss-club-handbook
mdbook build
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: 'book'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*/book/*
6 changes: 6 additions & 0 deletions foss-club-handbook/book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[book]
authors = ["Poruri Sai Rahul"]
language = "en"
multilingual = false
src = "src"
title = "FOSS Student Club Handbook"
8 changes: 8 additions & 0 deletions foss-club-handbook/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Summary

- [Qualifications for starting a club](./qualifications.md)
- [Organizational structure of the club](./structure.md)
- [Activities](./activities/README.md)
- [Awareness sessions](./activities/awareness.md)
- [Action sessions](./activities/action.md)
- [Tech aid clinics](./activities/techaid.md)
Empty file.
1 change: 1 addition & 0 deletions foss-club-handbook/src/activities/action.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Action sessions
1 change: 1 addition & 0 deletions foss-club-handbook/src/activities/awareness.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Awareness sessions
1 change: 1 addition & 0 deletions foss-club-handbook/src/activities/techaid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Tech aid clinics
1 change: 1 addition & 0 deletions foss-club-handbook/src/chapter_1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Chapter 1
3 changes: 3 additions & 0 deletions foss-club-handbook/src/qualifications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Qualifications


1 change: 1 addition & 0 deletions foss-club-handbook/src/structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Organizational structure of the club

0 comments on commit 58a7ede

Please sign in to comment.