STAR Public
  • Space Technologies and Rocketry
  • Quick Links
  • Member Info
    • Membership Requirements
    • Elections
  • Current Projects
    • ALULA: First Leap
      • Project Objectives
      • High-Level System Parameters
      • Propulsion
      • Avionics
      • Airframe
      • Recovery
    • Caldera: IREC 2024
      • Airframe
      • Avionics
      • Airbrakes
      • Recovery
      • Staging
      • KELSE-Y (Payload)
  • Previous Projects
    • CalVistor: IREC 2023
      • Recovery (CalVistor)
      • Airframe (CalVistor)
      • Airbrakes (CalVistor)
      • Payload (CalVistor)
    • ELLIE
      • ELLIE Overview
      • Timeline
      • Physical System
      • Electrical and Software
      • Ongoing Research
    • MINDI
      • Airframe
      • Recovery
    • PinkBeary
      • Altimeter Wiring Update
      • Airframe Diameter
      • Fin Sizing
      • Pyro Bolts
      • Electronics
    • CAS
      • CAS Overview
      • Core Module
      • Radio Module
      • Pyro Module
      • Prop Module
      • CAS Core Revised
      • CAS Radio Revised
    • DAVE
      • Summary of DAVE
      • FAQ's
      • DAVE Blog
    • Bear Force One: IREC 2020/2021
      • Airframe
      • Recovery
        • Parachute Harness
        • Avionics Bay
          • Avionics Bay Glossary
          • Avionics Bay Assembly
        • Black Powder Holders
        • Payload
          • Payload Subsystem Report
          • IRIS
            • Peripherals Diagram
            • Pinout Diagram
            • Power Flow Diagram
          • MFC (2020)
          • Stabilization
          • Structures
          • Cameras
          • Muons - Archived
          • IRIS Legacy - Archived
    • Arctos
    • AirBears
  • Frequently Asked Questions
  • Tutorials
    • Media
      • How to make a decent video
    • RFS Safety Training
    • Submitting Reimbursements
    • Software Setup
      • SolidWorks Installation
      • VMware/Boot Camp setup
      • [In-Progress] SolidWorks PDM Setup
      • ANSYS Installation and Setup
      • Solidworks Assemblies Basics
      • OpenRocket Installation
      • Deprecated Software
        • [deprecated] Getting Started With GrabCAD Workbench
        • [deprecated] Using GrabCAD Workbench in SolidWorks
        • [deprecated] Connecting to CalSTAR's Server
        • [deprecated] Installing and Licensing Converge CFD
    • General Tutorials
      • How to Use SolidWorks Templates
      • [In Progress] Digikey Ordering Guide
      • SolidWorks Training Session
      • SolidWorks Training Tutorials
    • Enery Systems
    • Manufacturing
      • Material Properties and Uses
      • 3D Printing (FDM)
      • Laser Cutting
      • FabLight: Metal Laser Cutter
      • Milling
        • Othermill
        • [Empty] Manual Mills
      • Tolerancing
      • Fasteners
      • Suppliers
      • Composite Materials and Best Practices
      • 8020 Extrusions
    • Airframe
      • Airframe Components
      • Tube Attachement
      • OpenRocket
      • Tube Winding
      • Sizing Fins
      • Attaching Fins
      • Rail Buttons
      • Motor Retention
      • Painting Rockets
    • Avionics
      • KiCad
      • Git
      • Project Management
      • Firmware Development Environment
      • Ground Station Software
      • Intro to Embedded C Programming
      • Schematic and Layout Review
      • Board Design Reference
      • Using Lab Equipment
      • Reflow Oven
      • Soldering
      • Debugging Tips/Testing
      • Ham Radio Basics
      • Component Selection
      • High Temperature Batteries
    • Outreach Activities
      • Straw Rocketry
      • Spacecraft Structures
      • Alka Seltzer Rockets
      • Paper Airplane Launcher
      • Coding Workshop
    • Operations
      • SolidWorks file conventions
      • Style Guidelines
      • LaTeX
    • Payload
    • Propulsion
      • Feed System Types
      • Rocket Propulsion Analysis Tutorial
      • Ignition Devices
      • Creating a Piping and Instrumentation Diagram P&ID
      • Pipes, Fittings, and Components
      • Injectors
    • Recovery
      • Parachute Sizing
      • Avionics Sled
      • [in progress] Altimeters
      • Wire Design and Routing
    • Simulations
      • FEA Simulation Tutorial using ANSYS
      • Getting Started with CONVERGE (2.4)
      • [Empty] Simulation Methods
      • Mathematical Models
      • SimScale
        • SimScale 3D CFD
      • Using ANSYS
      • ANSYS 19.2 2D CFD Tutorial
      • ANSYS 19.2 3D CFD Tutorial
    • Administrative
      • Azure Server
    • Page 1
  • Reference
    • Reference
    • Glossaries
      • Propulsion
      • Common Acronyms and Definitions
    • Brand Guidelines
    • Legal
    • High Power Rocketry (HPR)
      • NASA HPR Reference
      • L1 and L2 Certification Tips & Tricks
      • HPR Kits
      • HPR Design
      • HPR Suppliers
      • STAR HPR Certification
    • Ham Operators
    • X-Winder Update Log
    • Safety
      • Materials
      • Tools
      • Electrical
      • Range Safety
  • Testing
    • Test Forms
    • Damage Report Forms
    • Airframe Tests
    • Recovery Tests
      • Ground Ejection Test
  • Onboarding
    • Intro Projects
      • Airframe
      • Avionics
        • PCB Design Mini-Project
      • Operations
      • Payload
      • Propulsion
      • Outreach
      • Recovery
      • Media
      • Safety
      • Simulations
      • Old Intro Projects
        • Payload 2020 Intro Project
        • Propulsion Fall 2019
        • Avionics 2018
        • Recovery 2018
        • Avionics (new intro project Fall 2021)
  • Project Management
  • History of the Team
    • Early Years
    • Executive History
    • Launch History
      • 2022-12-03 MINDI First Flight
      • 2022-09-17 Pinkbeary First Flight
      • 2019-11-16 AirBears First Flight
      • 2018-03-24 Final flight for Arktos
      • 2017-04-08 Competition Launch, NASA SL 2017
      • 2017-03-25 FRR Re-Re-Flight, NASA SL 2017
      • 2017-03-12 FRR Re-Flight, NASA SL 2017
      • 2017-03-04 FRR Flight, NASA SL 2017
      • 2016-12-04 CDR Subscale Flight, NASA SL 2017
    • Fleet
  • How to use GitBook
Powered by GitBook
On this page
  • Step 1: Create an Account
  • Step 2: Get Access
  • Step 3: Navigate to Editing Interface
  • Draft Descriptions
  • Publishing a draft
  • For any and mostly all questions
  • Summary of the essentials
  • Known issues
  • Other ways to get help
Export as PDF

How to use GitBook

The GitBook interface will help you make beautiful docs; here's how to use it for STAR.

PreviousFleet

Last updated 1 year ago

Step 1: Create an Account

All members are encouraged to contribute to our project documentation! Set up a GitBook account on (through email or Google, GitHub, etc.--it doesn't matter as long as you remember your login info).

Step 2: Get Access

To get access, go to the #operations channel and follow the join link in the channel description at the top. This link will give you editing access to STAR Public docs as well as the STAR Internal space.

Step 3: Navigate to Editing Interface

Once at your dashboard, select which space you'd like to edit (this one is called STAR Public) by clicking on it.

You'll now have a sidebar with draft options. Click anywhere on a page and start typing/editing to start a new draft!

One draft can contain edits to multiple pages. Remember, always enter a draft description (see below)! You can also create new pages by mousing over the sidebar:

Draft Descriptions

After making a change (new draft), you must describe changes with a short message by clicking on "Describe this draft" in the Drafts section in the sidebar and writing a brief description.

Publishing a draft

Let's say you've written and saved a draft, and given it a draft description. There are two cases:

  1. You've written a fairly lengthy draft, aren't sure the style is quite consistent with the rest of our docs, had some formatting issue, or just generally wrote a quick draft that isn't highly polished.

  2. You've made a minor edit, or spent a significant amount of time making a polished and consistent page that you believe does not have errors.

If you fall into Case 1, or do not identify with either case, please message in the #operations channel saying something along the lines of "Hey, I've written a draft on xxx and was wondering if someone could check it over". In this case, the Operations team will take care of any remaining copy editing issues, formatting, etc. and publish the draft. You're done!

If you fall into Case 2, you are welcome to simply publish your draft by clicking on the blue "Merge" button in the sidebar. If you're not confident that the draft is error-free, please default to Case 1; the more eyes looking at the work the better.

For any and mostly all questions

Summary of the essentials

  • To add a new page, click "+ Add New Page" on the left sidebar or mouse over an existing section or page and click the " ⋯\cdots⋯ " button to add a new page under an existing section

  • All content is contained in cards; to create a new card: mouse over the empty space below existing content and click the '+' button

  • To rearrange cards: drag the square icon with 9 dots up or down

  • To create bold, **italic, strikethrough, or code text: in paragraph/heading mode, highlight a section of text and mouse over it to see options. Ctrl+B** and Ctrl+I also work as shortcuts.

  • To insert a math formula (Δv=veln⁡m0mf)\left( \Delta v = v_\text{e} \ln \frac {m_0} {m_f} \right)(Δv=ve​lnmf​m0​​) mouse over the cursor and click the '+' button, then click the equation button

  • To create lists, just type "- " or "* " or "1. " and it should auto-format to a bulleted list. You can also create a dedicated card with a list.

  • For multimedia, paste a link and it should auto-format. You can also create a new pane with images.

Known issues

If you're using Firefox and having issues inserting an image, try a different browser.

Placing "~" before and after text will make it strikethrough, like this. As a workaround to avoid this, write the text that's supposed to follow the second ~ somewhere else (such as the beginning of the paragraph), then copy and paste it to the appropriate position.

For example, to write "~5% or ~10%", you might do this:

~5% or

~10% ~5% or

~5% or ~10%

Other ways to get help

Post in the #operations channel on Discord with general issues, or message @rgovindjee#4641 if you have a problem with access/permissions/anything administrative.

Click this link to get to your dashboard: .

Please reference the GitBook documentation here; it should contain complete instructions on everything there is to know about GitBook:

Specifically, for basic instructions for editing see:

https://app.gitbook.com/@rocketry/space
https://docs.gitbook.com/
https://docs.gitbook.com/content-editing/markdown
https://www.gitbook.com/
See the section "Step 3" above if you don't have this sidebar visible
Basic features