From ff157033c8150a42e0fa233a14d2eae15714ed84 Mon Sep 17 00:00:00 2001 From: Siddharth Saha Date: Mon, 20 Nov 2023 15:53:43 -0500 Subject: [PATCH] Adding Gitbook website for Rules (#1) * Initial rearranging * Removing book * Removing gitbook branch as trigger branch --- .github/README.md | 1 + .github/workflows/ci.yaml | 28 ++++++++++++++++++ book.toml | 9 ++++++ src/Administrative/administrative.md | 22 ++++++++++++++ Appendix.md => src/Appendix/appendix.md | 0 {Electrical => src/Electrical}/electrical.md | 0 src/Introduction.md | 5 ++++ {Mechanical => src/Mechanical}/mechanical.md | 0 src/Overview.md | 13 ++++++++ .../Race_Procedure}/Obstacle_Diagram.png | Bin .../ReflectivePavementMarker.png | Bin .../Race_Procedure}/race_procedure.md | 0 src/SUMMARY.md | 12 ++++++++ {Safety => src/Safety}/safety.md | 0 {Software => src/Software}/software.md | 0 15 files changed, 90 insertions(+) create mode 120000 .github/README.md create mode 100644 .github/workflows/ci.yaml create mode 100644 book.toml create mode 100644 src/Administrative/administrative.md rename Appendix.md => src/Appendix/appendix.md (100%) rename {Electrical => src/Electrical}/electrical.md (100%) create mode 100644 src/Introduction.md rename {Mechanical => src/Mechanical}/mechanical.md (100%) create mode 100644 src/Overview.md rename {Race_Procedure => src/Race_Procedure}/Obstacle_Diagram.png (100%) rename {Race_Procedure => src/Race_Procedure}/ReflectivePavementMarker.png (100%) rename {Race_Procedure => src/Race_Procedure}/race_procedure.md (100%) create mode 100644 src/SUMMARY.md rename {Safety => src/Safety}/safety.md (100%) rename {Software => src/Software}/software.md (100%) diff --git a/.github/README.md b/.github/README.md new file mode 120000 index 0000000..7987695 --- /dev/null +++ b/.github/README.md @@ -0,0 +1 @@ +../src/Overview.md \ No newline at end of file diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..7873d2c --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,28 @@ +name: github pages + +on: + push: + branches: + - master + pull_request: + branches: + - master + +jobs: + deploy: + runs-on: ubuntu-latest + concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + steps: + - uses: actions/checkout@v4 + - name: Setup mdBook + uses: peaceiris/actions-mdbook@v1 + with: + mdbook-version: 'latest' + - run: mdbook build + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + # if: ${{ github.ref == 'refs/heads/master' }} + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./book \ No newline at end of file diff --git a/book.toml b/book.toml new file mode 100644 index 0000000..0e4cb6c --- /dev/null +++ b/book.toml @@ -0,0 +1,9 @@ +[book] +authors = ["Siddharth Saha", "Andrew Goeden"] +language = "en" +multilingual = false +src = "src" +title = "Autonomous Karting Series Rulebook" + +[output.html] +mathjax-support = true \ No newline at end of file diff --git a/src/Administrative/administrative.md b/src/Administrative/administrative.md new file mode 100644 index 0000000..b6882a4 --- /dev/null +++ b/src/Administrative/administrative.md @@ -0,0 +1,22 @@ +# Administrative + +## Who is allowed to compete + 1. Teams are required to be affiliated with an Academic Institution. + 2. A team can consist of members from more than one University, however any one person cannot be on multiple teams. + +## Required Roles + 1. All teams must establish at least one member as their Autonomous Safety Officer. + * The Autonomous Safety Office will ensure that their team’s kart is operating in a safe manner on and off track. + 2. All teams must establish at least one Designated Driver. + * A Designated Driver is a separate person from a team’s Autonomous Safety Officer. + * A Designated Driver is responsible for driving the team’s kart as either a driver within the kart or when the kart is being operated remotely. + +## Documentation Requirements from teams + 1. All participants must sign and submit a liability waiver. + 1. All teams must submit the required videos and design documentation before specified race deadlines. + 2. Some events may require certain components and features to be demonstrated in person. + 1. Teams must be able to demonstrate all components and features in person if requested. + 2. Teams will be notified of specific demonstrations before the event. + +## Jurisdiction of rules + 1. All announcements and comments posted on the official website of the competition are to be considered part of the official ruleset diff --git a/Appendix.md b/src/Appendix/appendix.md similarity index 100% rename from Appendix.md rename to src/Appendix/appendix.md diff --git a/Electrical/electrical.md b/src/Electrical/electrical.md similarity index 100% rename from Electrical/electrical.md rename to src/Electrical/electrical.md diff --git a/src/Introduction.md b/src/Introduction.md new file mode 100644 index 0000000..ab439fe --- /dev/null +++ b/src/Introduction.md @@ -0,0 +1,5 @@ +# Introduction + +## What is the competition + +The Autonomous Karting Series is a collegiate competition series in which teams design, build, and race autonomous electric go-karts. \ No newline at end of file diff --git a/Mechanical/mechanical.md b/src/Mechanical/mechanical.md similarity index 100% rename from Mechanical/mechanical.md rename to src/Mechanical/mechanical.md diff --git a/src/Overview.md b/src/Overview.md new file mode 100644 index 0000000..f0fefa0 --- /dev/null +++ b/src/Overview.md @@ -0,0 +1,13 @@ +# Overview + +This repository contains the development pages and official document for the Autonomous Karting Series Competition Rules. The individual sections of the rules have a folder with a markdown file for development and discussion purposes. The official document will be a protected latex file that requires approval to edit and modify. + +Development Rulebook can be seen [here](https://autonomous-karting-series.github.io/Rulebook/) + +## Commands + +For full documentation visit [mdbook](https://rust-lang.github.io/mdBook/). + +* `mdbook serve --open` - Start the live-reloading docs server. +* `mdbook build` - Build the documentation site. +* `mdbook help` - Print a help message. \ No newline at end of file diff --git a/Race_Procedure/Obstacle_Diagram.png b/src/Race_Procedure/Obstacle_Diagram.png similarity index 100% rename from Race_Procedure/Obstacle_Diagram.png rename to src/Race_Procedure/Obstacle_Diagram.png diff --git a/Race_Procedure/ReflectivePavementMarker.png b/src/Race_Procedure/ReflectivePavementMarker.png similarity index 100% rename from Race_Procedure/ReflectivePavementMarker.png rename to src/Race_Procedure/ReflectivePavementMarker.png diff --git a/Race_Procedure/race_procedure.md b/src/Race_Procedure/race_procedure.md similarity index 100% rename from Race_Procedure/race_procedure.md rename to src/Race_Procedure/race_procedure.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md new file mode 100644 index 0000000..a3e2e5e --- /dev/null +++ b/src/SUMMARY.md @@ -0,0 +1,12 @@ +# Summary + +[Introduction](Introduction.md) +[Overview](Overview.md) + +- [Administrative](Administrative/administrative.md) +- [Mechanical](Mechanical/mechanical.md) +- [Electrical](Electrical/electrical.md) +- [Race Procedure](Race_Procedure/race_procedure.md) +- [Safety](Safety/safety.md) +- [Software](Software/software.md) +- [Appendix](Appendix/appendix.md) \ No newline at end of file diff --git a/Safety/safety.md b/src/Safety/safety.md similarity index 100% rename from Safety/safety.md rename to src/Safety/safety.md diff --git a/Software/software.md b/src/Software/software.md similarity index 100% rename from Software/software.md rename to src/Software/software.md