Introduction

Welcome to the Maker Space wiki!

Here you will find (hopefully) all the information you could possibly want to know about our hackspace, how it works, what facilities we have and how to use them.

In progress

This wiki is still being populated. For now you may still need to head to the old wiki for some information.

The Space

Maker Space is split into four main locations/sections:

Prepare yourself for a Microsoft Copilot guided tour through our space.

Pretty much all of the text in the above pages was generated by asking Copilot to "in the style of an estate agent, describe [very brief description of what is in the accompanying photo] in a hackspace". The relevant, mostly correct, appropriate, amusing, (and if you are really lucky) actually helpful parts of the response were then selected and made into a mostly cohesive bit of prose.

Ground Floor Corridor

As you step into this industrial haven, the corridor unfolds before you—a seamless blend of practicality and aesthetics. The heartbeat of this workspace, the corridor stretches like a silent river, connecting different realms within the building. It’s not merely a passageway; it’s a conduit of creativity and collaboration.

At one end of the corridor, behold the pièce de résistance - the laser cutter. Its sleek metallic frame stands like a sentinel, ready to transform raw materials into precision-cut masterpieces. The hum of the extraction adds a symphonic undertone to the corridor’s rhythm.

Overview of ground floor corridor

Ground Floor Workshop

Step into this vibrant hub of innovation, where imagination takes tangible form. Our main workshop is more than just a room - it's a canvas for your wildest ideas.

Picture a symphony of activity. The main workshop sprawls across the floor, partitioned into multiple work areas. Whether you're assembling a PCB or making tote bags, there's a spot for your creative endeavors.

Overview of ground floor workshop

Our electronics workspaces, a place where wires tangle like ivy, components sprawl like fallen leaves, and soldering irons hum like caffeinated bees.

The soldering stations wear battle scars. Burn marks, flux residue, and tangled solder wicks - they tell tales of countless connections forged. The air smells of molten dreams and a hint of desperation.

Dive in, untangle wires, and let sparks fly. Who knows? Your next invention might emerge from this delightful chaos.

Soldering/electronics station

In our cosy goldfish bowl you will find several PC workstations - each a digital canvas awaiting your command. These machines hum with potential, their screens reflecting the glow of countless projects.

Currently we have two general purpose machines: one Ubuntu 24.04 and one Windows 10, and one dedicated CAD machine running Windows 10, where 3D models take shape, and blueprints come alive. Whether you're designing a futuristic skyscraper or a whimsical teapot, these stations empower your vision.

Each wall of the room is clad in a labyrinth of industrial shelving. Each shelf cradles a universe of components, parts and tools.

Goldfish bowl

Welcome to the hackspace lounge, a tranquil corner where making takes a breather.

Behold at what some consider the most critical items in the space: our tea and coffee making facilities. The aroma of freshly brewed chai mingles with the robust scent of freshly ground beans. Choose your potion: tea or double-shot espresso? Both enjoyed from the Royal Doulton with the hand-painted periwinkles.

Nestled against the wall, our plush sofa beckons. Sink into its embrace - a refuge for tired hackers and dreamers alike. Whether you're pondering the next steps for your current project or just need a power nap, this sofa cradles your thoughts.

Open the fridge, and you'll find a treasure trove: cold brews, artisanal sodas, and perhaps a rogue slice of leftover pizza. It’s like Narnia, but with more caffeine. But please note some items belong to members or cost money if you'd like to consume them.

The bookcase stands tall, its shelves sagging under the weight of knowledge. Dusty hardcovers, dog-eared paperbacks, and a few mysterious tomes - they’re all here.

Tea/coffee, fridge and lounge area

The storage wall is a vast expanse of shelving, stretching from floor to ceiling, each unit brimming with a variety of tools, components, and materials. Every inch is utilized to its fullest potential, packed full of tools, parts and materials just waiting for the right project to come along.

The south side of this shelving is dedicated to storage for member's personal items.

Main workshop storage

Welcome to the vibrant hub of creativity within this dynamic hackspace: the breakfast bar. This inviting space is designed to foster collaboration and provide a comfortable spot for members to create and connect.

The breakfast bar table is a sleek, modern fixture, crafted from high-quality materials that blend functionality with style. It's spacious surface offers ample room for enjoying a quick snack, tinkering on a project, or engaging in lively discussions about the latest projects and ideas. The bar stools, with their ergonomic design, ensure comfort during those longer brainstorming sessions.

Strategically located within the hackspace, this area is bathed in natural light, creating a warm and welcoming atmosphere. The surrounding decor is thoughtfully curated to inspire creativity, with vibrant artwork and innovative designs adorning the walls.

Whether you’re taking a break from a challenging project or simply looking to network with fellow makers, the breakfast bar table area is the perfect spot.

Adjacent to the breakfast bar is the cutting-edge communication hub within the hackspace: the amateur radio setup. This area is meticulously designed for enthusiasts and hobbyists who are passionate about radio technology and communication.

This amateur radio setup is more than just a collection of equipment; it's a gateway to a world of communication and exploration. Whether you're a seasoned operator or new to the hobby, this space is designed to inspire and support your passion for radio technology.

Step into this exceptional amateur radio setup and experience the thrill of global communication right from the heart of our hackspace!

Breakfast bar and radio PC areas

Here we have our 3D printing station. This area is a dream come true for any maker, featuring top-of-the-line equipment that promises precision and reliability.

To the left, you’ll find the renowned Prusa MK3. Its user-friendly interface and reliable performance make it an indispensable tool for both beginners and seasoned professionals.

Complementing the Prusa MK3 is the cutting-edge Bambu Lab P1S. This advanced 3D printer is celebrated for its speed and versatility, capable of producing high-quality prints in a fraction of the time. With its sleek design and state-of-the-art features, the Bambu Lab P1S is perfect for those looking to push the boundaries of their creativity.

The 3D printing station is thoughtfully arranged to maximize efficiency and inspire innovation. Each printer is strategically positioned to allow for seamless workflow, with ample workspace for preparing and finishing prints. The station is well-lit and equipped with all the necessary tools and materials, ensuring that every project can be executed to perfection.

3D printer station

South Basement Workshop

Welcome to this unique and versatile basement workshop. This exceptional space is a haven for woodworking enthusiasts, offering a comprehensive array of tools and equipment to bring your creative visions to life. The workshop boasts a generous floor plan, providing ample room for multiple projects and collaborative work.

Main workspace

Here, we present a non-functioning CNC milling machine, awaiting the touch of a skilled hand to restore it to its former glory. The machine boasts a solid and durable construction, designed to handle heavy-duty tasks once operational.

The plastic bins harbor an orchestra of fasteners. Hex nuts, wing nuts, carriage bolts—they jostle for attention. And the washers? They’re like tiny time-traveling saucers, ready to stabilize your contraptions.

CNC mill and storage

This well-equipped work area is a dream come true for any maker, featuring an impressive array of machine tools designed to bring your projects to life. All tools are maintained to the highest standards, ensuring precision and reliability for every project. The work area is thoughtfully organised, with clear pathways and designated zones for each type of machine, promoting a smooth and efficient workflow.

Machine tools

In the corner you will find our wood and pipe storage area. This dedicated space is designed to cater to the needs of woodworking enthusiasts, ensuring that all materials are stored efficiently and safely. The area boasts a variety of storage solutions, including vertical racks, horizontal shelves, and custom bins, accommodating wood of all sizes and types.

Wood and pipe storage area

North Basement Workshop

Welcome to the cutting-edge corner of the basement workshop, where innovation meets precision. This dedicated area features the highly sought-after Workbee CNC router, a must-have for any serious maker or woodworker. The Workbee CNC router is the centerpiece of this corner, known for its accuracy and versatility. It’s perfect for intricate carvings, precise cuts, and complex designs. The intuitive control system and software make it accessible for both beginners and experienced users, allowing for seamless operation and creativity.

Workbee CNC router

Welcome to the meticulously curated hand tool collection within our vibrant hackspace. This essential area is a treasure trove for any maker, offering a diverse range of tools that cater to all your crafting and repair needs. Tools are neatly arranged on shelves and in toolboxes, making it easy to find exactly what you need quickly and efficiently. As part of our hackspace, this collection benefits from the collective knowledge and experience of our members, who are always willing to share tips and techniques. Regular maintenance ensures that all tools are kept in optimal condition, ready for use whenever inspiration strikes.

Hand tools

Welcome to the dedicated metalworking area within our innovative hackspace, a haven for metal enthusiasts and craftsmen alike. This well-appointed section is designed to cater to all your metalworking needs, featuring a top-of-the-line metal lathe as its centerpiece. The star of this area is a high-precision metal lathe, perfect for turning, facing, and threading a variety of metals. Its robust construction and advanced features ensure accuracy and reliability for all your projects. Alongside the lathe, you'll find an array of essential metalworking tools, including cutting tools, calipers, micrometers, and more, all meticulously maintained for optimal performance.

Against the rear wall, you will find yet another of our storage areas. These sturdy storage shelves, strategically placed against the wall, are designed to keep your tools and materials neatly arranged and easily accessible.

Metal lathe and storage

Against the adjoining wall you will discover the metal stock storage. This dedicated space is designed to cater to the needs of metalworking enthusiasts, ensuring that all materials are stored efficiently and safely. Metals are neatly categorized by type and size, making it easy to locate the exact material you need for your project. Whether you require aluminum, steel, copper, or brass, everything is clearly labeled and accessible. Conveniently located adjacent to the main metalworking area, the metal storage section allows for quick and easy access to materials, streamlining your workflow.

At the center of this dynamic space stands a robust and versatile workbench, designed to be the focal point for all your metalworking projects. This workbench is built to withstand the rigors of heavy-duty metalworking, featuring a solid frame and a thick, durable work surface. Equipped with a high-quality vice, the workbench ensures secure clamping of materials, allowing for precise and stable work.

Metal storage

Equipment

Here you will find an overview of the equipment available at Maker Space.

This is a list of the significant items, there are a lot of smaller/hand tools that are around.

Ground Floor Corridor

Ground Floor Workshop

South Basement Workshop

  • CNC Mill
  • Axminster Bandsaw
  • Belt/Disc Sander
  • Chop Saw

North Basement Workshop

  • Workbee CNC Router
  • Air Compressor
  • Metal Lathe
  • Bench Grinder

Laser Cutter

Laser cutter overview

A laser cutter. It cuts stuff using a laser.

Essential Information

  • Location: Ground Floor Corridor
  • Responsible Person(s): Dan Nixon
  • Induction Required: Yes

Usage notes

It is not permitted under any circumstances to leave this machine running unattended!

Bambu Lab P1S

Bambu Lab P1S overview

Bambu Lab P1S with AMS and external spool caddy. A very good, quick FDM 3D printer.

Essential Information

  • Location: Ground Floor Workshop
  • Responsible Person(s): Dan Nixon
  • Induction Required: No

Usage notes

It is not permitted to leave this (or any other) 3D printer running whilst Maker Space is unoccupied!

While no induction is required, it is very strongly recommended to read the user guide before using the printer.

Bambu Lab P1S user guide

Bambu Studio setup

Install

  1. Install and launch Bambu Suddio
  2. Click "Get Started"
    Bambu Studio welcome page
  3. Select "Europe"
    Bambu Studio region selection page
  4. Select "Skip"
    Bambu Studio data hoover page
  5. Select "Clear All"
    Bambu Studio printer selection page with default options
  6. Check "Bambu Lab P1S 0.4mm nozzle" and click "Next"
    Bambu Studio printer selection page with correct printer selected
  7. Customise the filament selection if needed, otherwise just click "Next"
    Bambu Studio filament selection page
  8. Ensure "Install Bambu Network plug-in" is checked and click "Finish"
    Bambu Studio network plugin install page

Add printer

  1. Switch to the "Devices" tab
    Bambu Studio devices tab with no printer added
  2. Click on "No printer" and select "3DP-01P-744" from the list
  3. When prompted enter the code from the printer menu as instructed
    Bambu Studio printer access code screen
  4. The printer status should now be shown in the "Device" tab
    Bambu Studio devices tab printer added

If you do not see the printer in the device list then most likely your machine is not properly configured to act as an SSDP client. See Simple Service Discovery Protocol and Printer Network Ports for more info. TL;DR: open UDP port 2021 on your machines firewall and try again.

When getting the access code from the printer do not select the refresh icon next to the code.

Loading, Unloading and Configuring Filament

Unloading

  1. Ensure the filament you wish to remove from the AMS is not currently loaded into the printer
  2. Pull the filament out of the AMS feeder and lift the spool out

You can tell if a filament is loaded into the printer either by:

  • Observing the tube connecting the AMS to the printer, if you cannot see the filament in question inside the tube then it is probably unloaded
  • Checking the diagram on the "Device" tab in Bambu Studio, if the line leading from the spool position is thin and grey then the filament is unloaded

Loading

Bambu Lab filament

  1. Place the spool in a free AMS slot
  2. Push the filament into the AMS feeder for the corresponding slot
  3. Wait 30 seconds or so for the filament to be identified
  4. Verify that the filament was correctly identified via the "Devices" tab in Bambu Studio

Generic filament on card spools

Filament on card spools should NOT be used directly in the AMS, the spool rollers chew up the card spools and make a mess of the AMS.

A shim can be printed to protect the edges of the card spool.

Shims on a cardboard filament spool

Some cardboard spools, once clad with a printed shim, are too wide for the lid of the AMS to be closed without clamping the spool and preventing it from moving. In this case the clips on the AMS lid may be used to prop the lid slightly open as shown below. This should only be done when a filament is loaded into the AMS that would otherwise foul the AMS lid, prefer closing the lid when possible to take advantage of the humidity control offered by the AMS.

AMS propped open

Generic filament

  1. Place the spool in a free AMS slot
  2. Push the filament into the AMS feeder for the corresponding slot
  3. In the "Device" tab of Bambu Studio, click the edit icon on the just loaded AMS slot (may show either an "?" or the settings for the last non RFID filament used in that slow)
    Bambu Studio AMS status showing unknown filament inserted
  4. Edit the parameters and click "Confirm"
    Bambu Studio filament settings dialog
  5. The "Devices" tab should now show the filament type you specified
    Bambu Studio AMS status showing configured filament

Printing

Preparing printer

  1. Ensure there are no obstacles above or below the bed and that the build plate is correctly seated, located by the white tabs on the rear corners (highlighted in red squares in the photo below)
    Front of printer prior to a print
  2. If you need to change filaments in the AMS, do so now

Preparing and starting job

  1. Load designs into the "Prepare" tab of Bambu Studio
    Bambu Studio prepare tab
  2. Synchronise local filament settings with AMS by clicking the Bambu Studio AMS sync button button on the filament settings panel, this will ensure your local filament settings reflect what is currently available on the printer
  3. Set machine, material and slicing settings in the left hand pane (yes the slicing profiles say "X1C", as far as I can tell this is fine)
  4. Click "Slice plate"
  5. You will see a preview in the "Preview" tab
    Bambu Studio preview tab
  6. If all is well, press "Print plate"
  7. Set options as desired, if you forgot to set the filament for your part you can override this here, disable timelapse if you have no intention of retrieving it, keep bed levelling and AMS enabled
    Bambu Studio job options
  8. Click "Send"
  9. Wait for the job to be uploaded
    Bambu Studio job uploading
  10. The "Device" page is automatically shown where you can monitor the jobs progress, adjust settings and temperatures if needed and pause or cancel the job
  11. It is worth checking that the purge filament has not ended up on the build plate, this should not happen but it is worth keeping an eye out for

End of job

  1. Remove build plate from printer
  2. Remove part from build plate
  3. Reseat build plate in printer
  4. Clean up any filament the printer has deposited (check the purge chute at the rear of the machine)

SD card

The micro SD card is used for storing print jobs, timelapse and camera recordings (amongst other things that are of little direct use to humans).

It is not advised to use the SD card as a means of getting print jobs onto the machine.

Removing the SD card is how you would get timelapses and camera recordings off the printer, however if you wish to do this then immediately return the card to the printer as removal of the card renders it inoperative.

Should the card be out of space, it can be safely formatted in the printer using the on screen menu.

Prusa MK3

Prusa MK3 overview

A sort of OK FDM 3D printer.

Essential Information

  • Location: Ground Floor Workshop
  • Responsible Person(s): ?
  • Induction Required: No

Usage notes

It is not permitted to leave this (or any other) 3D printer running whilst Maker Space is unoccupied!

This printer is fitted with a standard 0.4mm nozzle.

Octoprint is installed on a Raspberry Pi, which is capable of controlling and monitoring the printer over the network. The IP address to access the Octoprint interface is on a label on the front of the printer.

If you'd rather print from the SD card, you might find it useful to create a folder with your name for your files. Please remove any big files once you're done with them to save clogging the card up (same goes for Octoprint).

PrusaSlicer is generally the most straightforward way of slicing your files for printing, as it has a pre-made and tuned profile for the MK3.

If you don't know how to use a 3D printer, or if you're unsure of how to use the specific one in the space, please do ask someone before attempting to.

Governance

This section describes how Maker Space operates.

MS4 Induction checklist

This is a checklist of the things that a person who is inducting a new member to Maker Space should cover during their initial induction tour.

Introduction

Maker Space is a community owned and run working space. We've all clubbed together to get a space to work in. There aren't any grownups looking after this place, its just us, and it works because everyone pulls their weight to keep it running and nice for us all.

If in doubt, ask the mailing list.

  • It can be found on the website header -> discussion list
  • There is also a private list for members which is for the running of the space. You should have been added to this when you became a member - if not, please say something as you'll be missing out on key announcements.

Access to the space

  • Access is available if a keyholder has opened the space. i.e. Welcome Wednesday and regular evening sessions.
  • If you need access outside of the normal hours, ask on the discussion list as a keyholder may be planning to be in.

RFID Access

  • RFID fobs can be used to access:
    • The space, when a keyholder is in.
    • Machines that require an induction.
  • If you have a compatible fob already, you can use that. We also have some fobs available if you don't.
  • Register your fob by swiping the main door a few times and letting an admin know when you did it.

General Safety

  • Fire exits - keep clear! / Fire Extinguishers / First Aid Kit
  • Be mindful of smoke alarms.
  • What to do it fire alarm goes off - muster outside - if you find a fire, sound the alarm, yell etc, then leave.
  • Fire assembly point is in the car park at the back of the building.
  • Don't leave things on the floor where people might trip over them, bags, cables, project boxes etc, tripping over hurts
  • Use ladders when required rather than chairs, tables etc. and make sure it's stable.
  • Be mindful of others if you're doing something that might impact on them or if they might. e.g. working in doorways, walkways etc.
  • Do not work on live mains electricity, it's quite dangerous.

Toilets / Water / Drainage

  • Toilets near entrance.
  • Drinking water from Kitchen.
  • If you're covered in oil or grease, cleaning supplies (Swarfega etc.) are available. - Currently downstairs by the lathe.

Using the Space

People use the space differently, please be considerate.

  • Avoid telling people how to do their project. Sometimes the objective is to learn a new technique rather than solve the problem in the best way.
  • Try not to touch or pick up projects without permission.
  • Some people are here to be social, some people are here to work and may not want to talk. Please respect their space and leave them be!

Infrastructure/security

  • While many things are fair game for hacking/modifying, the core infrastructure/access control systems are not.
  • Attempts to 'defeat' security/access control for equipment will be viewed very negatively and may end up in restriction/removal of space access privileges.
  • If you want to improve a piece of core infrastructure e.g. music player etc, then discuss any proposed changes with its' current owner/maintainer first.

Parts/Materials

  • We have lots of scraps, off-cuts, spares and components etc. which can be used.
  • If you need something specific or a lot of something, please provide your own.

Maker Space has a clean desk policy

  • Try to tidy up as you go if possible. Work spaces should be clean and tidy before you leave.
  • If you need to leave something out, ask on the discussion list.
  • Bins, dustpans, brushes, mops, blue roll and vacuum cleaners etc. are around the space.
  • If you have cut, sawed, drilled, sanded, filed or ground anything then there will be something to clean up.

Bins

  • Large bins in the workshops - Dustpans and brushes attached.
  • Small bins around the space.
  • Please do not leave food waste in the space.
  • Bins currently to be taken home. Please help out if you can.
  • Battery disposal - Please take to a battery recycling point e.g. Tesco.
  • Recycling - Clean/Dry items that could go in a household recycling bin.
  • Ensure cans are empty and not likely to leak in someone's car
  • soft plastics/films if marked with "Recycle at Store"
  • No electronics/e-waste

Entrance Lobby

Hack or Die

  • Items on the shelves are for hacking and remaining items are periodically disposed of.
  • Please only add items you realistically think will be used by someone.
  • Please don't bring things in just for Hack or Die. Do that virtually (by email) instead.

Laser Cutter

  • Induction required - Ask on the members list.
  • Scrap material available for use.

Toilets

Workshop

Main room

3D Printers

  • No training but ask for help if you need it. Follow the QR code for the Bambu.
  • Unattended printing is not allowed.
  • Filament is paid for by the users. If you use it, bring some filament in occasionally.
  • Do not try to maintain the printer. Notify a maintainer or the discussion list.

Members' Store/ General Storage

  • Your box goes here - 32L - 18cm (h) x 60cm (w) x 40cm (d)
  • Please stack things carefully, especially high up.
  • Ask on mailing list about storing big things in space, before you bring it in.

Chemicals

  • Any chemicals in the space should be clearly labelled whether hazardous or not.
  • Flammables box - Flammable stuff lives here, put it back after using.
  • No dangerous chemicals please.
  • No spray painting in the space - ventilation isn't adequate.
  • No flames/smoking

Wall o' boxes and other material around space

  • OK to use stuff, but please add stuff too - It's all provided by members and rather than the space.
  • Please also apply 'fair use' principles to Space items - If you use a lot of something, replace it.
  • Put it back in the box and on the correct shelf when done (boxes are colour coded to shelves).
  • Glue gun - please make sure you let it cool before putting it away.
  • There are "Please hack"/"Do not hack" stickers and labels. Please respect them. If labelling something, write "Please/Do Not Hack", your name and the current date.

Tea and coffee facilities.

  • Coffee machine - used for hot water instead of a kettle.
  • Bin bags - on shelves.
  • Tea/biscuits/sweets etc often on the table - help yourself - feel free to add more

Fridge

  • Lemonade/Irn Bru - Free but please replenish what you use.
  • Club Mate - Prices/Payment details on the fridge.

Soldering station

  • Turn irons off after use
  • If don't know how to use, please ask
  • Hot tools/irons shouldn't be left unattended
  • Let stuff cool before putting away
  • Scraps tub for collecting bits of wire etc. Please don't leave bits all over the desk.

Stationery

  • In grey drawers

Media Centre

  • Green Button - Play/Pause (Random tracks if playlist is clear)
  • Red "Fire" Button - Short press skips track, Long press (2 Secs) clears playlist.
  • For full control use http://mediaserver:9000/
  • Apps available to control music from your phone (e.g. Squeezer)

Side room (Goldfish Bowl)

  • PCs available for use. Please don't install crap
  • Vinyl Cutter
  • Electronic component storage - keep it tidy!
  • Items Stored on the shelves belong to the space. They can be used but not to be hacked. Don't take them away from the space without permission.

Basement

There are PPE boards - please use them.

  • We have provided it, it's your job to use it. It's OK to remind people you see not using it when they should be.
  • Dust masks are available from the "Spare PPE" box.
  • If you know you're going to need specific PPE for a certain task ahead of time (respirator, coveralls), consider bringing it yourself.
  • Hearing protection - if you are making lots of loud noise make sure you and others near you wear it.
  • If you are making flying objects, ensure people who may be affected know and are offered eye protection.

Clean up after yourself

  • Tools / Bench top / Floor

Tools

  • Sander / Pillar Drill / Lathe / Mill / Band Saw / Workbee CNC
    • RFID Controlled. Induction Required, ask on the members list or email the maintainer to get inducted.
  • Hand tools generally around the space on boards.
  • Drills, hand power tools, Dremel and bits/collets near the Workbee CNC machine.
  • Return tools when you have finished with them, definitely before leaving space.

Storage

  • Wood Store - Help yourself - Add more wood/offcuts when finished own projects. Please check for "Do Not Hack" stickers before using.
  • Nuts/Bolts/Screws - please keep tidy - use "M Don't Know" if you can't determine the size.
  • Metal Store - to be used for projects etc. Be careful of sharp edges, don't leave any for others.
  • Table legs may not be spare. Please check before using.

Wiki Guide

This section describes a little about the wiki, how to use it and how to write content for it.

The wiki uses mdBook, the content is hosted on GitHub and the site is hosted on Cloudflare Pages.

Contributing content

If you would like to make some changes to the wiki, have a read of the style and contributing guides.

Wiki style guide

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

  • File and directory names must be snake_case
  • Text should be formatted as one sentence per line (i.e. a newline should always follow a .)
  • Each document must make correct use of headings, i.e. # as the document title, incrementing by one (##, ###, ...) for each subsequent level of nesting desired
  • Unless referenced elsewhere, photos should be either in the same directory as the document that references them or in a directory named images in the same directory as the document that references them
  • Photos should be cropped to only show what is relevant to the document
  • Photos should be of an appropriate resolution (i.e. high enough to resolve sufficient detail, but low enough to not be excessive in size or page load time)

Contributing to the wiki

This outlines the means of editing the wiki.

If you are familiar with Git, then you can likely skip most of these docs, install mdBook locally and contribute as you would to any other project. The one caveat is that if you wish to use the CI generated previews then you must not work from a fork of the MakerSpaceNewcastle/wiki repository (you do not need to as being a member of the MakerSpaceNewcastle organisation gives you write permission to this repository).

Relevant parts of the mdBook documentation to reference are:

Prerequisites

Single page via the GitHub web UI

This will walk through making a change to a single page of the wiki.

In this example, let's assume you wish to add a couple more tools to the equipment page, only adding them to this list, not creating their description pages.

  1. On the page, click the edit icon in the top right hand corner:

    Edit icon indicated in top right hand corner

  2. This will take you to the online text editor on GitHub (if you are not already signed in then you will be asked to). Make the desired changes (in this case the addition of the air compressor and bench grinder to the list) and click the green "Commit changes..." button.

    Making changes via the GitHub web text editor

  3. You will be asked to provide a commit message, type something descriptive here and click the green "Propose changes" button.

    The remaining options may be left as their defaults. If the options provided to you look different to the above then verify you have satisfied the prerequisites.

    Committing changes via the GitHub web interface

  4. You will be taken to the create pull request screen, proceed to Proposing changes via a Pull Request.

Locally via Git clone

Note that these instructions are quite brief for the time being.

  1. Clone the wiki repository.
  2. Inside the repository, run mdbook serve. This will start a local web server that will update the site live as you make changes.
  3. Make your changes via your text editor/IDE of choice.
  4. Commit the changes to a new branch.
  5. Push the branch.
  6. Open a pull request, proceed to Proposing changes via a Pull Request.

Proposing changes via a Pull Request

  1. Provide a suitably descriptive title and description of your changes and click the green "Create pull request" button.

    Filling in Pull Request details

  2. One the pull request has been opened, you will see the actions start to run. This will build the site and deploy a preview of it.

    GitHub Actions running on Pull Request

  3. Once the actions have completed, you will see a comment appear with a link to preview the changes.

    Preview comment on Pull Request

  4. Opening the link in the comments and browsing to the equipment page shows the changes made.

    Preview of changes

  5. Depending on exactly what has been changed in the pull request, certain people may have automatically been requested to review your changes, if so they must provide their reviews first. You may also opt to ask people to review your changes if desired.

    Otherwise you can now click the green "Squash and merge" button, followed by "Confirm squash and merge" to accept the proposed changes.

    Merging Pull Request

  6. The pull request is closed, the live wiki will now update.

    Closed Pull Request after merging