From 2c2a803dadf2cbfed6b3c2b8b34971b54a42e76c Mon Sep 17 00:00:00 2001 From: Ghost Date: Mon, 4 Jul 2016 10:52:59 +0200 Subject: [PATCH 001/106] GitBook Example --- .gitignore | 16 ++++++++++++++++ README.md | 3 +++ SUMMARY.md | 3 +++ chapter1.md | 3 +++ 4 files changed, 25 insertions(+) create mode 100644 .gitignore create mode 100644 README.md create mode 100644 SUMMARY.md create mode 100644 chapter1.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..1a366fb0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +# Node rules: +## Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +## Dependency directory +## Commenting this out is preferred by some people, see +## https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git +node_modules + +# Book build output +_book + +# eBook build output +*.epub +*.mobi +*.pdf \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..f35b4c5a --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# My Awesome Book + +This file file serves as your book's preface, a great place to describe your book's content and ideas. diff --git a/SUMMARY.md b/SUMMARY.md new file mode 100644 index 00000000..84616cd7 --- /dev/null +++ b/SUMMARY.md @@ -0,0 +1,3 @@ +# Summary + +* [First Chapter](chapter1.md) diff --git a/chapter1.md b/chapter1.md new file mode 100644 index 00000000..c0e22c64 --- /dev/null +++ b/chapter1.md @@ -0,0 +1,3 @@ +# First Chapter + +GitBook allows you to organize your book into chapters, each chapter is stored in a separate file like this one. From 5271b5004ab6b8f7a5420a3e4da49fbc6206161a Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 11 Feb 2017 16:45:39 +0000 Subject: [PATCH 002/106] Updates README.md Auto commit by GitBook Editor --- README.md | 5 +++-- chapter1.md | 3 ++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f35b4c5a..fa6de71e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ -# My Awesome Book +# Student Robotics Kit Logistics Documentation + +This is the documentation of the Student Robotics Kit Logistics Coordinator. It is primarily for internal use, but may be of interest to others. If you are in a team competing in Student Robotics, you probably want the [Docs](https://www.studentrobotics.org/docs). -This file file serves as your book's preface, a great place to describe your book's content and ideas. diff --git a/chapter1.md b/chapter1.md index c0e22c64..9fa172bd 100644 --- a/chapter1.md +++ b/chapter1.md @@ -1,3 +1,4 @@ -# First Chapter +# Student Robotics Kit Logistics Documentation GitBook allows you to organize your book into chapters, each chapter is stored in a separate file like this one. + From 194f806c17a691080683a4beed53da09e7b84f96 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 11 Feb 2017 17:14:37 +0000 Subject: [PATCH 003/106] Updates SUMMARY.md Auto commit by GitBook Editor --- SUMMARY.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/SUMMARY.md b/SUMMARY.md index 84616cd7..c0847ccb 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,3 +1,5 @@ # Summary -* [First Chapter](chapter1.md) +* [Introduction](README.md) +* [Procedures](chapter1.md) + From 733928b1435e9e6ee7340a230f42ad4bea4bf971 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 11 Feb 2017 17:19:18 +0000 Subject: [PATCH 004/106] Updates README.md Auto commit by GitBook Editor --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index fa6de71e..60433e27 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,16 @@ This is the documentation of the Student Robotics Kit Logistics Coordinator. It is primarily for internal use, but may be of interest to others. If you are in a team competing in Student Robotics, you probably want the [Docs](https://www.studentrobotics.org/docs). +The responsibilities of the Kit Logistics Coordinator are as follows: + +* To store the kit +* To manage the transportation/shipping of the kit +* To manage the organisation's third part post handling service +* To maintain a record of the location and state of all Student Robotics assets + +To fulfil these responsibilities the Kit Logistics Coordinator also does the following + +* Maintain a suite of logistics software + + + From ae3f289940f0c641c6a20b07c728143a5bfaf218 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 11 Feb 2017 17:25:01 +0000 Subject: [PATCH 005/106] Creates logistics-software.md Auto commit by GitBook Editor --- SUMMARY.md | 5 +- chapter1.md | 4 +- kit-transport.md | 142 ++++++++++++++++++++++++++++++++++++++++++ logistics-software.md | 0 post-handling.md | 0 5 files changed, 148 insertions(+), 3 deletions(-) create mode 100644 kit-transport.md create mode 100644 logistics-software.md create mode 100644 post-handling.md diff --git a/SUMMARY.md b/SUMMARY.md index c0847ccb..56ef7bc0 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,5 +1,8 @@ # Summary * [Introduction](README.md) -* [Procedures](chapter1.md) +* [Kit Storage](chapter1.md) +* [Kit Shipping](kit-transport.md) +* [Post Handling](post-handling.md) +* [Logistics Software](logistics-software.md) diff --git a/chapter1.md b/chapter1.md index 9fa172bd..fb1f4e9c 100644 --- a/chapter1.md +++ b/chapter1.md @@ -1,4 +1,4 @@ -# Student Robotics Kit Logistics Documentation +# Kit Storage + -GitBook allows you to organize your book into chapters, each chapter is stored in a separate file like this one. diff --git a/kit-transport.md b/kit-transport.md new file mode 100644 index 00000000..e62ac4a8 --- /dev/null +++ b/kit-transport.md @@ -0,0 +1,142 @@ +# Kit Shipping + +Throughout the year kits need to be shipped around. This page contains information pertaining to this task. + +## Procedures + +### Shipping kits to Kickstarts + +To provide sufficient time for problems/delays, kits should be shipped to Kickstart locations no later than 1 week before Kickstart. Shipping the kits many weeks in advance may not be possible due to limited storage requirements at some Kickstart locations. + +First ensure that the Kickstart Event Coordinator is aware of the paperwork requirements (handout forms and disclaimers). Request the following information from the Kickstart Event Coordinator: + + * Name of Local Kickstart Event Coordinator + * Email address of Local Kickstart Event Coordinator + * Number of teams attending + * Name of person able to receive the kit (if not the Local Kickstart Event Coordinator) + * Email address of person able to receive the kit (if not the Local Kickstart Event Coordinator) + * Phone number of person able to receive the kit + * Address to ship the kit to + +For each Kickstart: + + 1. Ensure that the Local Kickstart Event Coordinator, or the person that they are delegating kit management to, has received the necessary training (to be defined). + 1. Identify the kits to be shipped in the Inventory and move them into an appropriate `in-transit` sub directory (e.g. `in-transit/to-oxford-ks`). + 1. Instruct UK Postbox to forward the correct items to the recipient. + 1. Once UK Postbox have forwarded on the kits, email the LKEC and the recipient (if not the LKEC) with the tracking number/link and a list of kit asset numbers shipped to them. Ask them to report back when they have received the shipment and doubled checked that they have the expected kits. + 1. Once the kits have been delivered, move them in the Inventory to an appropriate sub directory (e.g. `kickstart-venues/oxford`). + 1. Email details of what kits are where to the Kickstart Event Coordinator so that they can prepare handout forms for each of the Local Kickstart Event Coordinators. + +After Kickstart, request scanned copies of the handout form and disclaimers from all of the Kickstarts from the Kickstart Event Coordinator (who will then request them from the Local Kickstart Coordinators). Move each kit into an appropriate sub directory in the Inventory based upon which team it was given to (e.g. move a kit to `teams/2017/srz`). + +### Shipping kits to teams that didn't attend a Kickstart + +The operations manual currently requires that the Kit Logistics Coordinator ensures that kits are available to be collected by a courier no later than 2 week after Kickstart. + +Begin by requesting the following information from the Team Coordinator for the teams that didn't attend a Kickstart and ask them to confirm that the details are correct via the appropriate LTC: + + * Name of LTC + * Email of LTC (so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator) + * Name of recipient + * Email of recipient + * Phone number of recipient (ideally a mobile number as that's what couriers prefer) + * Address including: + * School name + * Number (if applicable) + * Street + * Town/City + * County + * Postcode + +For each team that needs a kit: + +1. Identify the kit to be shipped in the Inventory and move it to an appropriate `in-transit` sub directory (e.g. `in-transit/to-srz`). +1. Once the details have been confirmed, instruct UK Postbox to forward the correct item to the team. +1. Once UK Postbox have forwarded on the kit, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. +1. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory (e.g. `teams/2017/srz`). + +### Managing kits not collected at Kickstart + +Some teams may not turn up at Kickstart, therefore leaving their kit uncollected. This kit needs to either be stored safely by someone nearby or returned to UK Postbox. The kit will most likely make its way to a team (either the originally intended recipient or otherwise) in the week or two after Kickstart. + +If a responsible person in attendance at the Kickstart event (for example the Local Kickstart Coordinator) is willing to store the kit for a week or two, and is able to make it available for courier collection, then this is preferable. + +If it is not possible to store the kit locally, it must be returned to UK Postbox ASAP. A [Return Shipping Pack](#markdown-header-return-shipping-pack) must be used to package the kit for return. Someone (possibly the venue) will need to make the kit available for courier collection in the day or two following Kickstart. + +### Reallocating kits from drop-outs + +We need to ship kits from one team to another when a team drops out. TBD. + +### Shipping spares/replacements + +When parts of the kit break teams need replacements. The Kit Logistics Coordinator needs to ship these spares/replacements to teams when instructed to do so by the Kit Support Coordinator. + +Begin by requesting the following information from the Team Coordinator for the team that needs replacement parts shipping to them and ask them to confirm that the details are correct via the appropriate LTC: + + * Name of LTC + * Email of LTC (so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator) + * Name of recipient + * Email of recipient + * Phone number of recipient (ideally a mobile number as that's what couriers prefer) + * Address including: + * School name + * Number (if applicable) + * Street + * Town/City + * County + * Postcode + +1. Identify the replacement parts to be shipped in the Inventory (as defined by the Kit Support Coordinator) and move them to an appropriate `in-transit` sub directory (e.g. `in-transit/to-srz`). +1. Package the parts into a cardboard box, using Jiffy bags, bubblewrap or similar to protect the parts. +1. Once the details have been confirmed, arrange for the package to be collected from yourself and delivered to the team. +1. Once you have the tracking number from the courier, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. +1. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory (e.g. `teams/2017/srz`). + +### Shipping kits to storage at the end of the competition + +At the end of the competition we have the majority of the kits returned to us. The Competition Team Coordinator is responsible for managing the return process. The Kit Logistics Coordinator can aid in this process and is responsible for shipping the kits to storage after they have been returned. TBD. + +### Ensuring the timely return of kits not returned at the competition + +Some teams will have been given permission to retain their kit for a while after the competition. The teams are responsible for arranging and paying for a courier to return the kit to us. The Kit Logistics Coordinator is responsible for assisting teams in this process and ensuring that all kits are returned by the 1st June of the same year that the competition was held in. TBD. + +### Shipping of non-team kits and development tools to volunteers + +Non-team kits (those that are classed as development, support, PR or local) and development tools need to be shipped around as deemed appropriate by the person responsible for their allocation. That being the Kit Coordinator for development kits and tools, the Kit Support Coordinator for support kits, the PR coordinator for PR kits and the Team Coordinator for local kits. TBD. + +### Shipping of non-kit assets + +Most assets are kit related. However, a few assets are not kits or parts thereof. This is mostly competition hardware such as arena walls. The Kit Logistics Coordinator is also responsible for shipping these non-kit assets when required. TBD. + +## General shipping info +### Packaging + + * Kits should generally be shipped in the while 18l Really Useful Box (RUB). + * All parts of the kit should be suitably protected either in Jiffy bags or bubble wrap. + * Batteries **must** be placed inside the charging bag. + * In general no more than two batteries should be shipped in each RUB (to ease shipping restrictions). + * Damaged batteries must not be shipped. + * Any empty space in the box should be filled with paper or bubble wrap. No packing peanuts; They're messy. + * The box should be sealed with cable ties and high quality tape over the handles (not selotape or insulating tape). + +### Return Shipping Pack + +When teams have to return a kit to us we provide them with a return shipping pack. This kit contains the following: + + * 1 off 575x700mm polythene bag (http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu) [bag research](return_shipping_bag_research) + * 4 off 160x4.8mm cable ties (http://www.cabletiesonline.co.uk/cable-ties/cable-ties-160mm-x-4-8mm/prod_402.html) + +### Couriers + +We have confirmed that the following couriers are happy handling packages containing lithium polymer batteries: + + * Interlink + +Kit data for couriers: + + * Dimensions: 48cm x 39cm x 20cm + * Weight: 6kg (A kit weighs 4.95kg [ref](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Kit%20Definition). 6kg gives some headroom) + * Value (for insurance): £500 + * Batteries: Lithium Ion. Packed with equipment. Batteries less than 100Wh. + +In all circumstances a shipment of a kit must have at least £500 worth of insurance. \ No newline at end of file diff --git a/logistics-software.md b/logistics-software.md new file mode 100644 index 00000000..e69de29b diff --git a/post-handling.md b/post-handling.md new file mode 100644 index 00000000..e69de29b From 68928096c02f903ba5fa64cc7f77f323a3f93e5a Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 11 Feb 2017 17:36:32 +0000 Subject: [PATCH 006/106] Updates kit-transport.md Auto commit by GitBook Editor --- kit-transport.md | 140 ++++++++++++++++++++++++----------------------- 1 file changed, 71 insertions(+), 69 deletions(-) diff --git a/kit-transport.md b/kit-transport.md index e62ac4a8..c5df9a97 100644 --- a/kit-transport.md +++ b/kit-transport.md @@ -1,6 +1,6 @@ # Kit Shipping -Throughout the year kits need to be shipped around. This page contains information pertaining to this task. +Part of the Kit Logistics Coordinator's responsibilities cover moving either whole or parts of kits around the UK and the world. This is generally referred to as shipping \(even though it rarely involves ships!\). There are specific points throughout the year when kit needs to be shipped and the procedures followed are detailed below. ## Procedures @@ -8,26 +8,26 @@ Throughout the year kits need to be shipped around. This page contains informati To provide sufficient time for problems/delays, kits should be shipped to Kickstart locations no later than 1 week before Kickstart. Shipping the kits many weeks in advance may not be possible due to limited storage requirements at some Kickstart locations. -First ensure that the Kickstart Event Coordinator is aware of the paperwork requirements (handout forms and disclaimers). Request the following information from the Kickstart Event Coordinator: +First ensure that the Kickstart Event Coordinator is aware of the paperwork requirements \(handout forms and disclaimers\). Request the following information from the Kickstart Event Coordinator: - * Name of Local Kickstart Event Coordinator - * Email address of Local Kickstart Event Coordinator - * Number of teams attending - * Name of person able to receive the kit (if not the Local Kickstart Event Coordinator) - * Email address of person able to receive the kit (if not the Local Kickstart Event Coordinator) - * Phone number of person able to receive the kit - * Address to ship the kit to +* Name of Local Kickstart Event Coordinator +* Email address of Local Kickstart Event Coordinator +* Number of teams attending +* Name of person able to receive the kit \(if not the Local Kickstart Event Coordinator\) +* Email address of person able to receive the kit \(if not the Local Kickstart Event Coordinator\) +* Phone number of person able to receive the kit +* Address to ship the kit to For each Kickstart: - 1. Ensure that the Local Kickstart Event Coordinator, or the person that they are delegating kit management to, has received the necessary training (to be defined). - 1. Identify the kits to be shipped in the Inventory and move them into an appropriate `in-transit` sub directory (e.g. `in-transit/to-oxford-ks`). - 1. Instruct UK Postbox to forward the correct items to the recipient. - 1. Once UK Postbox have forwarded on the kits, email the LKEC and the recipient (if not the LKEC) with the tracking number/link and a list of kit asset numbers shipped to them. Ask them to report back when they have received the shipment and doubled checked that they have the expected kits. - 1. Once the kits have been delivered, move them in the Inventory to an appropriate sub directory (e.g. `kickstart-venues/oxford`). - 1. Email details of what kits are where to the Kickstart Event Coordinator so that they can prepare handout forms for each of the Local Kickstart Event Coordinators. +1. Ensure that the Local Kickstart Event Coordinator, or the person that they are delegating kit management to, has received the necessary training \(to be defined\). +2. Identify the kits to be shipped in the Inventory and move them into an appropriate `in-transit` sub directory \(e.g. `in-transit/to-oxford-ks`\). +3. Instruct UK Postbox to forward the correct items to the recipient. +4. Once UK Postbox have forwarded on the kits, email the LKEC and the recipient \(if not the LKEC\) with the tracking number/link and a list of kit asset numbers shipped to them. Ask them to report back when they have received the shipment and doubled checked that they have the expected kits. +5. Once the kits have been delivered, move them in the Inventory to an appropriate sub directory \(e.g. `kickstart-venues/oxford`\). +6. Email details of what kits are where to the Kickstart Event Coordinator so that they can prepare handout forms for each of the Local Kickstart Event Coordinators. -After Kickstart, request scanned copies of the handout form and disclaimers from all of the Kickstarts from the Kickstart Event Coordinator (who will then request them from the Local Kickstart Coordinators). Move each kit into an appropriate sub directory in the Inventory based upon which team it was given to (e.g. move a kit to `teams/2017/srz`). +After Kickstart, request scanned copies of the handout form and disclaimers from all of the Kickstarts from the Kickstart Event Coordinator \(who will then request them from the Local Kickstart Coordinators\). Move each kit into an appropriate sub directory in the Inventory based upon which team it was given to \(e.g. move a kit to `teams/2017/srz`\). ### Shipping kits to teams that didn't attend a Kickstart @@ -35,33 +35,33 @@ The operations manual currently requires that the Kit Logistics Coordinator ensu Begin by requesting the following information from the Team Coordinator for the teams that didn't attend a Kickstart and ask them to confirm that the details are correct via the appropriate LTC: - * Name of LTC - * Email of LTC (so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator) - * Name of recipient - * Email of recipient - * Phone number of recipient (ideally a mobile number as that's what couriers prefer) - * Address including: - * School name - * Number (if applicable) - * Street - * Town/City - * County - * Postcode +* Name of LTC +* Email of LTC \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) +* Name of recipient +* Email of recipient +* Phone number of recipient \(ideally a mobile number as that's what couriers prefer\) +* Address including: + * School name + * Number \(if applicable\) + * Street + * Town/City + * County + * Postcode For each team that needs a kit: -1. Identify the kit to be shipped in the Inventory and move it to an appropriate `in-transit` sub directory (e.g. `in-transit/to-srz`). -1. Once the details have been confirmed, instruct UK Postbox to forward the correct item to the team. -1. Once UK Postbox have forwarded on the kit, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. -1. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory (e.g. `teams/2017/srz`). +1. Identify the kit to be shipped in the Inventory and move it to an appropriate `in-transit` sub directory \(e.g. `in-transit/to-srz`\). +2. Once the details have been confirmed, instruct UK Postbox to forward the correct item to the team. +3. Once UK Postbox have forwarded on the kit, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. +4. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). ### Managing kits not collected at Kickstart -Some teams may not turn up at Kickstart, therefore leaving their kit uncollected. This kit needs to either be stored safely by someone nearby or returned to UK Postbox. The kit will most likely make its way to a team (either the originally intended recipient or otherwise) in the week or two after Kickstart. +Some teams may not turn up at Kickstart, therefore leaving their kit uncollected. This kit needs to either be stored safely by someone nearby or returned to UK Postbox. The kit will most likely make its way to a team \(either the originally intended recipient or otherwise\) in the week or two after Kickstart. -If a responsible person in attendance at the Kickstart event (for example the Local Kickstart Coordinator) is willing to store the kit for a week or two, and is able to make it available for courier collection, then this is preferable. +If a responsible person in attendance at the Kickstart event \(for example the Local Kickstart Coordinator\) is willing to store the kit for a week or two, and is able to make it available for courier collection, then this is preferable. -If it is not possible to store the kit locally, it must be returned to UK Postbox ASAP. A [Return Shipping Pack](#markdown-header-return-shipping-pack) must be used to package the kit for return. Someone (possibly the venue) will need to make the kit available for courier collection in the day or two following Kickstart. +If it is not possible to store the kit locally, it must be returned to UK Postbox ASAP. A [Return Shipping Pack](#return-shipping-pack) must be used to package the kit for return. Someone \(possibly the venue\) will need to make the kit available for courier collection in the day or two following Kickstart. ### Reallocating kits from drop-outs @@ -73,24 +73,24 @@ When parts of the kit break teams need replacements. The Kit Logistics Coordinat Begin by requesting the following information from the Team Coordinator for the team that needs replacement parts shipping to them and ask them to confirm that the details are correct via the appropriate LTC: - * Name of LTC - * Email of LTC (so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator) - * Name of recipient - * Email of recipient - * Phone number of recipient (ideally a mobile number as that's what couriers prefer) - * Address including: - * School name - * Number (if applicable) - * Street - * Town/City - * County - * Postcode - -1. Identify the replacement parts to be shipped in the Inventory (as defined by the Kit Support Coordinator) and move them to an appropriate `in-transit` sub directory (e.g. `in-transit/to-srz`). -1. Package the parts into a cardboard box, using Jiffy bags, bubblewrap or similar to protect the parts. -1. Once the details have been confirmed, arrange for the package to be collected from yourself and delivered to the team. -1. Once you have the tracking number from the courier, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. -1. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory (e.g. `teams/2017/srz`). +* Name of LTC +* Email of LTC \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) +* Name of recipient +* Email of recipient +* Phone number of recipient \(ideally a mobile number as that's what couriers prefer\) +* Address including: + * School name + * Number \(if applicable\) + * Street + * Town/City + * County + * Postcode + +1. Identify the replacement parts to be shipped in the Inventory \(as defined by the Kit Support Coordinator\) and move them to an appropriate `in-transit` sub directory \(e.g. `in-transit/to-srz`\). +2. Package the parts into a cardboard box, using Jiffy bags, bubblewrap or similar to protect the parts. +3. Once the details have been confirmed, arrange for the package to be collected from yourself and delivered to the team. +4. Once you have the tracking number from the courier, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. +5. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). ### Shipping kits to storage at the end of the competition @@ -102,41 +102,43 @@ Some teams will have been given permission to retain their kit for a while after ### Shipping of non-team kits and development tools to volunteers -Non-team kits (those that are classed as development, support, PR or local) and development tools need to be shipped around as deemed appropriate by the person responsible for their allocation. That being the Kit Coordinator for development kits and tools, the Kit Support Coordinator for support kits, the PR coordinator for PR kits and the Team Coordinator for local kits. TBD. +Non-team kits \(those that are classed as development, support, PR or local\) and development tools need to be shipped around as deemed appropriate by the person responsible for their allocation. That being the Kit Coordinator for development kits and tools, the Kit Support Coordinator for support kits, the PR coordinator for PR kits and the Team Coordinator for local kits. TBD. ### Shipping of non-kit assets Most assets are kit related. However, a few assets are not kits or parts thereof. This is mostly competition hardware such as arena walls. The Kit Logistics Coordinator is also responsible for shipping these non-kit assets when required. TBD. ## General shipping info + ### Packaging - * Kits should generally be shipped in the while 18l Really Useful Box (RUB). - * All parts of the kit should be suitably protected either in Jiffy bags or bubble wrap. - * Batteries **must** be placed inside the charging bag. - * In general no more than two batteries should be shipped in each RUB (to ease shipping restrictions). - * Damaged batteries must not be shipped. - * Any empty space in the box should be filled with paper or bubble wrap. No packing peanuts; They're messy. - * The box should be sealed with cable ties and high quality tape over the handles (not selotape or insulating tape). +* Kits should generally be shipped in the while 18l Really Useful Box \(RUB\). +* All parts of the kit should be suitably protected either in Jiffy bags or bubble wrap. +* Batteries **must** be placed inside the charging bag. +* In general no more than two batteries should be shipped in each RUB \(to ease shipping restrictions\). +* Damaged batteries must not be shipped. +* Any empty space in the box should be filled with paper or bubble wrap. No packing peanuts; They're messy. +* The box should be sealed with cable ties and high quality tape over the handles \(not selotape or insulating tape\). ### Return Shipping Pack When teams have to return a kit to us we provide them with a return shipping pack. This kit contains the following: - * 1 off 575x700mm polythene bag (http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu) [bag research](return_shipping_bag_research) - * 4 off 160x4.8mm cable ties (http://www.cabletiesonline.co.uk/cable-ties/cable-ties-160mm-x-4-8mm/prod_402.html) +* 1 off 575x700mm polythene bag \([http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu](http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu)\) [bag research](return_shipping_bag_research) +* 4 off 160x4.8mm cable ties \([http://www.cabletiesonline.co.uk/cable-ties/cable-ties-160mm-x-4-8mm/prod\_402.html](http://www.cabletiesonline.co.uk/cable-ties/cable-ties-160mm-x-4-8mm/prod_402.html)\) ### Couriers We have confirmed that the following couriers are happy handling packages containing lithium polymer batteries: - * Interlink +* Interlink [http://www.interlinkdirect.co.uk/](http://www.interlinkdirect.co.uk/) Kit data for couriers: - * Dimensions: 48cm x 39cm x 20cm - * Weight: 6kg (A kit weighs 4.95kg [ref](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Kit%20Definition). 6kg gives some headroom) - * Value (for insurance): £500 - * Batteries: Lithium Ion. Packed with equipment. Batteries less than 100Wh. +* Dimensions: 48cm x 39cm x 20cm +* Weight: 6kg \(A kit weighs 4.95kg [ref](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Kit%20Definition). 6kg gives some headroom\) +* Value \(for insurance\): £500 +* Batteries: Lithium Ion. Packed with equipment. Batteries less than 100Wh. + +In all circumstances a shipment of a kit must have at least £500 worth of insurance. -In all circumstances a shipment of a kit must have at least £500 worth of insurance. \ No newline at end of file From 30a803914dd8e8f18c048c325a8e89fb20e7ba2f Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 11 Feb 2017 17:45:06 +0000 Subject: [PATCH 007/106] Creates chapter1/foo.md Auto commit by GitBook Editor --- SUMMARY.md | 1 + chapter1/foo.md | 0 procedures.md | 0 3 files changed, 1 insertion(+) create mode 100644 chapter1/foo.md create mode 100644 procedures.md diff --git a/SUMMARY.md b/SUMMARY.md index 56ef7bc0..2bea88c2 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -3,6 +3,7 @@ * [Introduction](README.md) * [Kit Storage](chapter1.md) * [Kit Shipping](kit-transport.md) + * [Procedures](/kit-transport.md#procedures) * [Post Handling](post-handling.md) * [Logistics Software](logistics-software.md) diff --git a/chapter1/foo.md b/chapter1/foo.md new file mode 100644 index 00000000..e69de29b diff --git a/procedures.md b/procedures.md new file mode 100644 index 00000000..e69de29b From 97df0f1b74b9407880da2d2be5738d1d8df26b69 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 11 Feb 2017 17:53:52 +0000 Subject: [PATCH 008/106] Updates kit-transport/procedures.md Auto commit by GitBook Editor --- SUMMARY.md | 3 +- kit-transport.md | 104 ---------------------------------- kit-transport/procedures.md | 109 ++++++++++++++++++++++++++++++++++++ procedures.md | 0 4 files changed, 111 insertions(+), 105 deletions(-) create mode 100644 kit-transport/procedures.md delete mode 100644 procedures.md diff --git a/SUMMARY.md b/SUMMARY.md index 2bea88c2..3f52039d 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -3,7 +3,8 @@ * [Introduction](README.md) * [Kit Storage](chapter1.md) * [Kit Shipping](kit-transport.md) - * [Procedures](/kit-transport.md#procedures) + * [Procedures](kit-transport/procedures.md) * [Post Handling](post-handling.md) +* Asset Tracking \(aka Inventory\) * [Logistics Software](logistics-software.md) diff --git a/kit-transport.md b/kit-transport.md index c5df9a97..d44fe602 100644 --- a/kit-transport.md +++ b/kit-transport.md @@ -2,111 +2,7 @@ Part of the Kit Logistics Coordinator's responsibilities cover moving either whole or parts of kits around the UK and the world. This is generally referred to as shipping \(even though it rarely involves ships!\). There are specific points throughout the year when kit needs to be shipped and the procedures followed are detailed below. -## Procedures -### Shipping kits to Kickstarts - -To provide sufficient time for problems/delays, kits should be shipped to Kickstart locations no later than 1 week before Kickstart. Shipping the kits many weeks in advance may not be possible due to limited storage requirements at some Kickstart locations. - -First ensure that the Kickstart Event Coordinator is aware of the paperwork requirements \(handout forms and disclaimers\). Request the following information from the Kickstart Event Coordinator: - -* Name of Local Kickstart Event Coordinator -* Email address of Local Kickstart Event Coordinator -* Number of teams attending -* Name of person able to receive the kit \(if not the Local Kickstart Event Coordinator\) -* Email address of person able to receive the kit \(if not the Local Kickstart Event Coordinator\) -* Phone number of person able to receive the kit -* Address to ship the kit to - -For each Kickstart: - -1. Ensure that the Local Kickstart Event Coordinator, or the person that they are delegating kit management to, has received the necessary training \(to be defined\). -2. Identify the kits to be shipped in the Inventory and move them into an appropriate `in-transit` sub directory \(e.g. `in-transit/to-oxford-ks`\). -3. Instruct UK Postbox to forward the correct items to the recipient. -4. Once UK Postbox have forwarded on the kits, email the LKEC and the recipient \(if not the LKEC\) with the tracking number/link and a list of kit asset numbers shipped to them. Ask them to report back when they have received the shipment and doubled checked that they have the expected kits. -5. Once the kits have been delivered, move them in the Inventory to an appropriate sub directory \(e.g. `kickstart-venues/oxford`\). -6. Email details of what kits are where to the Kickstart Event Coordinator so that they can prepare handout forms for each of the Local Kickstart Event Coordinators. - -After Kickstart, request scanned copies of the handout form and disclaimers from all of the Kickstarts from the Kickstart Event Coordinator \(who will then request them from the Local Kickstart Coordinators\). Move each kit into an appropriate sub directory in the Inventory based upon which team it was given to \(e.g. move a kit to `teams/2017/srz`\). - -### Shipping kits to teams that didn't attend a Kickstart - -The operations manual currently requires that the Kit Logistics Coordinator ensures that kits are available to be collected by a courier no later than 2 week after Kickstart. - -Begin by requesting the following information from the Team Coordinator for the teams that didn't attend a Kickstart and ask them to confirm that the details are correct via the appropriate LTC: - -* Name of LTC -* Email of LTC \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) -* Name of recipient -* Email of recipient -* Phone number of recipient \(ideally a mobile number as that's what couriers prefer\) -* Address including: - * School name - * Number \(if applicable\) - * Street - * Town/City - * County - * Postcode - -For each team that needs a kit: - -1. Identify the kit to be shipped in the Inventory and move it to an appropriate `in-transit` sub directory \(e.g. `in-transit/to-srz`\). -2. Once the details have been confirmed, instruct UK Postbox to forward the correct item to the team. -3. Once UK Postbox have forwarded on the kit, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. -4. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). - -### Managing kits not collected at Kickstart - -Some teams may not turn up at Kickstart, therefore leaving their kit uncollected. This kit needs to either be stored safely by someone nearby or returned to UK Postbox. The kit will most likely make its way to a team \(either the originally intended recipient or otherwise\) in the week or two after Kickstart. - -If a responsible person in attendance at the Kickstart event \(for example the Local Kickstart Coordinator\) is willing to store the kit for a week or two, and is able to make it available for courier collection, then this is preferable. - -If it is not possible to store the kit locally, it must be returned to UK Postbox ASAP. A [Return Shipping Pack](#return-shipping-pack) must be used to package the kit for return. Someone \(possibly the venue\) will need to make the kit available for courier collection in the day or two following Kickstart. - -### Reallocating kits from drop-outs - -We need to ship kits from one team to another when a team drops out. TBD. - -### Shipping spares/replacements - -When parts of the kit break teams need replacements. The Kit Logistics Coordinator needs to ship these spares/replacements to teams when instructed to do so by the Kit Support Coordinator. - -Begin by requesting the following information from the Team Coordinator for the team that needs replacement parts shipping to them and ask them to confirm that the details are correct via the appropriate LTC: - -* Name of LTC -* Email of LTC \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) -* Name of recipient -* Email of recipient -* Phone number of recipient \(ideally a mobile number as that's what couriers prefer\) -* Address including: - * School name - * Number \(if applicable\) - * Street - * Town/City - * County - * Postcode - -1. Identify the replacement parts to be shipped in the Inventory \(as defined by the Kit Support Coordinator\) and move them to an appropriate `in-transit` sub directory \(e.g. `in-transit/to-srz`\). -2. Package the parts into a cardboard box, using Jiffy bags, bubblewrap or similar to protect the parts. -3. Once the details have been confirmed, arrange for the package to be collected from yourself and delivered to the team. -4. Once you have the tracking number from the courier, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. -5. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). - -### Shipping kits to storage at the end of the competition - -At the end of the competition we have the majority of the kits returned to us. The Competition Team Coordinator is responsible for managing the return process. The Kit Logistics Coordinator can aid in this process and is responsible for shipping the kits to storage after they have been returned. TBD. - -### Ensuring the timely return of kits not returned at the competition - -Some teams will have been given permission to retain their kit for a while after the competition. The teams are responsible for arranging and paying for a courier to return the kit to us. The Kit Logistics Coordinator is responsible for assisting teams in this process and ensuring that all kits are returned by the 1st June of the same year that the competition was held in. TBD. - -### Shipping of non-team kits and development tools to volunteers - -Non-team kits \(those that are classed as development, support, PR or local\) and development tools need to be shipped around as deemed appropriate by the person responsible for their allocation. That being the Kit Coordinator for development kits and tools, the Kit Support Coordinator for support kits, the PR coordinator for PR kits and the Team Coordinator for local kits. TBD. - -### Shipping of non-kit assets - -Most assets are kit related. However, a few assets are not kits or parts thereof. This is mostly competition hardware such as arena walls. The Kit Logistics Coordinator is also responsible for shipping these non-kit assets when required. TBD. ## General shipping info diff --git a/kit-transport/procedures.md b/kit-transport/procedures.md new file mode 100644 index 00000000..1f129306 --- /dev/null +++ b/kit-transport/procedures.md @@ -0,0 +1,109 @@ +## Procedures + +### Shipping kits to Kickstarts + +To provide sufficient time for problems/delays, kits should be shipped to Kickstart locations no later than 1 week before Kickstart. Shipping the kits many weeks in advance may not be possible due to limited storage requirements at some Kickstart locations. + +First ensure that the Kickstart Event Coordinator is aware of the paperwork requirements \(handout forms and disclaimers\). Request the following information from the Kickstart Event Coordinator: + +* Name of Local Kickstart Event Coordinator +* Email address of Local Kickstart Event Coordinator +* Number of teams attending +* Name of person able to receive the kit \(if not the Local Kickstart Event Coordinator\) +* Email address of person able to receive the kit \(if not the Local Kickstart Event Coordinator\) +* Phone number of person able to receive the kit +* Address to ship the kit to + +For each Kickstart: + +1. Ensure that the Local Kickstart Event Coordinator, or the person that they are delegating kit management to, has received the necessary training \(to be defined\). +2. Identify the kits to be shipped in the Inventory and move them into an appropriate `in-transit` sub directory \(e.g. `in-transit/to-oxford-ks`\). +3. Instruct UK Postbox to forward the correct items to the recipient. +4. Once UK Postbox have forwarded on the kits, email the LKEC and the recipient \(if not the LKEC\) with the tracking number/link and a list of kit asset numbers shipped to them. Ask them to report back when they have received the shipment and doubled checked that they have the expected kits. +5. Once the kits have been delivered, move them in the Inventory to an appropriate sub directory \(e.g. `kickstart-venues/oxford`\). +6. Email details of what kits are where to the Kickstart Event Coordinator so that they can prepare handout forms for each of the Local Kickstart Event Coordinators. + +After Kickstart, request scanned copies of the handout form and disclaimers from all of the Kickstarts from the Kickstart Event Coordinator \(who will then request them from the Local Kickstart Coordinators\). Move each kit into an appropriate sub directory in the Inventory based upon which team it was given to \(e.g. move a kit to `teams/2017/srz`\). + +### Shipping kits to teams that didn't attend a Kickstart + +The operations manual currently requires that the Kit Logistics Coordinator ensures that kits are available to be collected by a courier no later than 2 week after Kickstart. + +Begin by requesting the following information from the Team Coordinator for the teams that didn't attend a Kickstart and ask them to confirm that the details are correct via the appropriate LTC: + +* Name of LTC +* Email of LTC \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) +* Name of recipient +* Email of recipient +* Phone number of recipient \(ideally a mobile number as that's what couriers prefer\) +* Address including: + * School name + * Number \(if applicable\) + * Street + * Town/City + * County + * Postcode + +For each team that needs a kit: + +1. Identify the kit to be shipped in the Inventory and move it to an appropriate `in-transit` sub directory \(e.g. `in-transit/to-srz`\). +2. Once the details have been confirmed, instruct UK Postbox to forward the correct item to the team. +3. Once UK Postbox have forwarded on the kit, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. +4. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). + +### Managing kits not collected at Kickstart + +Some teams may not turn up at Kickstart, therefore leaving their kit uncollected. This kit needs to either be stored safely by someone nearby or returned to UK Postbox. The kit will most likely make its way to a team \(either the originally intended recipient or otherwise\) in the week or two after Kickstart. + +If a responsible person in attendance at the Kickstart event \(for example the Local Kickstart Coordinator\) is willing to store the kit for a week or two, and is able to make it available for courier collection, then this is preferable. + +If it is not possible to store the kit locally, it must be returned to UK Postbox ASAP. A [Return Shipping Pack](#return-shipping-pack) must be used to package the kit for return. Someone \(possibly the venue\) will need to make the kit available for courier collection in the day or two following Kickstart. + +### Reallocating kits from drop-outs + +We need to ship kits from one team to another when a team drops out. TBD. + +### Shipping spares/replacements + +When parts of the kit break teams need replacements. The Kit Logistics Coordinator needs to ship these spares/replacements to teams when instructed to do so by the Kit Support Coordinator. + +Begin by requesting the following information from the Team Coordinator for the team that needs replacement parts shipping to them and ask them to confirm that the details are correct via the appropriate LTC: + +* Name of LTC +* Email of LTC \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) +* Name of recipient +* Email of recipient +* Phone number of recipient \(ideally a mobile number as that's what couriers prefer\) +* Address including: + + * School name + * Number \(if applicable\) + * Street + * Town/City + * County + * Postcode + +* Identify the replacement parts to be shipped in the Inventory \(as defined by the Kit Support Coordinator\) and move them to an appropriate `in-transit` sub directory \(e.g. `in-transit/to-srz`\). + +* Package the parts into a cardboard box, using Jiffy bags, bubblewrap or similar to protect the parts. + +* Once the details have been confirmed, arrange for the package to be collected from yourself and delivered to the team. +* Once you have the tracking number from the courier, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. +* Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). + +### Shipping kits to storage at the end of the competition + +At the end of the competition we have the majority of the kits returned to us. The Competition Team Coordinator is responsible for managing the return process. The Kit Logistics Coordinator can aid in this process and is responsible for shipping the kits to storage after they have been returned. TBD. + +### Ensuring the timely return of kits not returned at the competition + +Some teams will have been given permission to retain their kit for a while after the competition. The teams are responsible for arranging and paying for a courier to return the kit to us. The Kit Logistics Coordinator is responsible for assisting teams in this process and ensuring that all kits are returned by the 1st June of the same year that the competition was held in. TBD. + +### Shipping of non-team kits and development tools to volunteers + +Non-team kits \(those that are classed as development, support, PR or local\) and development tools need to be shipped around as deemed appropriate by the person responsible for their allocation. That being the Kit Coordinator for development kits and tools, the Kit Support Coordinator for support kits, the PR coordinator for PR kits and the Team Coordinator for local kits. TBD. + +### Shipping of non-kit assets + +Most assets are kit related. However, a few assets are not kits or parts thereof. This is mostly competition hardware such as arena walls. The Kit Logistics Coordinator is also responsible for shipping these non-kit assets when required. TBD. + diff --git a/procedures.md b/procedures.md deleted file mode 100644 index e69de29b..00000000 From 7426274e268de7b82c576a4e6533eb46a5d4705f Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 11 Feb 2017 17:56:21 +0000 Subject: [PATCH 009/106] Updates kit-transport.md Auto commit by GitBook Editor --- kit-transport.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/kit-transport.md b/kit-transport.md index d44fe602..45e3d160 100644 --- a/kit-transport.md +++ b/kit-transport.md @@ -1,8 +1,6 @@ # Kit Shipping -Part of the Kit Logistics Coordinator's responsibilities cover moving either whole or parts of kits around the UK and the world. This is generally referred to as shipping \(even though it rarely involves ships!\). There are specific points throughout the year when kit needs to be shipped and the procedures followed are detailed below. - - +Part of the Kit Logistics Coordinator's responsibilities cover moving either whole or parts of kits around the UK and the world. This is generally referred to as shipping \(even though it rarely involves ships!\). There are specific points throughout the year when kit needs to be shipped and the procedures followed are detailed in the [Procedures](/kit-transport/procedures.md) chapter. ## General shipping info From 32f697a93c31721f791d23d641fdca4035bf3f17 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 11 Feb 2017 18:08:38 +0000 Subject: [PATCH 010/106] Updates kit-transport/couriers.md Auto commit by GitBook Editor --- SUMMARY.md | 2 ++ kit-transport.md | 36 ++++-------------------------------- kit-transport/couriers.md | 15 +++++++++++++++ kit-transport/packaging.md | 19 +++++++++++++++++++ 4 files changed, 40 insertions(+), 32 deletions(-) create mode 100644 kit-transport/couriers.md create mode 100644 kit-transport/packaging.md diff --git a/SUMMARY.md b/SUMMARY.md index 3f52039d..090eee6e 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -4,6 +4,8 @@ * [Kit Storage](chapter1.md) * [Kit Shipping](kit-transport.md) * [Procedures](kit-transport/procedures.md) + * [Packaging](kit-transport/packaging.md) + * [Couriers](kit-transport/couriers.md) * [Post Handling](post-handling.md) * Asset Tracking \(aka Inventory\) * [Logistics Software](logistics-software.md) diff --git a/kit-transport.md b/kit-transport.md index 45e3d160..3a5c4411 100644 --- a/kit-transport.md +++ b/kit-transport.md @@ -1,38 +1,10 @@ # Kit Shipping -Part of the Kit Logistics Coordinator's responsibilities cover moving either whole or parts of kits around the UK and the world. This is generally referred to as shipping \(even though it rarely involves ships!\). There are specific points throughout the year when kit needs to be shipped and the procedures followed are detailed in the [Procedures](/kit-transport/procedures.md) chapter. +Part of the Kit Logistics Coordinator's responsibilities cover moving either whole or parts of kits around the UK and the world. This is generally referred to as shipping \(even though it rarely involves ships!\). All movement of kit is managed by the Kit Logistics Coordinator, so please do not ship anything without first speaking to them. You can contact them at: [logistics@studentrobotics.org](mailto:logistics@studentrobotics.org). -## General shipping info +Almost all shipping requirements happen at well defined points throughout the Student Robotics calendar. When kits or parts therefore need to be shipped specific procedures are followed as detailed in the [Procedures](/kit-transport/procedures.md) chapter. -### Packaging +When kits or parts of kit are being shipped they must be suitably packaged to prevent them from being damaged. Details of the packaging requirements are detailed in the [Packaging](/kit-transport/packaging.md) chapter. -* Kits should generally be shipped in the while 18l Really Useful Box \(RUB\). -* All parts of the kit should be suitably protected either in Jiffy bags or bubble wrap. -* Batteries **must** be placed inside the charging bag. -* In general no more than two batteries should be shipped in each RUB \(to ease shipping restrictions\). -* Damaged batteries must not be shipped. -* Any empty space in the box should be filled with paper or bubble wrap. No packing peanuts; They're messy. -* The box should be sealed with cable ties and high quality tape over the handles \(not selotape or insulating tape\). - -### Return Shipping Pack - -When teams have to return a kit to us we provide them with a return shipping pack. This kit contains the following: - -* 1 off 575x700mm polythene bag \([http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu](http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu)\) [bag research](return_shipping_bag_research) -* 4 off 160x4.8mm cable ties \([http://www.cabletiesonline.co.uk/cable-ties/cable-ties-160mm-x-4-8mm/prod\_402.html](http://www.cabletiesonline.co.uk/cable-ties/cable-ties-160mm-x-4-8mm/prod_402.html)\) - -### Couriers - -We have confirmed that the following couriers are happy handling packages containing lithium polymer batteries: - -* Interlink [http://www.interlinkdirect.co.uk/](http://www.interlinkdirect.co.uk/) - -Kit data for couriers: - -* Dimensions: 48cm x 39cm x 20cm -* Weight: 6kg \(A kit weighs 4.95kg [ref](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Kit%20Definition). 6kg gives some headroom\) -* Value \(for insurance\): £500 -* Batteries: Lithium Ion. Packed with equipment. Batteries less than 100Wh. - -In all circumstances a shipment of a kit must have at least £500 worth of insurance. +Some parts of the kit require special attention when being shipped. The [Couriers](/kit-transport/couriers.md) chapter includes information on these requirements along with some general information about the parts commonly shipped. diff --git a/kit-transport/couriers.md b/kit-transport/couriers.md new file mode 100644 index 00000000..b95ed869 --- /dev/null +++ b/kit-transport/couriers.md @@ -0,0 +1,15 @@ +# Couriers + +We have confirmed that the following couriers are happy handling packages containing lithium polymer batteries: + +* Interlink [http://www.interlinkdirect.co.uk/](http://www.interlinkdirect.co.uk/) + +Kit data for couriers: + +* Dimensions: 48cm x 39cm x 20cm +* Weight: 6kg \(A kit weighs 4.95kg [ref](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Kit%20Definition). 6kg gives some headroom\) +* Value \(for insurance\): £500 +* Batteries: Lithium Ion. Packed with equipment. Batteries less than 100Wh. + +In all circumstances a shipment of a kit must have at least £500 worth of insurance. + diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md new file mode 100644 index 00000000..f8bfb36a --- /dev/null +++ b/kit-transport/packaging.md @@ -0,0 +1,19 @@ +# Packaging + +* Kits should generally be shipped in the while 18l Really Useful Box \(RUB\). +* All parts of the kit should be suitably protected either in Jiffy bags or bubble wrap. +* Batteries **must** be placed inside the charging bag. +* In general no more than two batteries should be shipped in each RUB \(to ease shipping restrictions\). +* Damaged batteries must not be shipped. +* Any empty space in the box should be filled with paper or bubble wrap. No packing peanuts; They're messy. +* The box should be sealed with cable ties and high quality tape over the handles \(not selotape or insulating tape\). + +## Return Shipping Pack + +When teams have to return a kit to us we provide them with a return shipping pack. This kit contains the following: + +* 1 off 575x700mm polythene bag \([http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu](http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu)\) [bag research](return_shipping_bag_research) +* 4 off 160x4.8mm cable ties \([http://www.cabletiesonline.co.uk/cable-ties/cable-ties-160mm-x-4-8mm/prod\_402.html](http://www.cabletiesonline.co.uk/cable-ties/cable-ties-160mm-x-4-8mm/prod_402.html)\) + + + From c547296ea02f4ae8569aee9249d1dc2dc9f6ce30 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 11 Feb 2017 18:15:16 +0000 Subject: [PATCH 011/106] Updates kit-transport/procedures.md Auto commit by GitBook Editor --- kit-transport/procedures.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/kit-transport/procedures.md b/kit-transport/procedures.md index 1f129306..e973359f 100644 --- a/kit-transport/procedures.md +++ b/kit-transport/procedures.md @@ -1,6 +1,6 @@ -## Procedures +# Procedures -### Shipping kits to Kickstarts +## Shipping kits to Kickstarts To provide sufficient time for problems/delays, kits should be shipped to Kickstart locations no later than 1 week before Kickstart. Shipping the kits many weeks in advance may not be possible due to limited storage requirements at some Kickstart locations. @@ -25,7 +25,7 @@ For each Kickstart: After Kickstart, request scanned copies of the handout form and disclaimers from all of the Kickstarts from the Kickstart Event Coordinator \(who will then request them from the Local Kickstart Coordinators\). Move each kit into an appropriate sub directory in the Inventory based upon which team it was given to \(e.g. move a kit to `teams/2017/srz`\). -### Shipping kits to teams that didn't attend a Kickstart +## Shipping kits to teams that didn't attend a Kickstart The operations manual currently requires that the Kit Logistics Coordinator ensures that kits are available to be collected by a courier no later than 2 week after Kickstart. @@ -51,7 +51,7 @@ For each team that needs a kit: 3. Once UK Postbox have forwarded on the kit, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. 4. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). -### Managing kits not collected at Kickstart +## Managing kits not collected at Kickstart Some teams may not turn up at Kickstart, therefore leaving their kit uncollected. This kit needs to either be stored safely by someone nearby or returned to UK Postbox. The kit will most likely make its way to a team \(either the originally intended recipient or otherwise\) in the week or two after Kickstart. @@ -59,11 +59,11 @@ If a responsible person in attendance at the Kickstart event \(for example the L If it is not possible to store the kit locally, it must be returned to UK Postbox ASAP. A [Return Shipping Pack](#return-shipping-pack) must be used to package the kit for return. Someone \(possibly the venue\) will need to make the kit available for courier collection in the day or two following Kickstart. -### Reallocating kits from drop-outs +## Reallocating kits from drop-outs We need to ship kits from one team to another when a team drops out. TBD. -### Shipping spares/replacements +## Shipping spares/replacements When parts of the kit break teams need replacements. The Kit Logistics Coordinator needs to ship these spares/replacements to teams when instructed to do so by the Kit Support Coordinator. @@ -88,22 +88,23 @@ Begin by requesting the following information from the Team Coordinator for the * Package the parts into a cardboard box, using Jiffy bags, bubblewrap or similar to protect the parts. * Once the details have been confirmed, arrange for the package to be collected from yourself and delivered to the team. + * Once you have the tracking number from the courier, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. * Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). -### Shipping kits to storage at the end of the competition +## Shipping kits to storage at the end of the competition At the end of the competition we have the majority of the kits returned to us. The Competition Team Coordinator is responsible for managing the return process. The Kit Logistics Coordinator can aid in this process and is responsible for shipping the kits to storage after they have been returned. TBD. -### Ensuring the timely return of kits not returned at the competition +## Ensuring the timely return of kits not returned at the competition Some teams will have been given permission to retain their kit for a while after the competition. The teams are responsible for arranging and paying for a courier to return the kit to us. The Kit Logistics Coordinator is responsible for assisting teams in this process and ensuring that all kits are returned by the 1st June of the same year that the competition was held in. TBD. -### Shipping of non-team kits and development tools to volunteers +## Shipping of non-team kits and development tools to volunteers Non-team kits \(those that are classed as development, support, PR or local\) and development tools need to be shipped around as deemed appropriate by the person responsible for their allocation. That being the Kit Coordinator for development kits and tools, the Kit Support Coordinator for support kits, the PR coordinator for PR kits and the Team Coordinator for local kits. TBD. -### Shipping of non-kit assets +## Shipping of non-kit assets Most assets are kit related. However, a few assets are not kits or parts thereof. This is mostly competition hardware such as arena walls. The Kit Logistics Coordinator is also responsible for shipping these non-kit assets when required. TBD. From 238b9045f0b688fc2f14d38369296db8625031c6 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 11 Feb 2017 18:23:54 +0000 Subject: [PATCH 012/106] Updates kit-transport/packaging.md Auto commit by GitBook Editor --- kit-transport/packaging.md | 4 ++++ kit-transport/procedures.md | 3 +++ 2 files changed, 7 insertions(+) diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md index f8bfb36a..a1c9bbe3 100644 --- a/kit-transport/packaging.md +++ b/kit-transport/packaging.md @@ -1,5 +1,9 @@ # Packaging +This information on packaging of kits and kit parts is for internal use only. The Kit Logistics Coordinator will use this information to instruct volunteers and third parties as necessary. + +## Packaging Info + * Kits should generally be shipped in the while 18l Really Useful Box \(RUB\). * All parts of the kit should be suitably protected either in Jiffy bags or bubble wrap. * Batteries **must** be placed inside the charging bag. diff --git a/kit-transport/procedures.md b/kit-transport/procedures.md index e973359f..8646feb0 100644 --- a/kit-transport/procedures.md +++ b/kit-transport/procedures.md @@ -1,5 +1,7 @@ # Procedures +These are the procedures that the Kit Logistics Coordinator follows to perform their Kit Shipping responsibilities. No one else is expected to follow these procedures, they are for internal documentation only. + ## Shipping kits to Kickstarts To provide sufficient time for problems/delays, kits should be shipped to Kickstart locations no later than 1 week before Kickstart. Shipping the kits many weeks in advance may not be possible due to limited storage requirements at some Kickstart locations. @@ -90,6 +92,7 @@ Begin by requesting the following information from the Team Coordinator for the * Once the details have been confirmed, arrange for the package to be collected from yourself and delivered to the team. * Once you have the tracking number from the courier, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. + * Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). ## Shipping kits to storage at the end of the competition From d8a1df3257d5f5a7b140b59a877ba2ecb44bca28 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 11 Feb 2017 19:17:02 +0000 Subject: [PATCH 013/106] Updates logistics-software.md Auto commit by GitBook Editor --- logistics-software.md | 13 +++++++++++++ post-handling.md | 16 ++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/logistics-software.md b/logistics-software.md index e69de29b..ab3e9861 100644 --- a/logistics-software.md +++ b/logistics-software.md @@ -0,0 +1,13 @@ +# Logistics Software + +To fulfil the multitude of responsibilities, the Kit Logistics Coordinator uses various pieces of custom software. The software projects used and maintained by the Kit Logistics Coordinator are listed below. + +## Software Projects + +| Name | Project URL | Notes | +| --- | --- | --- | +| Inventory Tools | [https://www.studentrobotics.org/cgit/tools.git/](https://www.studentrobotics.org/cgit/tools.git/) | This project currently contains a mishmash of tools. The Inventory tools need teasing out. | +| Inventory | [https://www.studentrobotics.org/cgit/inventory.git/](https://www.studentrobotics.org/cgit/inventory.git/) | This is not a software project in itself. It represents the current state of all SR assets. | + + + diff --git a/post-handling.md b/post-handling.md index e69de29b..af4d597b 100644 --- a/post-handling.md +++ b/post-handling.md @@ -0,0 +1,16 @@ +# Post Handling + +These are the procedures related to the Kit Logistics Coordinator's post handing responsibilities. + +## Handling received mail + +Notify the person as defined in the following table. + +| Addressee | Email | +| --- | --- | +| Treasurer | treasurer@studentrobotics.org | + +## Topping up UK Postbox + +UK Postbox requires topping up with credit. Budget for this comes from either the `srXXXX/post` or the `srXXXX/kits/shipping` budget lines depending on what it will generally be used for. Obviously it's not possible to know exactly how the credit will ultimately be spent so it's not critical. Since it is not possible to extract money back out of UK Postbox, top ups should be sufficient for the foreseeable future only. + From b0b2328c1f40cf73215ba1678f4ba6b8d633489d Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Wed, 15 Feb 2017 22:19:42 +0000 Subject: [PATCH 014/106] Updates SUMMARY.md Auto commit by GitBook Editor --- README.md | 5 +---- SUMMARY.md | 2 +- chapter1/foo.md | 0 chapter1.md => kit-storage.md | 0 4 files changed, 2 insertions(+), 5 deletions(-) delete mode 100644 chapter1/foo.md rename chapter1.md => kit-storage.md (100%) diff --git a/README.md b/README.md index 60433e27..86f77d69 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,4 @@ The responsibilities of the Kit Logistics Coordinator are as follows: To fulfil these responsibilities the Kit Logistics Coordinator also does the following -* Maintain a suite of logistics software - - - +* Maintain a suite of logistics software \ No newline at end of file diff --git a/SUMMARY.md b/SUMMARY.md index 090eee6e..4167dcc6 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,7 +1,7 @@ # Summary * [Introduction](README.md) -* [Kit Storage](chapter1.md) +* [Kit Storage](kit-storage.md) * [Kit Shipping](kit-transport.md) * [Procedures](kit-transport/procedures.md) * [Packaging](kit-transport/packaging.md) diff --git a/chapter1/foo.md b/chapter1/foo.md deleted file mode 100644 index e69de29b..00000000 diff --git a/chapter1.md b/kit-storage.md similarity index 100% rename from chapter1.md rename to kit-storage.md From 23287ded0decf274f90c1e1d3c0dc8c6c0c41243 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Wed, 15 Feb 2017 22:29:05 +0000 Subject: [PATCH 015/106] Updates asset-tracking.md Auto commit by GitBook Editor --- SUMMARY.md | 2 +- asset-tracking.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 asset-tracking.md diff --git a/SUMMARY.md b/SUMMARY.md index 4167dcc6..360d1cc8 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -7,6 +7,6 @@ * [Packaging](kit-transport/packaging.md) * [Couriers](kit-transport/couriers.md) * [Post Handling](post-handling.md) -* Asset Tracking \(aka Inventory\) +* [Asset Tracking](asset-tracking.md) * [Logistics Software](logistics-software.md) diff --git a/asset-tracking.md b/asset-tracking.md new file mode 100644 index 00000000..6df1644c --- /dev/null +++ b/asset-tracking.md @@ -0,0 +1,4 @@ +# Asset Tracking + +One of the responsibilities of the Kit Logistics Coordinator is to maintain a record of the location and state of all Student Robotics assets. This is generally referred to as Asset Tracking. + From c2590f0351af7855b34e69a91a2f40b5fa79a598 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 12:11:11 +0000 Subject: [PATCH 016/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/asset-tracking.md b/asset-tracking.md index 6df1644c..be4d92f2 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -2,3 +2,9 @@ One of the responsibilities of the Kit Logistics Coordinator is to maintain a record of the location and state of all Student Robotics assets. This is generally referred to as Asset Tracking. +## The Inventory + +All[^1] Student Robotics a + +[^1]: Foo + From a9ddbece6f7235bb8989d6793a762fc139cb5c51 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 12:24:14 +0000 Subject: [PATCH 017/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index be4d92f2..0c2d0558 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -1,10 +1,12 @@ # Asset Tracking -One of the responsibilities of the Kit Logistics Coordinator is to maintain a record of the location and state of all Student Robotics assets. This is generally referred to as Asset Tracking. +One of the responsibilities of the Kit Logistics Coordinator is to maintain a record of the location and state of all Student Robotics assets. This is generally referred to as Asset Tracking. It is important that the organisation is aware of the location and state of all of its assets at all times. ## The Inventory -All[^1] Student Robotics a +To record all of the necessary information regarding Student Robotics assets, all[^1] assets are tracked in the Inventory. It is important to note that only property of Student Robotics is tracked in the Inventory; meaning that property of third parties must not be tracked in the Inventory. -[^1]: Foo +The Inventory primarily records the location of each asset, its physical and functional state, its asset code and a history of any changes made to any of these properties. Of particular importance here is the asset code, which uniquely identifies the asset in the Inventory. Without the asset code it would be impossible to tie up a record in the Inventory with the physical asset that it is tracking. It is therefore very important that all assets have their asset code clearly marked on them. + +[^1]: This is not quite true as certain low-value assets are not tracked individually. From 7d601a8a737faf7842091d55c782c767fd9b7446 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 12:44:50 +0000 Subject: [PATCH 018/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index 0c2d0558..b3c4311c 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -6,7 +6,21 @@ One of the responsibilities of the Kit Logistics Coordinator is to maintain a re To record all of the necessary information regarding Student Robotics assets, all[^1] assets are tracked in the Inventory. It is important to note that only property of Student Robotics is tracked in the Inventory; meaning that property of third parties must not be tracked in the Inventory. -The Inventory primarily records the location of each asset, its physical and functional state, its asset code and a history of any changes made to any of these properties. Of particular importance here is the asset code, which uniquely identifies the asset in the Inventory. Without the asset code it would be impossible to tie up a record in the Inventory with the physical asset that it is tracking. It is therefore very important that all assets have their asset code clearly marked on them. +Each asset, for example an individual webcam, has a corresponding record in the Inventory. Within this record various properties of the asset are held such that it is possible to unambiguously identify the matching asset from its Inventory record and conversely, identify the matching Inventory record from the asset. There is a one-to-one mapping of assets to Inventory records. + +The Inventory primarily records the location of each asset, its value, its physical and functional state, its asset code and a history of any changes made to any of these properties. Secondary to these properties, certain assets have extra information recorded such as MAC address (for assets that have an Ethernet or Bluetooth PHY), serial number and modification flags. + +To provide the one-to-one mapping between assets and their Inventory records, each asset/record pair have an `asset code`, which uniquely identifies them. An important part of maintaining this one-to-one mapping is ensuring that the *asset code* is suitably marked onto the asset + +### Asset Lifecycle + +#### Creation +#### Commissioning +#### Operation +#### Testing +#### Repair +#### Updating/Modifying +#### Decommissioning/Disposal [^1]: This is not quite true as certain low-value assets are not tracked individually. From 834d8d1e69d94a5be165ea5b7935b793fdd30b9f Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 12:44:57 +0000 Subject: [PATCH 019/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index b3c4311c..bb334071 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -10,7 +10,7 @@ Each asset, for example an individual webcam, has a corresponding record in the The Inventory primarily records the location of each asset, its value, its physical and functional state, its asset code and a history of any changes made to any of these properties. Secondary to these properties, certain assets have extra information recorded such as MAC address (for assets that have an Ethernet or Bluetooth PHY), serial number and modification flags. -To provide the one-to-one mapping between assets and their Inventory records, each asset/record pair have an `asset code`, which uniquely identifies them. An important part of maintaining this one-to-one mapping is ensuring that the *asset code* is suitably marked onto the asset +To provide the one-to-one mapping between assets and their Inventory records, each asset/record pair have an *asset code*, which uniquely identifies them. An important part of maintaining this one-to-one mapping is ensuring that the *asset code* is suitably marked onto the asset ### Asset Lifecycle From 0ed9a2b8f91e32ed6781fc463a4dc2a3da6eabe6 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 12:45:50 +0000 Subject: [PATCH 020/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index bb334071..80bc051a 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -10,7 +10,7 @@ Each asset, for example an individual webcam, has a corresponding record in the The Inventory primarily records the location of each asset, its value, its physical and functional state, its asset code and a history of any changes made to any of these properties. Secondary to these properties, certain assets have extra information recorded such as MAC address (for assets that have an Ethernet or Bluetooth PHY), serial number and modification flags. -To provide the one-to-one mapping between assets and their Inventory records, each asset/record pair have an *asset code*, which uniquely identifies them. An important part of maintaining this one-to-one mapping is ensuring that the *asset code* is suitably marked onto the asset +To provide the one-to-one mapping between assets and their Inventory records, each asset/record pair have an *asset code*, which uniquely identifies them. An important part of maintaining this one-to-one mapping is ensuring that the asset code is suitably marked onto the asset such that it can be read in the future. ### Asset Lifecycle From 87c360ae68004c9ccce6f0fe9027d40afe7945c1 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 12:58:13 +0000 Subject: [PATCH 021/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index 80bc051a..74c911d8 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -1,6 +1,8 @@ # Asset Tracking -One of the responsibilities of the Kit Logistics Coordinator is to maintain a record of the location and state of all Student Robotics assets. This is generally referred to as Asset Tracking. It is important that the organisation is aware of the location and state of all of its assets at all times. +One of the responsibilities of the Kit Logistics Coordinator is to maintain a record of the location and state of all Student Robotics' assets. This is generally referred to as Asset Tracking. It is important that the organisation is aware of the location and state of all of its assets at all times. + +This chapter documents the high-level organisation aspects around Student Robotics asset tracking. It is not intended as a comprehensive user manual for the Inventory system, but rather how we use the system to track our assets. **TODO: link to user manual/docs** ## The Inventory From c6c321e24511ef1a933330639c2fd222ef56043a Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:12:58 +0000 Subject: [PATCH 022/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 15 ++++++++++++--- book.json | 3 +++ 2 files changed, 15 insertions(+), 3 deletions(-) create mode 100644 book.json diff --git a/asset-tracking.md b/asset-tracking.md index 74c911d8..46f8a6f8 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -1,12 +1,12 @@ # Asset Tracking -One of the responsibilities of the Kit Logistics Coordinator is to maintain a record of the location and state of all Student Robotics' assets. This is generally referred to as Asset Tracking. It is important that the organisation is aware of the location and state of all of its assets at all times. +One of the responsibilities of the Kit Logistics Coordinator is to maintain a record of the location and state of all SRs assets. This is generally referred to as Asset Tracking. It is important that the organisation is aware of the location and state of all of its assets at all times. -This chapter documents the high-level organisation aspects around Student Robotics asset tracking. It is not intended as a comprehensive user manual for the Inventory system, but rather how we use the system to track our assets. **TODO: link to user manual/docs** +This chapter documents the high-level organisation aspects around SR asset tracking. It is not intended as a comprehensive user manual for the Inventory system, but rather how SR uses the system to track its assets. **TODO: link to user manual/docs** ## The Inventory -To record all of the necessary information regarding Student Robotics assets, all[^1] assets are tracked in the Inventory. It is important to note that only property of Student Robotics is tracked in the Inventory; meaning that property of third parties must not be tracked in the Inventory. +To record all of the necessary information regarding SR assets, all[^1] assets are tracked in the Inventory. It is important to note that only property of SR is tracked in the Inventory; meaning that property of third parties must not be tracked in the Inventory. Each asset, for example an individual webcam, has a corresponding record in the Inventory. Within this record various properties of the asset are held such that it is possible to unambiguously identify the matching asset from its Inventory record and conversely, identify the matching Inventory record from the asset. There is a one-to-one mapping of assets to Inventory records. @@ -16,6 +16,15 @@ To provide the one-to-one mapping between assets and their Inventory records, ea ### Asset Lifecycle +For each asset that SR owns there is a reasonably well defined sequence of stages that it flows through during its lifetime. These + +```flow +create=>start: Creation +commission=>operation: Commissioning + +create->commission +``` + #### Creation #### Commissioning #### Operation diff --git a/book.json b/book.json new file mode 100644 index 00000000..068e30d7 --- /dev/null +++ b/book.json @@ -0,0 +1,3 @@ +{ + "plugins": ["flow"] +} \ No newline at end of file From c7c81974a288f6f2580ae489f5a7bf7eca008087 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:18:28 +0000 Subject: [PATCH 023/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index 46f8a6f8..314c32ff 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -20,18 +20,26 @@ For each asset that SR owns there is a reasonably well defined sequence of stage ```flow create=>start: Creation -commission=>operation: Commissioning +commission=>operation: Commissioning|past +usage=>operation: Usage|current +testing=>operation: Testing|invalid + +disposal=>end: Disposal create->commission +commission->usage +usage->testing +decommission->disposal ``` #### Creation #### Commissioning -#### Operation +#### Usage #### Testing #### Repair -#### Updating/Modifying -#### Decommissioning/Disposal +#### Updating +#### Decommissioning +#### Disposal [^1]: This is not quite true as certain low-value assets are not tracked individually. From e8c381e336e17f5d8660953db11e7d754095fc28 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:22:02 +0000 Subject: [PATCH 024/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 1 + 1 file changed, 1 insertion(+) diff --git a/asset-tracking.md b/asset-tracking.md index 314c32ff..c3207428 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -29,6 +29,7 @@ disposal=>end: Disposal create->commission commission->usage usage->testing +testing->decommission decommission->disposal ``` From 7ba61914b9e032fa01ab915a2c08f4eabc51bbe9 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:23:28 +0000 Subject: [PATCH 025/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index c3207428..c952a5f1 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -23,7 +23,7 @@ create=>start: Creation commission=>operation: Commissioning|past usage=>operation: Usage|current testing=>operation: Testing|invalid - +decommission=>operation: Decommission disposal=>end: Disposal create->commission From affbd9a7e716dfc47619d4718086205b63b0889b Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:32:38 +0000 Subject: [PATCH 026/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 19 +++++-------------- book.json | 2 +- 2 files changed, 6 insertions(+), 15 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index c952a5f1..ff03912f 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -18,20 +18,11 @@ To provide the one-to-one mapping between assets and their Inventory records, ea For each asset that SR owns there is a reasonably well defined sequence of stages that it flows through during its lifetime. These -```flow -create=>start: Creation -commission=>operation: Commissioning|past -usage=>operation: Usage|current -testing=>operation: Testing|invalid -decommission=>operation: Decommission -disposal=>end: Disposal - -create->commission -commission->usage -usage->testing -testing->decommission -decommission->disposal -``` +{% mermaid %} +graph LR; + A-->B; + B-->C; +{% endmermaid %} #### Creation #### Commissioning diff --git a/book.json b/book.json index 068e30d7..421168a7 100644 --- a/book.json +++ b/book.json @@ -1,3 +1,3 @@ { - "plugins": ["flow"] + "plugins": ["mermaid"] } \ No newline at end of file From 5a29c4f8bd96535ecafb1abbc9e3d0b73d08ffed Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:39:58 +0000 Subject: [PATCH 027/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index ff03912f..97a9fd41 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -19,18 +19,27 @@ To provide the one-to-one mapping between assets and their Inventory records, ea For each asset that SR owns there is a reasonably well defined sequence of stages that it flows through during its lifetime. These {% mermaid %} -graph LR; - A-->B; - B-->C; +graph LR + create(Creation) + commission(Commission) + use(Use) + test(Test) + repair(Repair) + modify(Modify) + decommission(Decommission) + disposal(Disposal) + + create-->commission + commission-->use {% endmermaid %} #### Creation -#### Commissioning -#### Usage -#### Testing +#### Commission +#### Use +#### Test #### Repair -#### Updating -#### Decommissioning +#### Modify +#### Decommission #### Disposal [^1]: This is not quite true as certain low-value assets are not tracked individually. From fa1568601af1fc4a068d9b00be168e200780836c Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:41:48 +0000 Subject: [PATCH 028/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/asset-tracking.md b/asset-tracking.md index 97a9fd41..5745c9bb 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -31,6 +31,9 @@ graph LR create-->commission commission-->use + use-->test + test-->repair + test-->use {% endmermaid %} #### Creation From b67b4b6dd411056d052a29478a77d29454e74afb Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:42:59 +0000 Subject: [PATCH 029/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 1 + 1 file changed, 1 insertion(+) diff --git a/asset-tracking.md b/asset-tracking.md index 5745c9bb..29faaf11 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -34,6 +34,7 @@ graph LR use-->test test-->repair test-->use + repair-->use {% endmermaid %} #### Creation From d007a1bacf577dd85be4422556fb2c4e5983cbc7 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:44:01 +0000 Subject: [PATCH 030/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/asset-tracking.md b/asset-tracking.md index 29faaf11..8bc4e0c2 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -35,6 +35,8 @@ graph LR test-->repair test-->use repair-->use + test-->decommission + decommission-->disposal {% endmermaid %} #### Creation From 39b68cf637c574f4f21f3954cd50f156ff5ed8b7 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:45:06 +0000 Subject: [PATCH 031/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index 8bc4e0c2..844d9b71 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -33,7 +33,7 @@ graph LR commission-->use use-->test test-->repair - test-->use + test-->repair repair-->use test-->decommission decommission-->disposal From 78df68050bf19a46235c4fbf65700e7f3397f84c Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:45:20 +0000 Subject: [PATCH 032/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index 844d9b71..1e3eee74 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -33,8 +33,8 @@ graph LR commission-->use use-->test test-->repair - test-->repair - repair-->use + test-->use + repair-->test test-->decommission decommission-->disposal {% endmermaid %} From 14ab30907ffddc499257a52eeee23534a2e65c9c Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:46:11 +0000 Subject: [PATCH 033/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index 1e3eee74..5ae9c929 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -31,7 +31,8 @@ graph LR create-->commission commission-->use - use-->test + use->modify + modify-->test test-->repair test-->use repair-->test From 12d053e8dee3c1f40d8145aba746c43b08fb436c Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:48:10 +0000 Subject: [PATCH 034/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index 5ae9c929..7b951a8b 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -31,7 +31,7 @@ graph LR create-->commission commission-->use - use->modify + use-->modify modify-->test test-->repair test-->use From dc6decd5d42cc844f899d403c80934932bcac574 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 13:58:41 +0000 Subject: [PATCH 035/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 1 + 1 file changed, 1 insertion(+) diff --git a/asset-tracking.md b/asset-tracking.md index 7b951a8b..368f6540 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -32,6 +32,7 @@ graph LR create-->commission commission-->use use-->modify + use-->test modify-->test test-->repair test-->use From b6ea9aaa1a445f66d9b4d4221306949141df6f0a Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 15:22:54 +0000 Subject: [PATCH 036/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index 368f6540..ecd9c91d 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -16,7 +16,7 @@ To provide the one-to-one mapping between assets and their Inventory records, ea ### Asset Lifecycle -For each asset that SR owns there is a reasonably well defined sequence of stages that it flows through during its lifetime. These +For each asset that SR owns there is a reasonably well defined sequence of stages that it flows through during its lifetime. This flow is shown in the diagram below. {% mermaid %} graph LR @@ -42,6 +42,17 @@ graph LR {% endmermaid %} #### Creation + +When an asset is purchased or manufactured, a record must be entered into the Inventory. At this point a new asset code is automatically generated. The asset code **must** be marked onto the asset[^2]. The asset code can be marked in the following ways: + + * Printed paper label with QR code and text + * Dymo label with code128 barcode and text + * Handwritten with permanent marker + * UHF RFID tag[^3] + * Programmed onto the asset (e.g. such that it is possible to read over USB) + +The ideal marking solution is both human and machine readable should be durable. These criteria should be considered when deciding how to mark a particular asset. Programming the asset code onto the asset, where possible, provides a very high level of durability as there is no label or pen that can be damaged, however one has to physically plug a cable in. QR codes and barcodes have the advantage that physical contact with the asset is not required, but they do require the asset to be visible. UHF RFID tags provide the added benefit of allowing the asset code to be read even when they are not visible; for instance when it is in a box. + #### Commission #### Use #### Test @@ -51,4 +62,5 @@ graph LR #### Disposal [^1]: This is not quite true as certain low-value assets are not tracked individually. - +[^2]: There was historically a concept of 'deferred labelling', where a record was added to the Inventory and the asset labelled at a later time. This approach is no longer used as it can result in assets going unlabelled. +[^3]: Currently in the planning stage. \ No newline at end of file From 62b218a1947c536f925e75e89ccfcab3e0b55e32 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 15:23:42 +0000 Subject: [PATCH 037/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index ecd9c91d..b3964e39 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -51,7 +51,7 @@ When an asset is purchased or manufactured, a record must be entered into the In * UHF RFID tag[^3] * Programmed onto the asset (e.g. such that it is possible to read over USB) -The ideal marking solution is both human and machine readable should be durable. These criteria should be considered when deciding how to mark a particular asset. Programming the asset code onto the asset, where possible, provides a very high level of durability as there is no label or pen that can be damaged, however one has to physically plug a cable in. QR codes and barcodes have the advantage that physical contact with the asset is not required, but they do require the asset to be visible. UHF RFID tags provide the added benefit of allowing the asset code to be read even when they are not visible; for instance when it is in a box. +The ideal marking solution is both human and machine readable and should be durable. These criteria should be considered when deciding how to mark a particular asset. Programming the asset code onto the asset, where possible, provides a very high level of durability as there is no label or pen that can be damaged, however one has to physically plug a cable in. QR codes and barcodes have the advantage that physical contact with the asset is not required, but they do require the asset to be visible. UHF RFID tags provide the added benefit of allowing the asset code to be read even when they are not visible; for instance when it is in a box. #### Commission #### Use From d1566e32e26ac738fb94e2a40ebb0a121432ea27 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 15:26:03 +0000 Subject: [PATCH 038/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/asset-tracking.md b/asset-tracking.md index b3964e39..a6f4ed26 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -51,6 +51,8 @@ When an asset is purchased or manufactured, a record must be entered into the In * UHF RFID tag[^3] * Programmed onto the asset (e.g. such that it is possible to read over USB) +More than one of the above techniques can be used to provide redundancy. + The ideal marking solution is both human and machine readable and should be durable. These criteria should be considered when deciding how to mark a particular asset. Programming the asset code onto the asset, where possible, provides a very high level of durability as there is no label or pen that can be damaged, however one has to physically plug a cable in. QR codes and barcodes have the advantage that physical contact with the asset is not required, but they do require the asset to be visible. UHF RFID tags provide the added benefit of allowing the asset code to be read even when they are not visible; for instance when it is in a box. #### Commission From b48e258eb0916a611f19ffbe559961fa71f4fc60 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 15:27:40 +0000 Subject: [PATCH 039/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index a6f4ed26..5f9ddf56 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -53,7 +53,7 @@ When an asset is purchased or manufactured, a record must be entered into the In More than one of the above techniques can be used to provide redundancy. -The ideal marking solution is both human and machine readable and should be durable. These criteria should be considered when deciding how to mark a particular asset. Programming the asset code onto the asset, where possible, provides a very high level of durability as there is no label or pen that can be damaged, however one has to physically plug a cable in. QR codes and barcodes have the advantage that physical contact with the asset is not required, but they do require the asset to be visible. UHF RFID tags provide the added benefit of allowing the asset code to be read even when they are not visible; for instance when it is in a box. +The ideal marking solution is both human and machine readable and should be durable. These criteria should be considered when deciding how to mark a particular asset. Programming the asset code onto the asset, where possible, provides a very high level of durability as there is no label or pen that can be damaged, however one has to physically plug a cable in to read the code. QR codes and barcodes have the advantage that physical contact with the asset is not required, but they do require the asset to be visible. UHF RFID tags provide the added benefit of allowing the asset code to be read even when they are not visible; for instance when it is in a box. #### Commission #### Use From 0d657ae5ca5dff22737af578f8ea140a06d5a30a Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 15:27:56 +0000 Subject: [PATCH 040/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index 5f9ddf56..dacba275 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -53,7 +53,7 @@ When an asset is purchased or manufactured, a record must be entered into the In More than one of the above techniques can be used to provide redundancy. -The ideal marking solution is both human and machine readable and should be durable. These criteria should be considered when deciding how to mark a particular asset. Programming the asset code onto the asset, where possible, provides a very high level of durability as there is no label or pen that can be damaged, however one has to physically plug a cable in to read the code. QR codes and barcodes have the advantage that physical contact with the asset is not required, but they do require the asset to be visible. UHF RFID tags provide the added benefit of allowing the asset code to be read even when they are not visible; for instance when it is in a box. +The ideal marking solution is both human and machine readable and should be durable. These criteria should be considered when deciding how to mark a particular asset. Programming the asset code onto the asset, where possible, provides a very high level of durability as there is no label or pen that can be damaged; However one has to physically plug a cable in to read the code. QR codes and barcodes have the advantage that physical contact with the asset is not required, but they do require the asset to be visible. UHF RFID tags provide the added benefit of allowing the asset code to be read even when they are not visible; for instance when it is in a box. #### Commission #### Use From b706b5dd76ef37fa9d5626a532caf008a3184ac8 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 15:37:18 +0000 Subject: [PATCH 041/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/asset-tracking.md b/asset-tracking.md index dacba275..55c0c9d9 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -56,6 +56,13 @@ More than one of the above techniques can be used to provide redundancy. The ideal marking solution is both human and machine readable and should be durable. These criteria should be considered when deciding how to mark a particular asset. Programming the asset code onto the asset, where possible, provides a very high level of durability as there is no label or pen that can be damaged; However one has to physically plug a cable in to read the code. QR codes and barcodes have the advantage that physical contact with the asset is not required, but they do require the asset to be visible. UHF RFID tags provide the added benefit of allowing the asset code to be read even when they are not visible; for instance when it is in a box. #### Commission + +Some assets will require commissioning after they have been added to the Inventory. This can be best explained with an example: When a newly manufactured motor board is added to the Inventory it is yet to be programmed or fully tested (although it may have had some basic end-of-line testing performed upon it). Once it has been added to the Inventory, in the *Creation* stage, it is ready to be programmed and tested before being used. This initial programming and testing of the motor board is part of its *commissioning* process. + +Not all assets will require commissioning. Generally these are things such as USB hubs, where it is assumed that the manufacturer has suitably tested their product and there is no further programming required. + +Once an asset has been commissioned, its physical and functional states must be updated in its record appropriately. In the case of assets that do not require any special commissioning procedure to be carried out, it should be assumed that they are both physically and functionally working and their records updated as such. + #### Use #### Test #### Repair From 623d218b6ab258c0d16640615a518254c8a75dc9 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 15:49:35 +0000 Subject: [PATCH 042/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/asset-tracking.md b/asset-tracking.md index 55c0c9d9..6e252e86 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -64,6 +64,11 @@ Not all assets will require commissioning. Generally these are things such as US Once an asset has been commissioned, its physical and functional states must be updated in its record appropriately. In the case of assets that do not require any special commissioning procedure to be carried out, it should be assumed that they are both physically and functionally working and their records updated as such. #### Use + +Once an asset has been commissioned, or has been tested and shown to be working, it is ready to be used for its intended purpose. For the majority of assets this means that it will become part of a kit and ultimately be used by a team. + +During the *use* stage of an assets lifetime the majority of the updates to its record in the Inventory will be to keep track of its physical location; for example with a particular team. + #### Test #### Repair #### Modify From ebbc10579e6b521f0e0f23577d684ab0a6deb760 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 15:51:50 +0000 Subject: [PATCH 043/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index 6e252e86..3e75942c 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -67,7 +67,7 @@ Once an asset has been commissioned, its physical and functional states must be Once an asset has been commissioned, or has been tested and shown to be working, it is ready to be used for its intended purpose. For the majority of assets this means that it will become part of a kit and ultimately be used by a team. -During the *use* stage of an assets lifetime the majority of the updates to its record in the Inventory will be to keep track of its physical location; for example with a particular team. +During the *use* stage of an assets lifetime the majority of the updates to its record in the Inventory will be to keep track of its physical location; for example with a particular team. Occasionally there may also be other updates to its record required, such as adding a note to its description. #### Test #### Repair From 72f609999e92ba076487544b809395df84e103c1 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 16:12:34 +0000 Subject: [PATCH 044/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index 3e75942c..749a150d 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -10,7 +10,7 @@ To record all of the necessary information regarding SR assets, all[^1] assets a Each asset, for example an individual webcam, has a corresponding record in the Inventory. Within this record various properties of the asset are held such that it is possible to unambiguously identify the matching asset from its Inventory record and conversely, identify the matching Inventory record from the asset. There is a one-to-one mapping of assets to Inventory records. -The Inventory primarily records the location of each asset, its value, its physical and functional state, its asset code and a history of any changes made to any of these properties. Secondary to these properties, certain assets have extra information recorded such as MAC address (for assets that have an Ethernet or Bluetooth PHY), serial number and modification flags. +The Inventory primarily records the location of each asset, its value, its physical and functional condition, its asset code and a history of any changes made to any of these properties. Secondary to these properties, certain assets have extra information recorded such as MAC address (for assets that have an Ethernet or Bluetooth PHY), serial number and modification flags. To provide the one-to-one mapping between assets and their Inventory records, each asset/record pair have an *asset code*, which uniquely identifies them. An important part of maintaining this one-to-one mapping is ensuring that the asset code is suitably marked onto the asset such that it can be read in the future. @@ -61,7 +61,7 @@ Some assets will require commissioning after they have been added to the Invento Not all assets will require commissioning. Generally these are things such as USB hubs, where it is assumed that the manufacturer has suitably tested their product and there is no further programming required. -Once an asset has been commissioned, its physical and functional states must be updated in its record appropriately. In the case of assets that do not require any special commissioning procedure to be carried out, it should be assumed that they are both physically and functionally working and their records updated as such. +Once an asset has been commissioned, its physical and functional condition must be updated appropriately in its record. In the case of assets that do not require any special commissioning procedure to be carried out, it should be assumed that they are both physically and functionally working and their records updated as such. #### Use @@ -70,6 +70,11 @@ Once an asset has been commissioned, or has been tested and shown to be working, During the *use* stage of an assets lifetime the majority of the updates to its record in the Inventory will be to keep track of its physical location; for example with a particular team. Occasionally there may also be other updates to its record required, such as adding a note to its description. #### Test + +The Inventory should, as far as is possible, represent the current state of all assets. However as time passes, the recorded physical and functional condition of a given asset will diverge from reality. To help rectify this, assets are regularly tested. For most assets this occurs once each year at the Kit Collation Event, run by the Hardware Production Coordinator. **TODO: Link to HPC docs.** Assets that have been repaired or modified must also undergo testing. + +As in the *commission* stage, an asset's physical and functional condition must be updated appropriately in its record once it has been tested. If the asset is in full working order it is ready for use. If the asset is broken then it may be possible to repair it. In some situations it is either not cost effective or not possible to repair an asset. When this occurs, the asset is no longer useful to SR and will be *decommissioned* and *disposed* of. + #### Repair #### Modify #### Decommission From 318e43af2c36b320a2e20524027915d16b481a1d Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 16:45:21 +0000 Subject: [PATCH 045/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index 749a150d..a90d6e98 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -1,12 +1,14 @@ # Asset Tracking -One of the responsibilities of the Kit Logistics Coordinator is to maintain a record of the location and state of all SRs assets. This is generally referred to as Asset Tracking. It is important that the organisation is aware of the location and state of all of its assets at all times. +One of the responsibilities of the Kit Logistics Coordinator is to maintain a record of the location and state of all SRs assets. This is generally referred to as asset tracking. To allow SR to operate it is important that the location and state of all of its assets are known at all times. This chapter documents the high-level organisation aspects around SR asset tracking. It is not intended as a comprehensive user manual for the Inventory system, but rather how SR uses the system to track its assets. **TODO: link to user manual/docs** ## The Inventory -To record all of the necessary information regarding SR assets, all[^1] assets are tracked in the Inventory. It is important to note that only property of SR is tracked in the Inventory; meaning that property of third parties must not be tracked in the Inventory. +To record all of the necessary information regarding SR assets, all[^1] assets are tracked in the Inventory. Unfortunately, due to historical of the term, SR uses the term *Inventory* to refer to its asset tracking system. However, in the rest of the world inventory generally refers to a record of things that a company sells and assets are things a company owns and uses to operate. It's not a big problem, but it is something to be aware of when dealing with third parties. + +Only property of SR is tracked in the Inventory; meaning that property of third parties must not be tracked in the Inventory. Each asset, for example an individual webcam, has a corresponding record in the Inventory. Within this record various properties of the asset are held such that it is possible to unambiguously identify the matching asset from its Inventory record and conversely, identify the matching Inventory record from the asset. There is a one-to-one mapping of assets to Inventory records. @@ -80,6 +82,6 @@ As in the *commission* stage, an asset's physical and functional condition must #### Decommission #### Disposal -[^1]: This is not quite true as certain low-value assets are not tracked individually. +[^1]: This is not quite true as certain low-value assets are not tracked. A general rule-of-thumb is that anything under £5 is not tracked. [^2]: There was historically a concept of 'deferred labelling', where a record was added to the Inventory and the asset labelled at a later time. This approach is no longer used as it can result in assets going unlabelled. [^3]: Currently in the planning stage. \ No newline at end of file From a3405310f1556727b338de5d131d86f0f6504d5f Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 16:47:09 +0000 Subject: [PATCH 046/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index a90d6e98..822dedb1 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -82,6 +82,6 @@ As in the *commission* stage, an asset's physical and functional condition must #### Decommission #### Disposal -[^1]: This is not quite true as certain low-value assets are not tracked. A general rule-of-thumb is that anything under £5 is not tracked. +[^1]: This is not strictly true as certain low-value assets are not tracked. A general rule-of-thumb is that anything under £5 is not tracked. [^2]: There was historically a concept of 'deferred labelling', where a record was added to the Inventory and the asset labelled at a later time. This approach is no longer used as it can result in assets going unlabelled. [^3]: Currently in the planning stage. \ No newline at end of file From be9551ad896c7ecd8132ad8127357c0d5af7f853 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Fri, 17 Feb 2017 19:00:48 +0000 Subject: [PATCH 047/106] Updates post-handling.md Auto commit by GitBook Editor --- post-handling.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/post-handling.md b/post-handling.md index af4d597b..4258ab42 100644 --- a/post-handling.md +++ b/post-handling.md @@ -4,11 +4,11 @@ These are the procedures related to the Kit Logistics Coordinator's post handing ## Handling received mail -Notify the person as defined in the following table. +If specified, request that the first page is scanned and then notify the person as defined in the following table. -| Addressee | Email | -| --- | --- | -| Treasurer | treasurer@studentrobotics.org | +| Addressee | Scan first page? | Email | +| :--- | :--- | :--- | +| Treasurer | Yes | treasurer@studentrobotics.org | ## Topping up UK Postbox From f9ebbd10da6b6aeb977a79833948fc4fd577ddcf Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 12:15:50 +0000 Subject: [PATCH 048/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index 822dedb1..4ad7ceb5 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -6,7 +6,7 @@ This chapter documents the high-level organisation aspects around SR asset track ## The Inventory -To record all of the necessary information regarding SR assets, all[^1] assets are tracked in the Inventory. Unfortunately, due to historical of the term, SR uses the term *Inventory* to refer to its asset tracking system. However, in the rest of the world inventory generally refers to a record of things that a company sells and assets are things a company owns and uses to operate. It's not a big problem, but it is something to be aware of when dealing with third parties. +To record all of the necessary information regarding SR assets, all[^1] assets are tracked in the Inventory. Unfortunately, due to historical use of the term, SR uses the term *Inventory* to refer to its asset tracking system. However, in the rest of the world inventory generally refers to a record of things that a company sells and assets are things a company owns and uses to operate. It's not a big problem, but it is something to be aware of when dealing with third parties. Only property of SR is tracked in the Inventory; meaning that property of third parties must not be tracked in the Inventory. From f8715d65d589245e603d73f764e02308ee650606 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 12:18:38 +0000 Subject: [PATCH 049/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index 4ad7ceb5..bab1002b 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -6,7 +6,7 @@ This chapter documents the high-level organisation aspects around SR asset track ## The Inventory -To record all of the necessary information regarding SR assets, all[^1] assets are tracked in the Inventory. Unfortunately, due to historical use of the term, SR uses the term *Inventory* to refer to its asset tracking system. However, in the rest of the world inventory generally refers to a record of things that a company sells and assets are things a company owns and uses to operate. It's not a big problem, but it is something to be aware of when dealing with third parties. +To record all of the necessary information regarding SR assets, all[^1] assets are tracked in the Inventory. Unfortunately, due to historical use of the term, SR uses the term *Inventory* to refer to its asset tracking system. In the rest of the world inventory generally refers to a record of things that a company sells whereas assets are things a company owns and uses to operate; tracked in their asset tracking system. It's not a big problem, but it is something to be aware of. Only property of SR is tracked in the Inventory; meaning that property of third parties must not be tracked in the Inventory. From cf0a2c656bba5ffbce9902f71d28a64f6884892a Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 12:21:18 +0000 Subject: [PATCH 050/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index bab1002b..d3469bae 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -6,7 +6,7 @@ This chapter documents the high-level organisation aspects around SR asset track ## The Inventory -To record all of the necessary information regarding SR assets, all[^1] assets are tracked in the Inventory. Unfortunately, due to historical use of the term, SR uses the term *Inventory* to refer to its asset tracking system. In the rest of the world inventory generally refers to a record of things that a company sells whereas assets are things a company owns and uses to operate; tracked in their asset tracking system. It's not a big problem, but it is something to be aware of. +To record all of the necessary information regarding SR assets, all[^1] assets are tracked in the Inventory. Unfortunately, due to historical use of the term, SR uses the term *Inventory* to refer to its asset tracking system. Normally inventory refers to a record of things that an organisation sells whereas assets are things that an organisation owns and uses to operate; tracked in its asset tracking system. It is not a big problem, but it is an unusual quirk to be aware of. Only property of SR is tracked in the Inventory; meaning that property of third parties must not be tracked in the Inventory. From 0e732a63a39f49d41c128848425bdd7f5ea052a3 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 12:33:39 +0000 Subject: [PATCH 051/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index d3469bae..de82eab6 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -8,14 +8,14 @@ This chapter documents the high-level organisation aspects around SR asset track To record all of the necessary information regarding SR assets, all[^1] assets are tracked in the Inventory. Unfortunately, due to historical use of the term, SR uses the term *Inventory* to refer to its asset tracking system. Normally inventory refers to a record of things that an organisation sells whereas assets are things that an organisation owns and uses to operate; tracked in its asset tracking system. It is not a big problem, but it is an unusual quirk to be aware of. -Only property of SR is tracked in the Inventory; meaning that property of third parties must not be tracked in the Inventory. - Each asset, for example an individual webcam, has a corresponding record in the Inventory. Within this record various properties of the asset are held such that it is possible to unambiguously identify the matching asset from its Inventory record and conversely, identify the matching Inventory record from the asset. There is a one-to-one mapping of assets to Inventory records. The Inventory primarily records the location of each asset, its value, its physical and functional condition, its asset code and a history of any changes made to any of these properties. Secondary to these properties, certain assets have extra information recorded such as MAC address (for assets that have an Ethernet or Bluetooth PHY), serial number and modification flags. To provide the one-to-one mapping between assets and their Inventory records, each asset/record pair have an *asset code*, which uniquely identifies them. An important part of maintaining this one-to-one mapping is ensuring that the asset code is suitably marked onto the asset such that it can be read in the future. +Only property of SR is tracked in the Inventory; meaning that property of third parties must not be tracked in the Inventory. + ### Asset Lifecycle For each asset that SR owns there is a reasonably well defined sequence of stages that it flows through during its lifetime. This flow is shown in the diagram below. @@ -78,7 +78,15 @@ The Inventory should, as far as is possible, represent the current state of all As in the *commission* stage, an asset's physical and functional condition must be updated appropriately in its record once it has been tested. If the asset is in full working order it is ready for use. If the asset is broken then it may be possible to repair it. In some situations it is either not cost effective or not possible to repair an asset. When this occurs, the asset is no longer useful to SR and will be *decommissioned* and *disposed* of. #### Repair + +If an asset is found to be broken, it may be possible to repair it. An example of this is a motor board that has a cracked case. It is trivial to replace the broken parts of the case and therefore allow the motor board to once again be used (after being retested). + #### Modify + +Throughout the lifetime of an asset it may be necessary to perform modifications to it. This may be to add extra functionality, improve reliability or to fix a known problem. For most assets the opportunity to perform these modifications is at the Kit Collation Event, run by the Hardware Production Coordinator. If modifications are required they will perform them as necessary. + +When modifications are made to an asset it is important to track the changes in its Inventory record. These generally take the form of *modification flags* that indicate if a particular asset has been modified. If a modification across all assets of a given type is planed, for example soldering on an extra component to all motor boards, then all motor board Inventory records should be updated to indicate that none of them have received the modification. Once each asset is modified, its Inventory record must be updated appropriately. + #### Decommission #### Disposal From 67d6500ed8e39551f10d54451b65d30ee391600f Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 12:36:58 +0000 Subject: [PATCH 052/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index de82eab6..1198e260 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -43,7 +43,7 @@ graph LR decommission-->disposal {% endmermaid %} -#### Creation +#### Creation {#creation} When an asset is purchased or manufactured, a record must be entered into the Inventory. At this point a new asset code is automatically generated. The asset code **must** be marked onto the asset[^2]. The asset code can be marked in the following ways: @@ -57,7 +57,7 @@ More than one of the above techniques can be used to provide redundancy. The ideal marking solution is both human and machine readable and should be durable. These criteria should be considered when deciding how to mark a particular asset. Programming the asset code onto the asset, where possible, provides a very high level of durability as there is no label or pen that can be damaged; However one has to physically plug a cable in to read the code. QR codes and barcodes have the advantage that physical contact with the asset is not required, but they do require the asset to be visible. UHF RFID tags provide the added benefit of allowing the asset code to be read even when they are not visible; for instance when it is in a box. -#### Commission +#### Commission {#commission} Some assets will require commissioning after they have been added to the Inventory. This can be best explained with an example: When a newly manufactured motor board is added to the Inventory it is yet to be programmed or fully tested (although it may have had some basic end-of-line testing performed upon it). Once it has been added to the Inventory, in the *Creation* stage, it is ready to be programmed and tested before being used. This initial programming and testing of the motor board is part of its *commissioning* process. @@ -65,30 +65,30 @@ Not all assets will require commissioning. Generally these are things such as US Once an asset has been commissioned, its physical and functional condition must be updated appropriately in its record. In the case of assets that do not require any special commissioning procedure to be carried out, it should be assumed that they are both physically and functionally working and their records updated as such. -#### Use +#### Use {#use} Once an asset has been commissioned, or has been tested and shown to be working, it is ready to be used for its intended purpose. For the majority of assets this means that it will become part of a kit and ultimately be used by a team. During the *use* stage of an assets lifetime the majority of the updates to its record in the Inventory will be to keep track of its physical location; for example with a particular team. Occasionally there may also be other updates to its record required, such as adding a note to its description. -#### Test +#### Test {#test} The Inventory should, as far as is possible, represent the current state of all assets. However as time passes, the recorded physical and functional condition of a given asset will diverge from reality. To help rectify this, assets are regularly tested. For most assets this occurs once each year at the Kit Collation Event, run by the Hardware Production Coordinator. **TODO: Link to HPC docs.** Assets that have been repaired or modified must also undergo testing. As in the *commission* stage, an asset's physical and functional condition must be updated appropriately in its record once it has been tested. If the asset is in full working order it is ready for use. If the asset is broken then it may be possible to repair it. In some situations it is either not cost effective or not possible to repair an asset. When this occurs, the asset is no longer useful to SR and will be *decommissioned* and *disposed* of. -#### Repair +#### Repair {#repair} If an asset is found to be broken, it may be possible to repair it. An example of this is a motor board that has a cracked case. It is trivial to replace the broken parts of the case and therefore allow the motor board to once again be used (after being retested). -#### Modify +#### Modify {#modify} Throughout the lifetime of an asset it may be necessary to perform modifications to it. This may be to add extra functionality, improve reliability or to fix a known problem. For most assets the opportunity to perform these modifications is at the Kit Collation Event, run by the Hardware Production Coordinator. If modifications are required they will perform them as necessary. When modifications are made to an asset it is important to track the changes in its Inventory record. These generally take the form of *modification flags* that indicate if a particular asset has been modified. If a modification across all assets of a given type is planed, for example soldering on an extra component to all motor boards, then all motor board Inventory records should be updated to indicate that none of them have received the modification. Once each asset is modified, its Inventory record must be updated appropriately. -#### Decommission -#### Disposal +#### Decommission {#decommission} +#### Disposal {#disposal} [^1]: This is not strictly true as certain low-value assets are not tracked. A general rule-of-thumb is that anything under £5 is not tracked. [^2]: There was historically a concept of 'deferred labelling', where a record was added to the Inventory and the asset labelled at a later time. This approach is no longer used as it can result in assets going unlabelled. From 884f8e63ca427c38015df7b122c260b175a701be Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 12:48:49 +0000 Subject: [PATCH 053/106] Updates SUMMARY.md Auto commit by GitBook Editor --- SUMMARY.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/SUMMARY.md b/SUMMARY.md index 360d1cc8..63aca98e 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -8,5 +8,15 @@ * [Couriers](kit-transport/couriers.md) * [Post Handling](post-handling.md) * [Asset Tracking](asset-tracking.md) + * [Creation](asset-tracking.md#creation) + * [Commission](asset-tracking.md#commission) + * [Use](asset-tracking.md#use) + * [Test](asset-tracking.md#test) + * [Repair](asset-tracking.md#repair) + * [Modify](asset-tracking.md#modify) + * [Decommission](asset-tracking.md#decommission) + * [Disposal](asset-tracking.md#disposal) * [Logistics Software](logistics-software.md) + + From f9e05005950ea450b4dc9b7e4f679b36eeba8c62 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 12:52:33 +0000 Subject: [PATCH 054/106] Updates SUMMARY.md Auto commit by GitBook Editor --- SUMMARY.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/SUMMARY.md b/SUMMARY.md index 63aca98e..834043f6 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -8,14 +8,6 @@ * [Couriers](kit-transport/couriers.md) * [Post Handling](post-handling.md) * [Asset Tracking](asset-tracking.md) - * [Creation](asset-tracking.md#creation) - * [Commission](asset-tracking.md#commission) - * [Use](asset-tracking.md#use) - * [Test](asset-tracking.md#test) - * [Repair](asset-tracking.md#repair) - * [Modify](asset-tracking.md#modify) - * [Decommission](asset-tracking.md#decommission) - * [Disposal](asset-tracking.md#disposal) * [Logistics Software](logistics-software.md) From 04e1c90510912a19cda135e2d0aeaa128af32737 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 13:16:21 +0000 Subject: [PATCH 055/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/asset-tracking.md b/asset-tracking.md index 1198e260..430846fd 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -35,6 +35,7 @@ graph LR commission-->use use-->modify use-->test + use-->decommission modify-->test test-->repair test-->use @@ -88,6 +89,9 @@ Throughout the lifetime of an asset it may be necessary to perform modifications When modifications are made to an asset it is important to track the changes in its Inventory record. These generally take the form of *modification flags* that indicate if a particular asset has been modified. If a modification across all assets of a given type is planed, for example soldering on an extra component to all motor boards, then all motor board Inventory records should be updated to indicate that none of them have received the modification. Once each asset is modified, its Inventory record must be updated appropriately. #### Decommission {#decommission} + +If an asset is found to be broken + #### Disposal {#disposal} [^1]: This is not strictly true as certain low-value assets are not tracked. A general rule-of-thumb is that anything under £5 is not tracked. From 6c8c78a90310ed3f6d7500b4e822b9bbf331fc84 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 13:17:42 +0000 Subject: [PATCH 056/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index 430846fd..540042be 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -21,7 +21,7 @@ Only property of SR is tracked in the Inventory; meaning that property of third For each asset that SR owns there is a reasonably well defined sequence of stages that it flows through during its lifetime. This flow is shown in the diagram below. {% mermaid %} -graph LR +graph TB create(Creation) commission(Commission) use(Use) @@ -90,7 +90,7 @@ When modifications are made to an asset it is important to track the changes in #### Decommission {#decommission} -If an asset is found to be broken +If an asset is broken and unrepairable or if an asset is simply no longer required then it must first be decommissioned and then disposed of. #### Disposal {#disposal} From d970e81eb0bc7d99c6df4993bf9bd8e7df5c6d23 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 13:21:00 +0000 Subject: [PATCH 057/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index 540042be..6fc42d9f 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -37,9 +37,8 @@ graph TB use-->test use-->decommission modify-->test - test-->repair + test<-->repair test-->use - repair-->test test-->decommission decommission-->disposal {% endmermaid %} @@ -92,6 +91,10 @@ When modifications are made to an asset it is important to track the changes in If an asset is broken and unrepairable or if an asset is simply no longer required then it must first be decommissioned and then disposed of. +Some assets will have specific decommissioning requirements, however in all cases the following must be done: + + * If the asset is to be sold/given to a third party, remove or obliterate SR logo and any 'property of' messages. + #### Disposal {#disposal} [^1]: This is not strictly true as certain low-value assets are not tracked. A general rule-of-thumb is that anything under £5 is not tracked. From 009d74abfee32f02d6dd4a9e9f36dbcf24e8fc36 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 13:27:55 +0000 Subject: [PATCH 058/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index 6fc42d9f..a210228e 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -37,9 +37,10 @@ graph TB use-->test use-->decommission modify-->test - test<-->repair - test-->use - test-->decommission + test-- fixable -->repair + test-- working -->use + test-- unfixable -->decommission + repair-->test decommission-->disposal {% endmermaid %} From a171df0ef4e046dcc6e17228e15159604bf4ae1c Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 13:35:36 +0000 Subject: [PATCH 059/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index a210228e..57feaad4 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -21,7 +21,7 @@ Only property of SR is tracked in the Inventory; meaning that property of third For each asset that SR owns there is a reasonably well defined sequence of stages that it flows through during its lifetime. This flow is shown in the diagram below. {% mermaid %} -graph TB +graph LR create(Creation) commission(Commission) use(Use) @@ -37,9 +37,9 @@ graph TB use-->test use-->decommission modify-->test - test-- fixable -->repair - test-- working -->use - test-- unfixable -->decommission + test-->repair + test-->use + test-->decommission repair-->test decommission-->disposal {% endmermaid %} From 70fd270ac63555c44e43020f72585b3a197fb14a Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 15:37:24 +0000 Subject: [PATCH 060/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/asset-tracking.md b/asset-tracking.md index 57feaad4..1262afab 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -90,11 +90,9 @@ When modifications are made to an asset it is important to track the changes in #### Decommission {#decommission} -If an asset is broken and unrepairable or if an asset is simply no longer required then it must first be decommissioned and then disposed of. +If an asset is broken and unrepairable or if an asset is simply no longer required then it must be decommissioned and then disposed of. It must first be determined if the asset is to be sold/given away or if it is to be thrown away as this affects the decommissioning process. Some assets will have specific decommissioning requirements, however in all cases there are requirements. -Some assets will have specific decommissioning requirements, however in all cases the following must be done: - - * If the asset is to be sold/given to a third party, remove or obliterate SR logo and any 'property of' messages. +For assets that are to be sold or given to a third party all SR logos and 'property of' messages must be removed/obliterated. This ensures that future owners and users of the assets do not mistakenly think that it is property of SR and that SR itself does not mistakenly think that it is property belonging to SR. #### Disposal {#disposal} From 6c2fd6dd04265ef45607dd4e83cb202a8b86e5c0 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 15:38:14 +0000 Subject: [PATCH 061/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index 1262afab..e891519f 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -90,7 +90,7 @@ When modifications are made to an asset it is important to track the changes in #### Decommission {#decommission} -If an asset is broken and unrepairable or if an asset is simply no longer required then it must be decommissioned and then disposed of. It must first be determined if the asset is to be sold/given away or if it is to be thrown away as this affects the decommissioning process. Some assets will have specific decommissioning requirements, however in all cases there are requirements. +If an asset is broken and unrepairable or if an asset is simply no longer required then it must be decommissioned and then disposed of. It must first be determined if the asset is to be sold/given away or if it is to be thrown away as this affects the decommissioning process. Some assets will have specific decommissioning requirements, however in all cases there are common requirements. For assets that are to be sold or given to a third party all SR logos and 'property of' messages must be removed/obliterated. This ensures that future owners and users of the assets do not mistakenly think that it is property of SR and that SR itself does not mistakenly think that it is property belonging to SR. From edeea4ddf81ffbde1a030911947bb54ffad6c906 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 15:57:57 +0000 Subject: [PATCH 062/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/asset-tracking.md b/asset-tracking.md index e891519f..b8d43ab1 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -90,12 +90,24 @@ When modifications are made to an asset it is important to track the changes in #### Decommission {#decommission} -If an asset is broken and unrepairable or if an asset is simply no longer required then it must be decommissioned and then disposed of. It must first be determined if the asset is to be sold/given away or if it is to be thrown away as this affects the decommissioning process. Some assets will have specific decommissioning requirements, however in all cases there are common requirements. +If an asset is broken and unrepairable or if an asset is simply no longer required then it must be decommissioned and then disposed of. The Kit Logistics Coordinator must only decommission and dispose of an asset when explicitly instructed to do so by the person responsible for the asset. **TODO: Define who is responsible for each type of asset** + +It must first be determined if the asset is to be sold/given away or if it is to be thrown away, as this affects the decommissioning process. Some assets will have specific decommissioning requirements, however in all cases there are common steps that must be taken. For assets that are to be sold or given to a third party all SR logos and 'property of' messages must be removed/obliterated. This ensures that future owners and users of the assets do not mistakenly think that it is property of SR and that SR itself does not mistakenly think that it is property belonging to SR. +Once an asset has been fully decommissioned its Inventory record must be updated with a *modification flag* that indicates that it has been decommissioned. + #### Disposal {#disposal} +Once an asset has been decommissioned, it must be either sold/given away or thrown away, depending upon what was previously agreed when starting the decommissioning process. + +If an asset is to be sold the Kit Logistics Coordinator will work with the person previously responsible for that asset to determine the best way to sell the asset. If the estimated value of the asset at the time of selling is above £50 then the trustees are to be be consulted. + +If an asset is to be thrown away the Kit Logistics Coordinator will work with the person previous responsible for that asset to determine if there are any special requirements regarding its disposal; for example WEEE regulations for electronics. Also if the value of the asset, as shown in its Inventory record, is above £50 then the trustees are to be consulted. + +Once an asset has been disposed of, either via selling/giving away or by throwing away, its Inventory record must be removed from the Inventory. Only records that have a decommissioned modification flag should be removed from the Inventory. + [^1]: This is not strictly true as certain low-value assets are not tracked. A general rule-of-thumb is that anything under £5 is not tracked. [^2]: There was historically a concept of 'deferred labelling', where a record was added to the Inventory and the asset labelled at a later time. This approach is no longer used as it can result in assets going unlabelled. [^3]: Currently in the planning stage. \ No newline at end of file From aceedd8751075e40468121da6786cb9ff1cb0ff3 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 16:00:39 +0000 Subject: [PATCH 063/106] Updates SUMMARY.md Auto commit by GitBook Editor --- SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/SUMMARY.md b/SUMMARY.md index 834043f6..6973a405 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -9,6 +9,7 @@ * [Post Handling](post-handling.md) * [Asset Tracking](asset-tracking.md) * [Logistics Software](logistics-software.md) +* [✉ Contact the Kit Logistics Coordinator](mailto:logistics@studentrobotics.org) From 5e43618945a181d83729a564c8873c29b3c55985 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 16:06:42 +0000 Subject: [PATCH 064/106] Updates SUMMARY.md Auto commit by GitBook Editor --- SUMMARY.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/SUMMARY.md b/SUMMARY.md index 6973a405..e8a4787a 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -11,5 +11,6 @@ * [Logistics Software](logistics-software.md) * [✉ Contact the Kit Logistics Coordinator](mailto:logistics@studentrobotics.org) +--- - + * [Kit Coordinator Docs](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Home) \ No newline at end of file From 5417e8851e41366e04484d7fd73f38fd4e538e18 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 16:11:07 +0000 Subject: [PATCH 065/106] Updates SUMMARY.md Auto commit by GitBook Editor --- SUMMARY.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/SUMMARY.md b/SUMMARY.md index e8a4787a..302b14ba 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -11,6 +11,9 @@ * [Logistics Software](logistics-software.md) * [✉ Contact the Kit Logistics Coordinator](mailto:logistics@studentrobotics.org) ---- +## Documentation Hierarchy + +* [⬑ Trustee Docs](https://bitbucket.org/srobo/ops-manual/wiki/Home) +* [⬑ Competition Programme Coordinator Docs](https://bitbucket.org/rspanton/sr-comp-programme/wiki/Home) +* [⬑ Kit Coordinator Docs](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Home) - * [Kit Coordinator Docs](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Home) \ No newline at end of file From 266fe341a0a6910cdf5977c980f90ed817253ed2 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 16:12:26 +0000 Subject: [PATCH 066/106] Updates SUMMARY.md Auto commit by GitBook Editor --- SUMMARY.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/SUMMARY.md b/SUMMARY.md index 302b14ba..7b6459ae 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -13,7 +13,8 @@ ## Documentation Hierarchy -* [⬑ Trustee Docs](https://bitbucket.org/srobo/ops-manual/wiki/Home) -* [⬑ Competition Programme Coordinator Docs](https://bitbucket.org/rspanton/sr-comp-programme/wiki/Home) * [⬑ Kit Coordinator Docs](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Home) +* [⬑ Competition Programme Coordinator Docs](https://bitbucket.org/rspanton/sr-comp-programme/wiki/Home) +* [⬑ Trustee Docs](https://bitbucket.org/srobo/ops-manual/wiki/Home) + From 033270712c3e22ffbc03b8aebdf96ad2cfa1d45f Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 16:16:15 +0000 Subject: [PATCH 067/106] Updates SUMMARY.md Auto commit by GitBook Editor --- SUMMARY.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/SUMMARY.md b/SUMMARY.md index 7b6459ae..b02f1aa7 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -13,8 +13,8 @@ ## Documentation Hierarchy -* [⬑ Kit Coordinator Docs](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Home) -* [⬑ Competition Programme Coordinator Docs](https://bitbucket.org/rspanton/sr-comp-programme/wiki/Home) -* [⬑ Trustee Docs](https://bitbucket.org/srobo/ops-manual/wiki/Home) +* [Kit Coordinator Docs ⬎](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Home) +* [Competition Programme Coordinator Docs ⬎](https://bitbucket.org/rspanton/sr-comp-programme/wiki/Home) +* [Trustee Docs](https://bitbucket.org/srobo/ops-manual/wiki/Home) From d848de45b671902ddd8d3939b4c6b31ef867cd94 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 16:19:19 +0000 Subject: [PATCH 068/106] Updates SUMMARY.md Auto commit by GitBook Editor --- SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SUMMARY.md b/SUMMARY.md index b02f1aa7..0645295b 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -14,7 +14,7 @@ ## Documentation Hierarchy * [Kit Coordinator Docs ⬎](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Home) -* [Competition Programme Coordinator Docs ⬎](https://bitbucket.org/rspanton/sr-comp-programme/wiki/Home) +* [Comp. Prog. Coordinator Docs ⬎](https://bitbucket.org/rspanton/sr-comp-programme/wiki/Home) * [Trustee Docs](https://bitbucket.org/srobo/ops-manual/wiki/Home) From aa131c6260d0d302ff2775abf006fbc95ebb9fe5 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 17:16:44 +0000 Subject: [PATCH 069/106] Updates asset-tracking.md Auto commit by GitBook Editor --- asset-tracking.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/asset-tracking.md b/asset-tracking.md index b8d43ab1..8bd9d7ae 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -10,6 +10,8 @@ To record all of the necessary information regarding SR assets, all[^1] assets a Each asset, for example an individual webcam, has a corresponding record in the Inventory. Within this record various properties of the asset are held such that it is possible to unambiguously identify the matching asset from its Inventory record and conversely, identify the matching Inventory record from the asset. There is a one-to-one mapping of assets to Inventory records. +Each type of asset is identified by its *name*; for example a Logitech C270 webcam has the name `webcam-logitech-c270`. All assets of the same type have the same name. When creating assets that do not have an existing name in the Inventory, care must be taken to ensure that the new name given to the asset is suitably descriptive. This ensures that it does not clash with future assets that are similar, but not the same; for example an asset with the name `usb-charger` is not descriptive enough, but `usb-charger-a-500ma` is. + The Inventory primarily records the location of each asset, its value, its physical and functional condition, its asset code and a history of any changes made to any of these properties. Secondary to these properties, certain assets have extra information recorded such as MAC address (for assets that have an Ethernet or Bluetooth PHY), serial number and modification flags. To provide the one-to-one mapping between assets and their Inventory records, each asset/record pair have an *asset code*, which uniquely identifies them. An important part of maintaining this one-to-one mapping is ensuring that the asset code is suitably marked onto the asset such that it can be read in the future. From 525d65cd54db9fc3e61bb486f4386b569d6fbe95 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 17:39:32 +0000 Subject: [PATCH 070/106] Updates kit-storage.md Auto commit by GitBook Editor --- GLOSSARY.md | 3 +++ kit-storage.md | 3 +-- 2 files changed, 4 insertions(+), 2 deletions(-) create mode 100644 GLOSSARY.md diff --git a/GLOSSARY.md b/GLOSSARY.md new file mode 100644 index 00000000..9c85ed35 --- /dev/null +++ b/GLOSSARY.md @@ -0,0 +1,3 @@ +## CPY + +Competition Programme Year \ No newline at end of file diff --git a/kit-storage.md b/kit-storage.md index fb1f4e9c..e21eb4a5 100644 --- a/kit-storage.md +++ b/kit-storage.md @@ -1,4 +1,3 @@ # Kit Storage - - +During the Competition Programme Year, most of SR's assets are 'stored' with teams. Outside of the CPY assets are stored either at a storage facility in Newbury or, between the Kit Collation Event and the Kit Packing Event, at a storage facility close to the location of the aforementioned events. \ No newline at end of file From 987b6e62ca588c128a2e999793edc1de4e21a3cc Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Sat, 18 Feb 2017 17:42:17 +0000 Subject: [PATCH 071/106] Updates kit-storage.md Auto commit by GitBook Editor --- GLOSSARY.md | 3 --- kit-storage.md | 2 +- 2 files changed, 1 insertion(+), 4 deletions(-) delete mode 100644 GLOSSARY.md diff --git a/GLOSSARY.md b/GLOSSARY.md deleted file mode 100644 index 9c85ed35..00000000 --- a/GLOSSARY.md +++ /dev/null @@ -1,3 +0,0 @@ -## CPY - -Competition Programme Year \ No newline at end of file diff --git a/kit-storage.md b/kit-storage.md index e21eb4a5..6ac49627 100644 --- a/kit-storage.md +++ b/kit-storage.md @@ -1,3 +1,3 @@ # Kit Storage -During the Competition Programme Year, most of SR's assets are 'stored' with teams. Outside of the CPY assets are stored either at a storage facility in Newbury or, between the Kit Collation Event and the Kit Packing Event, at a storage facility close to the location of the aforementioned events. \ No newline at end of file +Between Kickstart and the Competition most of SR's assets are 'stored' with teams. Otherwise assets are stored either at a storage facility in Newbury or, between the Kit Collation Event and the Kit Packing Event, at a storage facility close to the location of the aforementioned events. \ No newline at end of file From 8b3f2ea0b751d73bb7dbdfb0020ead04df9e28da Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Wed, 8 Mar 2017 20:17:11 +0000 Subject: [PATCH 072/106] Updates kit-transport/packaging.md Auto commit by GitBook Editor --- kit-transport/packaging.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md index a1c9bbe3..8621b406 100644 --- a/kit-transport/packaging.md +++ b/kit-transport/packaging.md @@ -16,8 +16,15 @@ This information on packaging of kits and kit parts is for internal use only. Th When teams have to return a kit to us we provide them with a return shipping pack. This kit contains the following: -* 1 off 575x700mm polythene bag \([http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu](http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu)\) [bag research](return_shipping_bag_research) -* 4 off 160x4.8mm cable ties \([http://www.cabletiesonline.co.uk/cable-ties/cable-ties-160mm-x-4-8mm/prod\_402.html](http://www.cabletiesonline.co.uk/cable-ties/cable-ties-160mm-x-4-8mm/prod_402.html)\) +| Item | Quantity | URL | Notes | +| :--- | :--- | :--- | :--- | +| 575x700mm polythene bag | 1 | [UK Packaging ref 08220](http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu) | TODO research link | +| 160x4.8mm cable tie | 5 | [Cableties Online](https://www.cabletiesonline.co.uk/cable-ties-b-w/cable-ties-160mm-x-4.html) | Two per handle. One spare. | +| 112x80mm caution lithium ion battery label | 1 | [Limpet Labels](http://www.limpetlabels.co.uk/shop/view/293_Caution_Lithium_Battery_Labels/755_Caution_Lithium_Ion_Battery_Labels_%28112_x_80mm%29) | | +| A6 plain document wallet | 2 | [UK Packaging ref 10008](http://www.ukpackaging.com/document-wallets-a6-document-enclosed-wallets-plain) | One to use for address label. One spare. | +| 750mm wide kraft paper | 2m | [UK Packaging ref 11042](http://www.ukpackaging.com/kraft-paper-rolls-imitation-kraft-kraft-paper-rolls-imitation-kraft-750mmx220m) | | +| | | | | +| | | | | From 35a8ab99b01f8492cfc2cb91e10df90ce648b402 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Wed, 8 Mar 2017 21:32:06 +0000 Subject: [PATCH 073/106] Updates kit-transport/packaging.md Auto commit by GitBook Editor --- kit-transport/packaging.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md index 8621b406..d1a8f9ea 100644 --- a/kit-transport/packaging.md +++ b/kit-transport/packaging.md @@ -23,8 +23,8 @@ When teams have to return a kit to us we provide them with a return shipping pac | 112x80mm caution lithium ion battery label | 1 | [Limpet Labels](http://www.limpetlabels.co.uk/shop/view/293_Caution_Lithium_Battery_Labels/755_Caution_Lithium_Ion_Battery_Labels_%28112_x_80mm%29) | | | A6 plain document wallet | 2 | [UK Packaging ref 10008](http://www.ukpackaging.com/document-wallets-a6-document-enclosed-wallets-plain) | One to use for address label. One spare. | | 750mm wide kraft paper | 2m | [UK Packaging ref 11042](http://www.ukpackaging.com/kraft-paper-rolls-imitation-kraft-kraft-paper-rolls-imitation-kraft-750mmx220m) | | -| | | | | -| | | | | +| 120x215mm \(internal\) gold jiffy bag | 4 | [UK Packaging ref 09033](http://www.ukpackaging.com/arofol-classic-postal-bags-gold-2) | | +| 170x245mm \(internal\) white jiffy bag | 4 | [UK Packaging ref 09312](http://www.ukpackaging.com/jiffy-earth-aware-airkraft-white-ak1-170x245mm-50-pack) | | From 0f8adffa0e2f0380454bd84f294ef087880248ad Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Wed, 8 Mar 2017 21:42:25 +0000 Subject: [PATCH 074/106] Updates kit-transport/packaging.md Auto commit by GitBook Editor --- kit-transport/packaging.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md index d1a8f9ea..74013a15 100644 --- a/kit-transport/packaging.md +++ b/kit-transport/packaging.md @@ -5,12 +5,12 @@ This information on packaging of kits and kit parts is for internal use only. Th ## Packaging Info * Kits should generally be shipped in the while 18l Really Useful Box \(RUB\). -* All parts of the kit should be suitably protected either in Jiffy bags or bubble wrap. -* Batteries **must** be placed inside the charging bag. +* All parts of the kit should be suitably protected either in Jiffy bags or bubble wrap. The Return Shipping Pack includes a new set of jiffy bags. +* Batteries **must** be placed inside a small brown jiffy bag and the jiffy bag placed inside the charging bag. * In general no more than two batteries should be shipped in each RUB \(to ease shipping restrictions\). * Damaged batteries must not be shipped. -* Any empty space in the box should be filled with paper or bubble wrap. No packing peanuts; They're messy. -* The box should be sealed with cable ties and high quality tape over the handles \(not selotape or insulating tape\). +* Any empty space in the box should be filled with paper or bubble wrap. No packing peanuts; They're messy. The Return Shipping Pack includes sufficient paper. +* The box should be sealed with cable ties and, if available high quality tape over the handles \(not selotape or insulating tape\). The Return Shipping Pack includes cables ties, but no tape \(as it's difficult to obtain a tiny roll of high quality tape\). ## Return Shipping Pack From befdd1ea65adb21e25eefac7a0564e6be28482cf Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Thu, 9 Mar 2017 19:13:25 +0000 Subject: [PATCH 075/106] Updates kit-transport/packaging.md Auto commit by GitBook Editor --- kit-transport/packaging.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md index 74013a15..5e2150ca 100644 --- a/kit-transport/packaging.md +++ b/kit-transport/packaging.md @@ -26,5 +26,32 @@ When teams have to return a kit to us we provide them with a return shipping pac | 120x215mm \(internal\) gold jiffy bag | 4 | [UK Packaging ref 09033](http://www.ukpackaging.com/arofol-classic-postal-bags-gold-2) | | | 170x245mm \(internal\) white jiffy bag | 4 | [UK Packaging ref 09312](http://www.ukpackaging.com/jiffy-earth-aware-airkraft-white-ak1-170x245mm-50-pack) | | +### Instruction Notes + +1. Check all parts are present \(use list provided and notify LTC of any missing items\). +2. Place parts into jiffy bags \(do not seal unless specified\): + 1. Large white: + 1. 1x tablet + 2. 1x battery charger + 3. 1x battery charger power supply, 1x webcam, 1x tablet charger + 4. 1x power board, 1x servo board + 2. Small brown: + 1. 2x batteries + 2. 2x motor boards, 1x ruggeduio with screw shields plugged in + 3. 2x USB hubs, 1x brain board + 4. Remaining loose items: wifi dongles, usb memory stick, camcons \(7.5, 5 and 3.81mm\), screwdriver, brain board power cable. **seal**. +3. Place jiffy bag containing the batteries into the battery charging bag +4. Tear the brown paper into two equally sized pieces +5. Scrunch up one piece of brown paper and place in the bottom of the RUB +6. Place battery charging bag, jiffy bags and all cables \(full size USB, micro USB and any wire\) into the RUB +7. Scrunch up the other piece of brown paper and place on top of the stuff +8. Fit the lid onto the RUB and seal handles with four cable ties \(do not cut the cable ties as the sharp corners could tear the bag\) +9. Place the sealed RUB into the bag +10. Seal the bag closed +11. Stick the LiPo sticker onto the bag +12. Place the supplied shipping label into the document wallet and stick the document wallet onto the bag \(don't forget to remove the narrow backing strip too\). +13. Hand the package to reception/who ever it will be collected from. +14. Notify your LTC that the kit is ready for collection. + From 27ad8c819646f1687e748d067e176d0d6492fb70 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Thu, 9 Mar 2017 19:28:42 +0000 Subject: [PATCH 076/106] Updates kit-transport/packaging.md Auto commit by GitBook Editor --- kit-transport/packaging.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md index 5e2150ca..e0ec67d1 100644 --- a/kit-transport/packaging.md +++ b/kit-transport/packaging.md @@ -30,26 +30,26 @@ When teams have to return a kit to us we provide them with a return shipping pac 1. Check all parts are present \(use list provided and notify LTC of any missing items\). 2. Place parts into jiffy bags \(do not seal unless specified\): - 1. Large white: + 1. Large white **\[photo of four bags with the parts in front\]:** 1. 1x tablet 2. 1x battery charger 3. 1x battery charger power supply, 1x webcam, 1x tablet charger 4. 1x power board, 1x servo board - 2. Small brown: + 2. Small brown **\[photo of four bags with the parts in front\]**: 1. 2x batteries 2. 2x motor boards, 1x ruggeduio with screw shields plugged in 3. 2x USB hubs, 1x brain board 4. Remaining loose items: wifi dongles, usb memory stick, camcons \(7.5, 5 and 3.81mm\), screwdriver, brain board power cable. **seal**. -3. Place jiffy bag containing the batteries into the battery charging bag +3. Place jiffy bag containing the batteries into the battery charging bag **\[photo of jiffy bag partially in charging bag\]** 4. Tear the brown paper into two equally sized pieces -5. Scrunch up one piece of brown paper and place in the bottom of the RUB -6. Place battery charging bag, jiffy bags and all cables \(full size USB, micro USB and any wire\) into the RUB -7. Scrunch up the other piece of brown paper and place on top of the stuff -8. Fit the lid onto the RUB and seal handles with four cable ties \(do not cut the cable ties as the sharp corners could tear the bag\) -9. Place the sealed RUB into the bag -10. Seal the bag closed +5. Scrunch up one piece of brown paper and place in the bottom of the RUB **\[photo of scrunched up paper in the bottom of RUB\]** +6. Place battery charging bag, jiffy bags and all cables \(full size USB, micro USB and any wire\) into the RUB **\[photo of stuff in RUB\]** +7. Scrunch up the other piece of brown paper and place on top of the stuff **\[photo of scrunched up paper on top\]** +8. Fit the lid onto the RUB and seal handles with four cable ties \(do not cut the cable ties as the sharp corners could tear the bag\) **\[photo of cable tie being threaded through, photo of loose cable tie, photo of complete handle demonstrating tail direction\]** +9. Place the sealed RUB into the bag **\[photo of RUB partially in the bag\]** +10. Seal the bag closed **\[photo of the sealed bag highlighting it being tight\]** 11. Stick the LiPo sticker onto the bag -12. Place the supplied shipping label into the document wallet and stick the document wallet onto the bag \(don't forget to remove the narrow backing strip too\). +12. Place the supplied shipping label into the document wallet and stick the document wallet onto the bag \(don't forget to remove the narrow backing strip too\) **\[photo of lipo sticker and shipping label in document wallet\]**. 13. Hand the package to reception/who ever it will be collected from. 14. Notify your LTC that the kit is ready for collection. From 3f50cd61105cf9c811bc12e3c8e2ef649a40d06c Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Thu, 9 Mar 2017 19:41:05 +0000 Subject: [PATCH 077/106] Updates research.md Auto commit by GitBook Editor --- SUMMARY.md | 2 +- research.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 research.md diff --git a/SUMMARY.md b/SUMMARY.md index 0645295b..db125cbe 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -9,6 +9,7 @@ * [Post Handling](post-handling.md) * [Asset Tracking](asset-tracking.md) * [Logistics Software](logistics-software.md) +* [Research](research.md) * [✉ Contact the Kit Logistics Coordinator](mailto:logistics@studentrobotics.org) ## Documentation Hierarchy @@ -17,4 +18,3 @@ * [Comp. Prog. Coordinator Docs ⬎](https://bitbucket.org/rspanton/sr-comp-programme/wiki/Home) * [Trustee Docs](https://bitbucket.org/srobo/ops-manual/wiki/Home) - diff --git a/research.md b/research.md new file mode 100644 index 00000000..7c06a49a --- /dev/null +++ b/research.md @@ -0,0 +1,16 @@ +# Research + +The following sections document various bits of research that have been carried out by the Kit Logistics Coordinator while fulfilling their responsibilities. + +## Return Shipping Bag {#return-shipping-bag} + +| Size \(mm\) | Actual size \(mm\) | 18l RUB fit | 9l RUB \(non-XL\) fit | +| --- | --- | --- | --- | +| 425x600 | | \[untested\] | \[untested\]. I suspect that it will be good, but I need to get a sample bag. | +| 525x600 | 524x610 | Does not fit | Fits easily with the box aligned with the bag. Is a tight, but comfortable, fit with the box sideways relative to the bag. It very nearly fits two boxes in sideways, but is a little too short. | +| 575x700 | 583x714 | Perfect easy fit with the box aligned with the bag | Easily fits two boxes either side-by-side or stacked \(preferred due to its rigidity\) | +| 600x900 | 600x900 | Easily fits with the box aligned with the bag | Easily fits three boxes. Two stacked and one on its side. It is not a particularly solid arrangement. | +| 700x850 | 700x850 | Easily fits in both orientations | Fits four boxes, stacked, pretty much perfectly. | + + + From 52051b286b62049c85f774ad63909e62a4d939ba Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Thu, 9 Mar 2017 19:43:08 +0000 Subject: [PATCH 078/106] Updates kit-transport/packaging.md Auto commit by GitBook Editor --- kit-transport/packaging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md index e0ec67d1..75ff3f13 100644 --- a/kit-transport/packaging.md +++ b/kit-transport/packaging.md @@ -18,7 +18,7 @@ When teams have to return a kit to us we provide them with a return shipping pac | Item | Quantity | URL | Notes | | :--- | :--- | :--- | :--- | -| 575x700mm polythene bag | 1 | [UK Packaging ref 08220](http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu) | TODO research link | +| 575x700mm polythene bag | 1 | [UK Packaging ref 08220](http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu) | [Bag size research](/research#return-shipping-bag) | | 160x4.8mm cable tie | 5 | [Cableties Online](https://www.cabletiesonline.co.uk/cable-ties-b-w/cable-ties-160mm-x-4.html) | Two per handle. One spare. | | 112x80mm caution lithium ion battery label | 1 | [Limpet Labels](http://www.limpetlabels.co.uk/shop/view/293_Caution_Lithium_Battery_Labels/755_Caution_Lithium_Ion_Battery_Labels_%28112_x_80mm%29) | | | A6 plain document wallet | 2 | [UK Packaging ref 10008](http://www.ukpackaging.com/document-wallets-a6-document-enclosed-wallets-plain) | One to use for address label. One spare. | From acfe70fb93db553dea70a684dbe77db74521692d Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Thu, 9 Mar 2017 19:44:42 +0000 Subject: [PATCH 079/106] Updates kit-transport/packaging.md Auto commit by GitBook Editor --- kit-transport/packaging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md index 75ff3f13..3ea8e379 100644 --- a/kit-transport/packaging.md +++ b/kit-transport/packaging.md @@ -18,7 +18,7 @@ When teams have to return a kit to us we provide them with a return shipping pac | Item | Quantity | URL | Notes | | :--- | :--- | :--- | :--- | -| 575x700mm polythene bag | 1 | [UK Packaging ref 08220](http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu) | [Bag size research](/research#return-shipping-bag) | +| 575x700mm polythene bag | 1 | [UK Packaging ref 08220](http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu) | [Bag size research](research#return-shipping-bag) | | 160x4.8mm cable tie | 5 | [Cableties Online](https://www.cabletiesonline.co.uk/cable-ties-b-w/cable-ties-160mm-x-4.html) | Two per handle. One spare. | | 112x80mm caution lithium ion battery label | 1 | [Limpet Labels](http://www.limpetlabels.co.uk/shop/view/293_Caution_Lithium_Battery_Labels/755_Caution_Lithium_Ion_Battery_Labels_%28112_x_80mm%29) | | | A6 plain document wallet | 2 | [UK Packaging ref 10008](http://www.ukpackaging.com/document-wallets-a6-document-enclosed-wallets-plain) | One to use for address label. One spare. | From 098b72e43f868de6e95958f2b09eeb344ba89740 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Thu, 9 Mar 2017 19:49:39 +0000 Subject: [PATCH 080/106] Updates kit-transport/packaging.md Auto commit by GitBook Editor --- kit-transport/packaging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md index 3ea8e379..99b86dd8 100644 --- a/kit-transport/packaging.md +++ b/kit-transport/packaging.md @@ -18,7 +18,7 @@ When teams have to return a kit to us we provide them with a return shipping pac | Item | Quantity | URL | Notes | | :--- | :--- | :--- | :--- | -| 575x700mm polythene bag | 1 | [UK Packaging ref 08220](http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu) | [Bag size research](research#return-shipping-bag) | +| 575x700mm polythene bag | 1 | [UK Packaging ref 08220](http://www.ukpackaging.com/postal-packaging/polythene-mailing-bags/grey-polythene-mailing-bags-575x700mm-60mu) | [Bag size research](../research.md#return-shipping-bag) | | 160x4.8mm cable tie | 5 | [Cableties Online](https://www.cabletiesonline.co.uk/cable-ties-b-w/cable-ties-160mm-x-4.html) | Two per handle. One spare. | | 112x80mm caution lithium ion battery label | 1 | [Limpet Labels](http://www.limpetlabels.co.uk/shop/view/293_Caution_Lithium_Battery_Labels/755_Caution_Lithium_Ion_Battery_Labels_%28112_x_80mm%29) | | | A6 plain document wallet | 2 | [UK Packaging ref 10008](http://www.ukpackaging.com/document-wallets-a6-document-enclosed-wallets-plain) | One to use for address label. One spare. | From eae928457243da2881ce8abb20675537d11bebcb Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Mon, 20 Mar 2017 20:24:47 +0000 Subject: [PATCH 081/106] Updates kit-transport/packaging.md Auto commit by GitBook Editor --- kit-transport/packaging.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md index 99b86dd8..4c87f989 100644 --- a/kit-transport/packaging.md +++ b/kit-transport/packaging.md @@ -25,6 +25,8 @@ When teams have to return a kit to us we provide them with a return shipping pac | 750mm wide kraft paper | 2m | [UK Packaging ref 11042](http://www.ukpackaging.com/kraft-paper-rolls-imitation-kraft-kraft-paper-rolls-imitation-kraft-750mmx220m) | | | 120x215mm \(internal\) gold jiffy bag | 4 | [UK Packaging ref 09033](http://www.ukpackaging.com/arofol-classic-postal-bags-gold-2) | | | 170x245mm \(internal\) white jiffy bag | 4 | [UK Packaging ref 09312](http://www.ukpackaging.com/jiffy-earth-aware-airkraft-white-ak1-170x245mm-50-pack) | | +| 220x320mm \(internal\) white jiffy bag | 1 | [UK Packaging ref 09314](http://www.ukpackaging.com/postal-packaging/jiffy-bags/jiffy-earth-aware-airkraft-white-ak3-220x320mm-50-pack) | To put the whole return shipping pack into. | +| Return shipping pack instructions | 1 | [Version 1](https://github.com/srobo/return-shipping-pack/releases/download/v1/return-shipping-pack-instructions.pdf) | | ### Instruction Notes From 16c35fe57fb9e615f001dc3f9315a20430256f99 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Mon, 20 Mar 2017 20:26:58 +0000 Subject: [PATCH 082/106] Updates kit-transport/packaging.md Auto commit by GitBook Editor --- kit-transport/packaging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md index 4c87f989..169c675a 100644 --- a/kit-transport/packaging.md +++ b/kit-transport/packaging.md @@ -26,7 +26,7 @@ When teams have to return a kit to us we provide them with a return shipping pac | 120x215mm \(internal\) gold jiffy bag | 4 | [UK Packaging ref 09033](http://www.ukpackaging.com/arofol-classic-postal-bags-gold-2) | | | 170x245mm \(internal\) white jiffy bag | 4 | [UK Packaging ref 09312](http://www.ukpackaging.com/jiffy-earth-aware-airkraft-white-ak1-170x245mm-50-pack) | | | 220x320mm \(internal\) white jiffy bag | 1 | [UK Packaging ref 09314](http://www.ukpackaging.com/postal-packaging/jiffy-bags/jiffy-earth-aware-airkraft-white-ak3-220x320mm-50-pack) | To put the whole return shipping pack into. | -| Return shipping pack instructions | 1 | [Version 1](https://github.com/srobo/return-shipping-pack/releases/download/v1/return-shipping-pack-instructions.pdf) | | +| Return shipping pack instructions | 1 | [Revision 1](https://github.com/srobo/return-shipping-pack/releases/download/v1/return-shipping-pack-instructions.pdf) | | ### Instruction Notes From 751dddd6912a0e489ce551dee0d163e198dbd8db Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Mon, 20 Mar 2017 21:20:59 +0000 Subject: [PATCH 083/106] Updates kit-transport/couriers.md Auto commit by GitBook Editor --- kit-transport/couriers.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/kit-transport/couriers.md b/kit-transport/couriers.md index b95ed869..a0bb07e7 100644 --- a/kit-transport/couriers.md +++ b/kit-transport/couriers.md @@ -7,9 +7,11 @@ We have confirmed that the following couriers are happy handling packages contai Kit data for couriers: * Dimensions: 48cm x 39cm x 20cm -* Weight: 6kg \(A kit weighs 4.95kg [ref](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Kit%20Definition). 6kg gives some headroom\) +* Weight: 6kg \(A kit weighs 4.95kg [ref](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Kit Definition). 6kg gives some headroom\) * Value \(for insurance\): £500 * Batteries: Lithium Ion. Packed with equipment. Batteries less than 100Wh. In all circumstances a shipment of a kit must have at least £500 worth of insurance. +Note that the above package details are repeated in the loan extension instructions in [return-shipping-pack.git](https://github.com/srobo/return-shipping-pack/tree/master/instructions) and therefore should be updated there when the details change. + From 689fe478df58a1dfda22b7e2b25fc38ba103f585 Mon Sep 17 00:00:00 2001 From: Richard Barlow Date: Mon, 20 Mar 2017 21:31:48 +0000 Subject: [PATCH 084/106] Updates kit-transport/packaging.md Auto commit by GitBook Editor --- kit-transport/packaging.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md index 169c675a..29027576 100644 --- a/kit-transport/packaging.md +++ b/kit-transport/packaging.md @@ -26,7 +26,9 @@ When teams have to return a kit to us we provide them with a return shipping pac | 120x215mm \(internal\) gold jiffy bag | 4 | [UK Packaging ref 09033](http://www.ukpackaging.com/arofol-classic-postal-bags-gold-2) | | | 170x245mm \(internal\) white jiffy bag | 4 | [UK Packaging ref 09312](http://www.ukpackaging.com/jiffy-earth-aware-airkraft-white-ak1-170x245mm-50-pack) | | | 220x320mm \(internal\) white jiffy bag | 1 | [UK Packaging ref 09314](http://www.ukpackaging.com/postal-packaging/jiffy-bags/jiffy-earth-aware-airkraft-white-ak3-220x320mm-50-pack) | To put the whole return shipping pack into. | -| Return shipping pack instructions | 1 | [Revision 1](https://github.com/srobo/return-shipping-pack/releases/download/v1/return-shipping-pack-instructions.pdf) | | +| Return shipping pack instructions | 1 | [Revision SR2017-2](https://github.com/srobo/return-shipping-pack/releases/download/SR2017-2/return-shipping-pack-instructions.pdf) | | +| Loan extension instructions | 1 | [Revision SR2017-2](https://github.com/srobo/return-shipping-pack/releases/download/SR2017-2/loanext-instructions.pdf) | Only included in return shipping packs handed out at the end of the competition. | +| Kit list | 1 | [Kit Definition](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Kit%20Definition) | Only included in return shipping packs handed out at the end of the competition. Remove 'disclaimer' and the wire from the list. | ### Instruction Notes From daa7e9507bb8f33434d7d1dd39bed7af707c83ac Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sun, 28 Apr 2019 19:28:22 +0100 Subject: [PATCH 085/106] Remove files not needed in the runbook --- .gitignore | 16 ---------------- SUMMARY.md | 20 -------------------- book.json | 3 --- 3 files changed, 39 deletions(-) delete mode 100644 .gitignore delete mode 100644 SUMMARY.md delete mode 100644 book.json diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 1a366fb0..00000000 --- a/.gitignore +++ /dev/null @@ -1,16 +0,0 @@ -# Node rules: -## Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) -.grunt - -## Dependency directory -## Commenting this out is preferred by some people, see -## https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git -node_modules - -# Book build output -_book - -# eBook build output -*.epub -*.mobi -*.pdf \ No newline at end of file diff --git a/SUMMARY.md b/SUMMARY.md deleted file mode 100644 index db125cbe..00000000 --- a/SUMMARY.md +++ /dev/null @@ -1,20 +0,0 @@ -# Summary - -* [Introduction](README.md) -* [Kit Storage](kit-storage.md) -* [Kit Shipping](kit-transport.md) - * [Procedures](kit-transport/procedures.md) - * [Packaging](kit-transport/packaging.md) - * [Couriers](kit-transport/couriers.md) -* [Post Handling](post-handling.md) -* [Asset Tracking](asset-tracking.md) -* [Logistics Software](logistics-software.md) -* [Research](research.md) -* [✉ Contact the Kit Logistics Coordinator](mailto:logistics@studentrobotics.org) - -## Documentation Hierarchy - -* [Kit Coordinator Docs ⬎](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Home) -* [Comp. Prog. Coordinator Docs ⬎](https://bitbucket.org/rspanton/sr-comp-programme/wiki/Home) -* [Trustee Docs](https://bitbucket.org/srobo/ops-manual/wiki/Home) - diff --git a/book.json b/book.json deleted file mode 100644 index 421168a7..00000000 --- a/book.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "plugins": ["mermaid"] -} \ No newline at end of file From 2afd4b9015bbdfb32e2af0565780453c8f809c43 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sun, 28 Apr 2019 19:30:34 +0100 Subject: [PATCH 086/106] Minor whitespace tidyups --- README.md | 2 +- asset-tracking.md | 2 +- kit-storage.md | 2 +- kit-transport.md | 1 - kit-transport/couriers.md | 1 - kit-transport/packaging.md | 3 --- kit-transport/procedures.md | 1 - logistics-software.md | 3 --- post-handling.md | 1 - research.md | 3 --- 10 files changed, 3 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 86f77d69..c2754910 100644 --- a/README.md +++ b/README.md @@ -11,4 +11,4 @@ The responsibilities of the Kit Logistics Coordinator are as follows: To fulfil these responsibilities the Kit Logistics Coordinator also does the following -* Maintain a suite of logistics software \ No newline at end of file +* Maintain a suite of logistics software diff --git a/asset-tracking.md b/asset-tracking.md index 8bd9d7ae..946a09dd 100644 --- a/asset-tracking.md +++ b/asset-tracking.md @@ -112,4 +112,4 @@ Once an asset has been disposed of, either via selling/giving away or by throwin [^1]: This is not strictly true as certain low-value assets are not tracked. A general rule-of-thumb is that anything under £5 is not tracked. [^2]: There was historically a concept of 'deferred labelling', where a record was added to the Inventory and the asset labelled at a later time. This approach is no longer used as it can result in assets going unlabelled. -[^3]: Currently in the planning stage. \ No newline at end of file +[^3]: Currently in the planning stage. diff --git a/kit-storage.md b/kit-storage.md index 6ac49627..5880dec3 100644 --- a/kit-storage.md +++ b/kit-storage.md @@ -1,3 +1,3 @@ # Kit Storage -Between Kickstart and the Competition most of SR's assets are 'stored' with teams. Otherwise assets are stored either at a storage facility in Newbury or, between the Kit Collation Event and the Kit Packing Event, at a storage facility close to the location of the aforementioned events. \ No newline at end of file +Between Kickstart and the Competition most of SR's assets are 'stored' with teams. Otherwise assets are stored either at a storage facility in Newbury or, between the Kit Collation Event and the Kit Packing Event, at a storage facility close to the location of the aforementioned events. diff --git a/kit-transport.md b/kit-transport.md index 3a5c4411..42c02040 100644 --- a/kit-transport.md +++ b/kit-transport.md @@ -7,4 +7,3 @@ Almost all shipping requirements happen at well defined points throughout the St When kits or parts of kit are being shipped they must be suitably packaged to prevent them from being damaged. Details of the packaging requirements are detailed in the [Packaging](/kit-transport/packaging.md) chapter. Some parts of the kit require special attention when being shipped. The [Couriers](/kit-transport/couriers.md) chapter includes information on these requirements along with some general information about the parts commonly shipped. - diff --git a/kit-transport/couriers.md b/kit-transport/couriers.md index a0bb07e7..f19f1c5c 100644 --- a/kit-transport/couriers.md +++ b/kit-transport/couriers.md @@ -14,4 +14,3 @@ Kit data for couriers: In all circumstances a shipment of a kit must have at least £500 worth of insurance. Note that the above package details are repeated in the loan extension instructions in [return-shipping-pack.git](https://github.com/srobo/return-shipping-pack/tree/master/instructions) and therefore should be updated there when the details change. - diff --git a/kit-transport/packaging.md b/kit-transport/packaging.md index 29027576..1f56eaf9 100644 --- a/kit-transport/packaging.md +++ b/kit-transport/packaging.md @@ -56,6 +56,3 @@ When teams have to return a kit to us we provide them with a return shipping pac 12. Place the supplied shipping label into the document wallet and stick the document wallet onto the bag \(don't forget to remove the narrow backing strip too\) **\[photo of lipo sticker and shipping label in document wallet\]**. 13. Hand the package to reception/who ever it will be collected from. 14. Notify your LTC that the kit is ready for collection. - - - diff --git a/kit-transport/procedures.md b/kit-transport/procedures.md index 8646feb0..fbc99041 100644 --- a/kit-transport/procedures.md +++ b/kit-transport/procedures.md @@ -110,4 +110,3 @@ Non-team kits \(those that are classed as development, support, PR or local\) an ## Shipping of non-kit assets Most assets are kit related. However, a few assets are not kits or parts thereof. This is mostly competition hardware such as arena walls. The Kit Logistics Coordinator is also responsible for shipping these non-kit assets when required. TBD. - diff --git a/logistics-software.md b/logistics-software.md index ab3e9861..f92ac3bd 100644 --- a/logistics-software.md +++ b/logistics-software.md @@ -8,6 +8,3 @@ To fulfil the multitude of responsibilities, the Kit Logistics Coordinator uses | --- | --- | --- | | Inventory Tools | [https://www.studentrobotics.org/cgit/tools.git/](https://www.studentrobotics.org/cgit/tools.git/) | This project currently contains a mishmash of tools. The Inventory tools need teasing out. | | Inventory | [https://www.studentrobotics.org/cgit/inventory.git/](https://www.studentrobotics.org/cgit/inventory.git/) | This is not a software project in itself. It represents the current state of all SR assets. | - - - diff --git a/post-handling.md b/post-handling.md index 4258ab42..392008a2 100644 --- a/post-handling.md +++ b/post-handling.md @@ -13,4 +13,3 @@ If specified, request that the first page is scanned and then notify the person ## Topping up UK Postbox UK Postbox requires topping up with credit. Budget for this comes from either the `srXXXX/post` or the `srXXXX/kits/shipping` budget lines depending on what it will generally be used for. Obviously it's not possible to know exactly how the credit will ultimately be spent so it's not critical. Since it is not possible to extract money back out of UK Postbox, top ups should be sufficient for the foreseeable future only. - diff --git a/research.md b/research.md index 7c06a49a..f1e99f66 100644 --- a/research.md +++ b/research.md @@ -11,6 +11,3 @@ The following sections document various bits of research that have been carried | 575x700 | 583x714 | Perfect easy fit with the box aligned with the bag | Easily fits two boxes either side-by-side or stacked \(preferred due to its rigidity\) | | 600x900 | 600x900 | Easily fits with the box aligned with the bag | Easily fits three boxes. Two stacked and one on its side. It is not a particularly solid arrangement. | | 700x850 | 700x850 | Easily fits in both orientations | Fits four boxes, stacked, pretty much perfectly. | - - - From aa4ac7d445020d2cd497394effe72da4b4f424ca Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sun, 28 Apr 2019 19:35:11 +0100 Subject: [PATCH 087/106] Move files to new location in hierarchy --- README.md => docs/kit/logistics/README.md | 0 asset-tracking.md => docs/kit/logistics/asset-tracking.md | 0 kit-storage.md => docs/kit/logistics/kit-storage.md | 0 kit-transport.md => docs/kit/logistics/kit-transport.md | 6 +++--- .../kit/logistics/logistics-software.md | 0 post-handling.md => docs/kit/logistics/post-handling.md | 0 research.md => docs/kit/logistics/research.md | 0 {kit-transport => docs/kit/logistics/transport}/couriers.md | 0 .../kit/logistics/transport}/packaging.md | 0 .../kit/logistics/transport}/procedures.md | 0 10 files changed, 3 insertions(+), 3 deletions(-) rename README.md => docs/kit/logistics/README.md (100%) rename asset-tracking.md => docs/kit/logistics/asset-tracking.md (100%) rename kit-storage.md => docs/kit/logistics/kit-storage.md (100%) rename kit-transport.md => docs/kit/logistics/kit-transport.md (72%) rename logistics-software.md => docs/kit/logistics/logistics-software.md (100%) rename post-handling.md => docs/kit/logistics/post-handling.md (100%) rename research.md => docs/kit/logistics/research.md (100%) rename {kit-transport => docs/kit/logistics/transport}/couriers.md (100%) rename {kit-transport => docs/kit/logistics/transport}/packaging.md (100%) rename {kit-transport => docs/kit/logistics/transport}/procedures.md (100%) diff --git a/README.md b/docs/kit/logistics/README.md similarity index 100% rename from README.md rename to docs/kit/logistics/README.md diff --git a/asset-tracking.md b/docs/kit/logistics/asset-tracking.md similarity index 100% rename from asset-tracking.md rename to docs/kit/logistics/asset-tracking.md diff --git a/kit-storage.md b/docs/kit/logistics/kit-storage.md similarity index 100% rename from kit-storage.md rename to docs/kit/logistics/kit-storage.md diff --git a/kit-transport.md b/docs/kit/logistics/kit-transport.md similarity index 72% rename from kit-transport.md rename to docs/kit/logistics/kit-transport.md index 42c02040..7aebd419 100644 --- a/kit-transport.md +++ b/docs/kit/logistics/kit-transport.md @@ -2,8 +2,8 @@ Part of the Kit Logistics Coordinator's responsibilities cover moving either whole or parts of kits around the UK and the world. This is generally referred to as shipping \(even though it rarely involves ships!\). All movement of kit is managed by the Kit Logistics Coordinator, so please do not ship anything without first speaking to them. You can contact them at: [logistics@studentrobotics.org](mailto:logistics@studentrobotics.org). -Almost all shipping requirements happen at well defined points throughout the Student Robotics calendar. When kits or parts therefore need to be shipped specific procedures are followed as detailed in the [Procedures](/kit-transport/procedures.md) chapter. +Almost all shipping requirements happen at well defined points throughout the Student Robotics calendar. When kits or parts therefore need to be shipped specific procedures are followed as detailed in the [Procedures](./transport/procedures.md) chapter. -When kits or parts of kit are being shipped they must be suitably packaged to prevent them from being damaged. Details of the packaging requirements are detailed in the [Packaging](/kit-transport/packaging.md) chapter. +When kits or parts of kit are being shipped they must be suitably packaged to prevent them from being damaged. Details of the packaging requirements are detailed in the [Packaging](./transport/packaging.md) chapter. -Some parts of the kit require special attention when being shipped. The [Couriers](/kit-transport/couriers.md) chapter includes information on these requirements along with some general information about the parts commonly shipped. +Some parts of the kit require special attention when being shipped. The [Couriers](./transport/couriers.md) chapter includes information on these requirements along with some general information about the parts commonly shipped. diff --git a/logistics-software.md b/docs/kit/logistics/logistics-software.md similarity index 100% rename from logistics-software.md rename to docs/kit/logistics/logistics-software.md diff --git a/post-handling.md b/docs/kit/logistics/post-handling.md similarity index 100% rename from post-handling.md rename to docs/kit/logistics/post-handling.md diff --git a/research.md b/docs/kit/logistics/research.md similarity index 100% rename from research.md rename to docs/kit/logistics/research.md diff --git a/kit-transport/couriers.md b/docs/kit/logistics/transport/couriers.md similarity index 100% rename from kit-transport/couriers.md rename to docs/kit/logistics/transport/couriers.md diff --git a/kit-transport/packaging.md b/docs/kit/logistics/transport/packaging.md similarity index 100% rename from kit-transport/packaging.md rename to docs/kit/logistics/transport/packaging.md diff --git a/kit-transport/procedures.md b/docs/kit/logistics/transport/procedures.md similarity index 100% rename from kit-transport/procedures.md rename to docs/kit/logistics/transport/procedures.md From 1739bff84a33710fc5ebce80ba51df215bdd15b5 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sun, 28 Apr 2019 19:42:37 +0100 Subject: [PATCH 088/106] Add link to the original versions of these documents --- docs/kit/logistics/README.md | 5 +++++ docs/kit/logistics/asset-tracking.md | 7 ++++++- docs/kit/logistics/kit-storage.md | 5 +++++ docs/kit/logistics/kit-transport.md | 5 +++++ docs/kit/logistics/logistics-software.md | 5 +++++ docs/kit/logistics/post-handling.md | 5 +++++ docs/kit/logistics/research.md | 5 +++++ docs/kit/logistics/transport/couriers.md | 5 +++++ docs/kit/logistics/transport/packaging.md | 5 +++++ docs/kit/logistics/transport/procedures.md | 5 +++++ 10 files changed, 51 insertions(+), 1 deletion(-) diff --git a/docs/kit/logistics/README.md b/docs/kit/logistics/README.md index c2754910..df07361c 100644 --- a/docs/kit/logistics/README.md +++ b/docs/kit/logistics/README.md @@ -1,3 +1,8 @@ +--- +original: + authors: Richard Barlow + url: https://srobo-legacy.gitbooks.io/student-robotics-kit-logistics +--- # Student Robotics Kit Logistics Documentation This is the documentation of the Student Robotics Kit Logistics Coordinator. It is primarily for internal use, but may be of interest to others. If you are in a team competing in Student Robotics, you probably want the [Docs](https://www.studentrobotics.org/docs). diff --git a/docs/kit/logistics/asset-tracking.md b/docs/kit/logistics/asset-tracking.md index 946a09dd..25972c70 100644 --- a/docs/kit/logistics/asset-tracking.md +++ b/docs/kit/logistics/asset-tracking.md @@ -1,3 +1,8 @@ +--- +original: + authors: Richard Barlow + url: https://srobo-legacy.gitbooks.io/student-robotics-kit-logistics/asset-tracking.html +--- # Asset Tracking One of the responsibilities of the Kit Logistics Coordinator is to maintain a record of the location and state of all SRs assets. This is generally referred to as asset tracking. To allow SR to operate it is important that the location and state of all of its assets are known at all times. @@ -32,7 +37,7 @@ graph LR modify(Modify) decommission(Decommission) disposal(Disposal) - + create-->commission commission-->use use-->modify diff --git a/docs/kit/logistics/kit-storage.md b/docs/kit/logistics/kit-storage.md index 5880dec3..d11286fe 100644 --- a/docs/kit/logistics/kit-storage.md +++ b/docs/kit/logistics/kit-storage.md @@ -1,3 +1,8 @@ +--- +original: + authors: Richard Barlow + url: https://srobo-legacy.gitbooks.io/student-robotics-kit-logistics/kit-storage.html +--- # Kit Storage Between Kickstart and the Competition most of SR's assets are 'stored' with teams. Otherwise assets are stored either at a storage facility in Newbury or, between the Kit Collation Event and the Kit Packing Event, at a storage facility close to the location of the aforementioned events. diff --git a/docs/kit/logistics/kit-transport.md b/docs/kit/logistics/kit-transport.md index 7aebd419..77cb0f5c 100644 --- a/docs/kit/logistics/kit-transport.md +++ b/docs/kit/logistics/kit-transport.md @@ -1,3 +1,8 @@ +--- +original: + authors: Richard Barlow + url: https://srobo-legacy.gitbooks.io/student-robotics-kit-logistics/kit-transport.html +--- # Kit Shipping Part of the Kit Logistics Coordinator's responsibilities cover moving either whole or parts of kits around the UK and the world. This is generally referred to as shipping \(even though it rarely involves ships!\). All movement of kit is managed by the Kit Logistics Coordinator, so please do not ship anything without first speaking to them. You can contact them at: [logistics@studentrobotics.org](mailto:logistics@studentrobotics.org). diff --git a/docs/kit/logistics/logistics-software.md b/docs/kit/logistics/logistics-software.md index f92ac3bd..f61a7392 100644 --- a/docs/kit/logistics/logistics-software.md +++ b/docs/kit/logistics/logistics-software.md @@ -1,3 +1,8 @@ +--- +original: + authors: Richard Barlow + url: https://srobo-legacy.gitbooks.io/student-robotics-kit-logistics/logistics-software.html +--- # Logistics Software To fulfil the multitude of responsibilities, the Kit Logistics Coordinator uses various pieces of custom software. The software projects used and maintained by the Kit Logistics Coordinator are listed below. diff --git a/docs/kit/logistics/post-handling.md b/docs/kit/logistics/post-handling.md index 392008a2..d11b36ba 100644 --- a/docs/kit/logistics/post-handling.md +++ b/docs/kit/logistics/post-handling.md @@ -1,3 +1,8 @@ +--- +original: + authors: Richard Barlow + url: https://srobo-legacy.gitbooks.io/student-robotics-kit-logistics/post-handling.html +--- # Post Handling These are the procedures related to the Kit Logistics Coordinator's post handing responsibilities. diff --git a/docs/kit/logistics/research.md b/docs/kit/logistics/research.md index f1e99f66..7b4dd739 100644 --- a/docs/kit/logistics/research.md +++ b/docs/kit/logistics/research.md @@ -1,3 +1,8 @@ +--- +original: + authors: Richard Barlow + url: https://srobo-legacy.gitbooks.io/student-robotics-kit-logistics/research.html +--- # Research The following sections document various bits of research that have been carried out by the Kit Logistics Coordinator while fulfilling their responsibilities. diff --git a/docs/kit/logistics/transport/couriers.md b/docs/kit/logistics/transport/couriers.md index f19f1c5c..30ec3f1e 100644 --- a/docs/kit/logistics/transport/couriers.md +++ b/docs/kit/logistics/transport/couriers.md @@ -1,3 +1,8 @@ +--- +original: + authors: Richard Barlow + url: https://srobo-legacy.gitbooks.io/student-robotics-kit-logistics/kit-transport/couriers.html +--- # Couriers We have confirmed that the following couriers are happy handling packages containing lithium polymer batteries: diff --git a/docs/kit/logistics/transport/packaging.md b/docs/kit/logistics/transport/packaging.md index 1f56eaf9..b27d8019 100644 --- a/docs/kit/logistics/transport/packaging.md +++ b/docs/kit/logistics/transport/packaging.md @@ -1,3 +1,8 @@ +--- +original: + authors: Richard Barlow + url: https://srobo-legacy.gitbooks.io/student-robotics-kit-logistics/kit-transport/packaging.html +--- # Packaging This information on packaging of kits and kit parts is for internal use only. The Kit Logistics Coordinator will use this information to instruct volunteers and third parties as necessary. diff --git a/docs/kit/logistics/transport/procedures.md b/docs/kit/logistics/transport/procedures.md index fbc99041..d4ef3b92 100644 --- a/docs/kit/logistics/transport/procedures.md +++ b/docs/kit/logistics/transport/procedures.md @@ -1,3 +1,8 @@ +--- +original: + authors: Richard Barlow + url: https://srobo-legacy.gitbooks.io/student-robotics-kit-logistics/kit-transport/procedures.html +--- # Procedures These are the procedures that the Kit Logistics Coordinator follows to perform their Kit Shipping responsibilities. No one else is expected to follow these procedures, they are for internal documentation only. From 6fb81a0a5e6160924823ec8f2a32596285e15b18 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sun, 28 Apr 2019 19:45:27 +0100 Subject: [PATCH 089/106] Update the url to the canonical inventory --- docs/kit/logistics/logistics-software.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/kit/logistics/logistics-software.md b/docs/kit/logistics/logistics-software.md index f61a7392..665c6ffe 100644 --- a/docs/kit/logistics/logistics-software.md +++ b/docs/kit/logistics/logistics-software.md @@ -12,4 +12,4 @@ To fulfil the multitude of responsibilities, the Kit Logistics Coordinator uses | Name | Project URL | Notes | | --- | --- | --- | | Inventory Tools | [https://www.studentrobotics.org/cgit/tools.git/](https://www.studentrobotics.org/cgit/tools.git/) | This project currently contains a mishmash of tools. The Inventory tools need teasing out. | -| Inventory | [https://www.studentrobotics.org/cgit/inventory.git/](https://www.studentrobotics.org/cgit/inventory.git/) | This is not a software project in itself. It represents the current state of all SR assets. | +| Inventory | [https://github.com/srobo/inventory](https://github.com/srobo/inventory) | This is not a software project in itself. It represents the current state of all SR assets. | From 8edde3d986c254c6bc629a7373eb6d99782617fe Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sun, 28 Apr 2019 20:20:49 +0100 Subject: [PATCH 090/106] Drop explicit heading ids interpretted as comments It looks like these blocks were previously explicit ids for headings, however Jinja 2 interprets them as partial comment blocks and complains loudly. Since the implicit heading ids will be the same as these anyway, we can just drop them. --- docs/kit/logistics/asset-tracking.md | 16 ++++++++-------- docs/kit/logistics/research.md | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/kit/logistics/asset-tracking.md b/docs/kit/logistics/asset-tracking.md index 25972c70..62230c89 100644 --- a/docs/kit/logistics/asset-tracking.md +++ b/docs/kit/logistics/asset-tracking.md @@ -51,7 +51,7 @@ graph LR decommission-->disposal {% endmermaid %} -#### Creation {#creation} +#### Creation When an asset is purchased or manufactured, a record must be entered into the Inventory. At this point a new asset code is automatically generated. The asset code **must** be marked onto the asset[^2]. The asset code can be marked in the following ways: @@ -65,7 +65,7 @@ More than one of the above techniques can be used to provide redundancy. The ideal marking solution is both human and machine readable and should be durable. These criteria should be considered when deciding how to mark a particular asset. Programming the asset code onto the asset, where possible, provides a very high level of durability as there is no label or pen that can be damaged; However one has to physically plug a cable in to read the code. QR codes and barcodes have the advantage that physical contact with the asset is not required, but they do require the asset to be visible. UHF RFID tags provide the added benefit of allowing the asset code to be read even when they are not visible; for instance when it is in a box. -#### Commission {#commission} +#### Commission Some assets will require commissioning after they have been added to the Inventory. This can be best explained with an example: When a newly manufactured motor board is added to the Inventory it is yet to be programmed or fully tested (although it may have had some basic end-of-line testing performed upon it). Once it has been added to the Inventory, in the *Creation* stage, it is ready to be programmed and tested before being used. This initial programming and testing of the motor board is part of its *commissioning* process. @@ -73,29 +73,29 @@ Not all assets will require commissioning. Generally these are things such as US Once an asset has been commissioned, its physical and functional condition must be updated appropriately in its record. In the case of assets that do not require any special commissioning procedure to be carried out, it should be assumed that they are both physically and functionally working and their records updated as such. -#### Use {#use} +#### Use Once an asset has been commissioned, or has been tested and shown to be working, it is ready to be used for its intended purpose. For the majority of assets this means that it will become part of a kit and ultimately be used by a team. During the *use* stage of an assets lifetime the majority of the updates to its record in the Inventory will be to keep track of its physical location; for example with a particular team. Occasionally there may also be other updates to its record required, such as adding a note to its description. -#### Test {#test} +#### Test The Inventory should, as far as is possible, represent the current state of all assets. However as time passes, the recorded physical and functional condition of a given asset will diverge from reality. To help rectify this, assets are regularly tested. For most assets this occurs once each year at the Kit Collation Event, run by the Hardware Production Coordinator. **TODO: Link to HPC docs.** Assets that have been repaired or modified must also undergo testing. As in the *commission* stage, an asset's physical and functional condition must be updated appropriately in its record once it has been tested. If the asset is in full working order it is ready for use. If the asset is broken then it may be possible to repair it. In some situations it is either not cost effective or not possible to repair an asset. When this occurs, the asset is no longer useful to SR and will be *decommissioned* and *disposed* of. -#### Repair {#repair} +#### Repair If an asset is found to be broken, it may be possible to repair it. An example of this is a motor board that has a cracked case. It is trivial to replace the broken parts of the case and therefore allow the motor board to once again be used (after being retested). -#### Modify {#modify} +#### Modify Throughout the lifetime of an asset it may be necessary to perform modifications to it. This may be to add extra functionality, improve reliability or to fix a known problem. For most assets the opportunity to perform these modifications is at the Kit Collation Event, run by the Hardware Production Coordinator. If modifications are required they will perform them as necessary. When modifications are made to an asset it is important to track the changes in its Inventory record. These generally take the form of *modification flags* that indicate if a particular asset has been modified. If a modification across all assets of a given type is planed, for example soldering on an extra component to all motor boards, then all motor board Inventory records should be updated to indicate that none of them have received the modification. Once each asset is modified, its Inventory record must be updated appropriately. -#### Decommission {#decommission} +#### Decommission If an asset is broken and unrepairable or if an asset is simply no longer required then it must be decommissioned and then disposed of. The Kit Logistics Coordinator must only decommission and dispose of an asset when explicitly instructed to do so by the person responsible for the asset. **TODO: Define who is responsible for each type of asset** @@ -105,7 +105,7 @@ For assets that are to be sold or given to a third party all SR logos and 'prope Once an asset has been fully decommissioned its Inventory record must be updated with a *modification flag* that indicates that it has been decommissioned. -#### Disposal {#disposal} +#### Disposal Once an asset has been decommissioned, it must be either sold/given away or thrown away, depending upon what was previously agreed when starting the decommissioning process. diff --git a/docs/kit/logistics/research.md b/docs/kit/logistics/research.md index 7b4dd739..86a7902d 100644 --- a/docs/kit/logistics/research.md +++ b/docs/kit/logistics/research.md @@ -7,7 +7,7 @@ original: The following sections document various bits of research that have been carried out by the Kit Logistics Coordinator while fulfilling their responsibilities. -## Return Shipping Bag {#return-shipping-bag} +## Return Shipping Bag | Size \(mm\) | Actual size \(mm\) | 18l RUB fit | 9l RUB \(non-XL\) fit | | --- | --- | --- | --- | From 358838669efbc556f9190058d3d27ddbda2306fe Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sun, 28 Apr 2019 21:35:46 +0100 Subject: [PATCH 091/106] Support mermaid based graphs --- Pipfile | 2 ++ Pipfile.lock | 22 +++++++++++++++++++++- docs/kit/logistics/asset-tracking.md | 4 ++-- mkdocs.yml | 13 ++++++++++--- 4 files changed, 35 insertions(+), 6 deletions(-) diff --git a/Pipfile b/Pipfile index 92b24cc7..3edf5835 100644 --- a/Pipfile +++ b/Pipfile @@ -12,6 +12,8 @@ pymdown-extensions = "*" mdx-include = "*" yamllint = "*" mkdocs-markdownextradata-plugin = "*" +mkdocs-mermaid-plugin = {git = "https://github.com/PeterJCLaw/mkdocs-mermaid-plugin",ref = "python-3"} +beautifulsoup4 = "*" [requires] python_version = "3" diff --git a/Pipfile.lock b/Pipfile.lock index 1a1b1d11..924a3be3 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "6c4a8328ad57f41f512fc2074af0ed1289739efa04506c6360c5c7b41fc56685" + "sha256": "c8236ff5987aa198bcb48698f6edbe72defdd6423f467932d79b38278133976c" }, "pipfile-spec": 6, "requires": { @@ -16,6 +16,15 @@ ] }, "default": { + "beautifulsoup4": { + "hashes": [ + "sha256:034740f6cb549b4e932ae1ab975581e6103ac8f942200a0e9759065984391858", + "sha256:945065979fb8529dd2f37dbb58f00b661bdbcbebf954f93b32fdf5263ef35348", + "sha256:ba6d5c59906a85ac23dadfe5c88deaf3e179ef565f4898671253e50a78680718" + ], + "index": "pypi", + "version": "==4.7.1" + }, "click": { "hashes": [ "sha256:2335065e6395b9e67ca716de5f7526736bfa6ceead690adf616d925bdc622b13", @@ -115,6 +124,10 @@ "index": "pypi", "version": "==4.1.1" }, + "mkdocs-mermaid-plugin": { + "git": "https://github.com/PeterJCLaw/mkdocs-mermaid-plugin", + "ref": "f010e161ed698e189a4f16a372c8996d72e0d47d" + }, "pathspec": { "hashes": [ "sha256:54a5eab895d89f342b52ba2bffe70930ef9f8d96e398cccf530d21fa0516a873" @@ -166,6 +179,13 @@ ], "version": "==1.12.0" }, + "soupsieve": { + "hashes": [ + "sha256:6898e82ecb03772a0d82bd0d0a10c0d6dcc342f77e0701d0ec4a8271be465ece", + "sha256:b20eff5e564529711544066d7dc0f7661df41232ae263619dede5059799cdfca" + ], + "version": "==1.9.1" + }, "tornado": { "hashes": [ "sha256:1174dcb84d08887b55defb2cda1986faeeea715fff189ef3dc44cce99f5fca6b", diff --git a/docs/kit/logistics/asset-tracking.md b/docs/kit/logistics/asset-tracking.md index 62230c89..be08df7f 100644 --- a/docs/kit/logistics/asset-tracking.md +++ b/docs/kit/logistics/asset-tracking.md @@ -27,7 +27,7 @@ Only property of SR is tracked in the Inventory; meaning that property of third For each asset that SR owns there is a reasonably well defined sequence of stages that it flows through during its lifetime. This flow is shown in the diagram below. -{% mermaid %} +```mermaid graph LR create(Creation) commission(Commission) @@ -49,7 +49,7 @@ graph LR test-->decommission repair-->test decommission-->disposal -{% endmermaid %} +``` #### Creation diff --git a/mkdocs.yml b/mkdocs.yml index f12379a7..43b5ddf6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,11 +32,18 @@ extra: - type: twitter link: https://twitter.com/studentrobotics +extra_javascript: + - https://unpkg.com/mermaid@7.1.2/dist/mermaid.min.js + # Extensions markdown_extensions: + # Note: the markdownmermaid plugin doesn't work properly if we enable either + # of the following extensions, so we keep them disabled. If we turn out to + # need code blocks in this project, we can re-evaluate this then. + # - markdown.extensions.codehilite + # - pymdownx.superfences + - markdown.extensions.admonition - - markdown.extensions.codehilite: - guess_lang: false - markdown.extensions.def_list - markdown.extensions.toc: permalink: true @@ -52,7 +59,6 @@ markdown_extensions: - pymdownx.mark - pymdownx.progressbar - pymdownx.smartsymbols - - pymdownx.superfences - pymdownx.tasklist: custom_checkbox: true - pymdownx.tilde @@ -63,3 +69,4 @@ markdown_extensions: plugins: - search - markdownextradata + - markdownmermaid From 929e879e5ac81324245f3b6ad2d701e997a11d5a Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sun, 28 Apr 2019 21:37:38 +0100 Subject: [PATCH 092/106] Enable support for footnotes The kit logistics docs use these in a bunch of places. --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index 43b5ddf6..5b353e25 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -43,6 +43,7 @@ markdown_extensions: # - markdown.extensions.codehilite # - pymdownx.superfences + - footnotes - markdown.extensions.admonition - markdown.extensions.def_list - markdown.extensions.toc: From af996e1840882363889b8a8ec8150089ed204437 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sun, 28 Apr 2019 21:38:48 +0100 Subject: [PATCH 093/106] Simplify heading --- docs/kit/logistics/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/kit/logistics/README.md b/docs/kit/logistics/README.md index df07361c..16627fc0 100644 --- a/docs/kit/logistics/README.md +++ b/docs/kit/logistics/README.md @@ -3,7 +3,7 @@ original: authors: Richard Barlow url: https://srobo-legacy.gitbooks.io/student-robotics-kit-logistics --- -# Student Robotics Kit Logistics Documentation +# Kit Logistics Documentation This is the documentation of the Student Robotics Kit Logistics Coordinator. It is primarily for internal use, but may be of interest to others. If you are in a team competing in Student Robotics, you probably want the [Docs](https://www.studentrobotics.org/docs). From 4a463b641c9c377612226e2cbe37fd21fc6f5c36 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sun, 28 Apr 2019 21:39:15 +0100 Subject: [PATCH 094/106] Drop redundant sentence --- docs/kit/logistics/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/kit/logistics/README.md b/docs/kit/logistics/README.md index 16627fc0..ef05b09d 100644 --- a/docs/kit/logistics/README.md +++ b/docs/kit/logistics/README.md @@ -5,7 +5,7 @@ original: --- # Kit Logistics Documentation -This is the documentation of the Student Robotics Kit Logistics Coordinator. It is primarily for internal use, but may be of interest to others. If you are in a team competing in Student Robotics, you probably want the [Docs](https://www.studentrobotics.org/docs). +This is the documentation of the Student Robotics Kit Logistics Coordinator. The responsibilities of the Kit Logistics Coordinator are as follows: From a1f2ab25f8afd7018ef7632b2717743829c699e3 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Wed, 1 May 2019 20:48:59 +0100 Subject: [PATCH 095/106] Improve linking to the inventory tooling --- docs/kit/logistics/asset-tracking.md | 4 +++- docs/kit/logistics/logistics-software.md | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/kit/logistics/asset-tracking.md b/docs/kit/logistics/asset-tracking.md index be08df7f..682e625a 100644 --- a/docs/kit/logistics/asset-tracking.md +++ b/docs/kit/logistics/asset-tracking.md @@ -7,7 +7,9 @@ original: One of the responsibilities of the Kit Logistics Coordinator is to maintain a record of the location and state of all SRs assets. This is generally referred to as asset tracking. To allow SR to operate it is important that the location and state of all of its assets are known at all times. -This chapter documents the high-level organisation aspects around SR asset tracking. It is not intended as a comprehensive user manual for the Inventory system, but rather how SR uses the system to track its assets. **TODO: link to user manual/docs** +This chapter documents the high-level organisation aspects around SR asset tracking. It is not intended as a comprehensive user manual for the Inventory system, but rather how SR uses the system to track its assets. + +See the page on [logistics-software](./logistics-software.md) for details of the inventory's datastore and tooling required to use it. ## The Inventory diff --git a/docs/kit/logistics/logistics-software.md b/docs/kit/logistics/logistics-software.md index 665c6ffe..2ebd0c2f 100644 --- a/docs/kit/logistics/logistics-software.md +++ b/docs/kit/logistics/logistics-software.md @@ -11,5 +11,5 @@ To fulfil the multitude of responsibilities, the Kit Logistics Coordinator uses | Name | Project URL | Notes | | --- | --- | --- | -| Inventory Tools | [https://www.studentrobotics.org/cgit/tools.git/](https://www.studentrobotics.org/cgit/tools.git/) | This project currently contains a mishmash of tools. The Inventory tools need teasing out. | +| Inventory Tools | [https://www.studentrobotics.org/cgit/tools.git/](https://www.studentrobotics.org/cgit/tools.git/) | This project currently contains a mishmash of tools. The Inventory tools need teasing out. See https://srtools.readthedocs.io/en/latest/inventory/ for details of the inventory related commands | | Inventory | [https://github.com/srobo/inventory](https://github.com/srobo/inventory) | This is not a software project in itself. It represents the current state of all SR assets. | From 53b454f761a9ab01c516251ab49298b56e951838 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Wed, 1 May 2019 20:52:26 +0100 Subject: [PATCH 096/106] Expand LTC --- docs/kit/logistics/transport/packaging.md | 4 ++-- docs/kit/logistics/transport/procedures.md | 16 ++++++++-------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/kit/logistics/transport/packaging.md b/docs/kit/logistics/transport/packaging.md index b27d8019..0d6ab260 100644 --- a/docs/kit/logistics/transport/packaging.md +++ b/docs/kit/logistics/transport/packaging.md @@ -37,7 +37,7 @@ When teams have to return a kit to us we provide them with a return shipping pac ### Instruction Notes -1. Check all parts are present \(use list provided and notify LTC of any missing items\). +1. Check all parts are present \(use list provided and notify the local teams co-ordinator of any missing items\). 2. Place parts into jiffy bags \(do not seal unless specified\): 1. Large white **\[photo of four bags with the parts in front\]:** 1. 1x tablet @@ -60,4 +60,4 @@ When teams have to return a kit to us we provide them with a return shipping pac 11. Stick the LiPo sticker onto the bag 12. Place the supplied shipping label into the document wallet and stick the document wallet onto the bag \(don't forget to remove the narrow backing strip too\) **\[photo of lipo sticker and shipping label in document wallet\]**. 13. Hand the package to reception/who ever it will be collected from. -14. Notify your LTC that the kit is ready for collection. +14. Notify your local teams co-ordinator that the kit is ready for collection. diff --git a/docs/kit/logistics/transport/procedures.md b/docs/kit/logistics/transport/procedures.md index d4ef3b92..a5df6c90 100644 --- a/docs/kit/logistics/transport/procedures.md +++ b/docs/kit/logistics/transport/procedures.md @@ -36,10 +36,10 @@ After Kickstart, request scanned copies of the handout form and disclaimers from The operations manual currently requires that the Kit Logistics Coordinator ensures that kits are available to be collected by a courier no later than 2 week after Kickstart. -Begin by requesting the following information from the Team Coordinator for the teams that didn't attend a Kickstart and ask them to confirm that the details are correct via the appropriate LTC: +Begin by requesting the following information from the Team Coordinator for the teams that didn't attend a Kickstart and ask them to confirm that the details are correct via the appropriate local teams co-ordinator: -* Name of LTC -* Email of LTC \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) +* Name of local teams co-ordinator +* Email of local teams co-ordinator \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) * Name of recipient * Email of recipient * Phone number of recipient \(ideally a mobile number as that's what couriers prefer\) @@ -55,7 +55,7 @@ For each team that needs a kit: 1. Identify the kit to be shipped in the Inventory and move it to an appropriate `in-transit` sub directory \(e.g. `in-transit/to-srz`\). 2. Once the details have been confirmed, instruct UK Postbox to forward the correct item to the team. -3. Once UK Postbox have forwarded on the kit, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. +3. Once UK Postbox have forwarded on the kit, email the local teams co-ordinator with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. 4. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). ## Managing kits not collected at Kickstart @@ -74,10 +74,10 @@ We need to ship kits from one team to another when a team drops out. TBD. When parts of the kit break teams need replacements. The Kit Logistics Coordinator needs to ship these spares/replacements to teams when instructed to do so by the Kit Support Coordinator. -Begin by requesting the following information from the Team Coordinator for the team that needs replacement parts shipping to them and ask them to confirm that the details are correct via the appropriate LTC: +Begin by requesting the following information from the Team Coordinator for the team that needs replacement parts shipping to them and ask them to confirm that the details are correct via the appropriate local teams co-ordinator: -* Name of LTC -* Email of LTC \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) +* Name of local teams co-ordinator +* Email of local teams co-ordinator \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) * Name of recipient * Email of recipient * Phone number of recipient \(ideally a mobile number as that's what couriers prefer\) @@ -96,7 +96,7 @@ Begin by requesting the following information from the Team Coordinator for the * Once the details have been confirmed, arrange for the package to be collected from yourself and delivered to the team. -* Once you have the tracking number from the courier, email the LTC with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. +* Once you have the tracking number from the courier, email the local teams co-ordinator with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. * Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). From 782420c665c27ef831f6f7da36653f0b0dd092fb Mon Sep 17 00:00:00 2001 From: Peter Law Date: Wed, 1 May 2019 20:55:46 +0100 Subject: [PATCH 097/106] Slightly improve formatting --- docs/kit/logistics/logistics-software.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/kit/logistics/logistics-software.md b/docs/kit/logistics/logistics-software.md index 2ebd0c2f..e9aca4aa 100644 --- a/docs/kit/logistics/logistics-software.md +++ b/docs/kit/logistics/logistics-software.md @@ -9,7 +9,7 @@ To fulfil the multitude of responsibilities, the Kit Logistics Coordinator uses ## Software Projects -| Name | Project URL | Notes | -| --- | --- | --- | +| Name | Project URL | Notes | +| --------------- | ----------- | ----- | | Inventory Tools | [https://www.studentrobotics.org/cgit/tools.git/](https://www.studentrobotics.org/cgit/tools.git/) | This project currently contains a mishmash of tools. The Inventory tools need teasing out. See https://srtools.readthedocs.io/en/latest/inventory/ for details of the inventory related commands | -| Inventory | [https://github.com/srobo/inventory](https://github.com/srobo/inventory) | This is not a software project in itself. It represents the current state of all SR assets. | +| Inventory | [https://github.com/srobo/inventory](https://github.com/srobo/inventory) | This is not a software project in itself. It represents the current state of all SR assets. | From 1d8d349a9c71de639bb45bb309916b1cc18f4a64 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Wed, 1 May 2019 20:58:18 +0100 Subject: [PATCH 098/106] Prefer non-hyphenated coordinators --- docs/kit/logistics/transport/packaging.md | 4 ++-- docs/kit/logistics/transport/procedures.md | 16 ++++++++-------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/kit/logistics/transport/packaging.md b/docs/kit/logistics/transport/packaging.md index 0d6ab260..6d131e70 100644 --- a/docs/kit/logistics/transport/packaging.md +++ b/docs/kit/logistics/transport/packaging.md @@ -37,7 +37,7 @@ When teams have to return a kit to us we provide them with a return shipping pac ### Instruction Notes -1. Check all parts are present \(use list provided and notify the local teams co-ordinator of any missing items\). +1. Check all parts are present \(use list provided and notify the local teams coordinator of any missing items\). 2. Place parts into jiffy bags \(do not seal unless specified\): 1. Large white **\[photo of four bags with the parts in front\]:** 1. 1x tablet @@ -60,4 +60,4 @@ When teams have to return a kit to us we provide them with a return shipping pac 11. Stick the LiPo sticker onto the bag 12. Place the supplied shipping label into the document wallet and stick the document wallet onto the bag \(don't forget to remove the narrow backing strip too\) **\[photo of lipo sticker and shipping label in document wallet\]**. 13. Hand the package to reception/who ever it will be collected from. -14. Notify your local teams co-ordinator that the kit is ready for collection. +14. Notify your local teams coordinator that the kit is ready for collection. diff --git a/docs/kit/logistics/transport/procedures.md b/docs/kit/logistics/transport/procedures.md index a5df6c90..c3231924 100644 --- a/docs/kit/logistics/transport/procedures.md +++ b/docs/kit/logistics/transport/procedures.md @@ -36,10 +36,10 @@ After Kickstart, request scanned copies of the handout form and disclaimers from The operations manual currently requires that the Kit Logistics Coordinator ensures that kits are available to be collected by a courier no later than 2 week after Kickstart. -Begin by requesting the following information from the Team Coordinator for the teams that didn't attend a Kickstart and ask them to confirm that the details are correct via the appropriate local teams co-ordinator: +Begin by requesting the following information from the Team Coordinator for the teams that didn't attend a Kickstart and ask them to confirm that the details are correct via the appropriate local teams coordinator: -* Name of local teams co-ordinator -* Email of local teams co-ordinator \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) +* Name of local teams coordinator +* Email of local teams coordinator \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) * Name of recipient * Email of recipient * Phone number of recipient \(ideally a mobile number as that's what couriers prefer\) @@ -55,7 +55,7 @@ For each team that needs a kit: 1. Identify the kit to be shipped in the Inventory and move it to an appropriate `in-transit` sub directory \(e.g. `in-transit/to-srz`\). 2. Once the details have been confirmed, instruct UK Postbox to forward the correct item to the team. -3. Once UK Postbox have forwarded on the kit, email the local teams co-ordinator with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. +3. Once UK Postbox have forwarded on the kit, email the local teams coordinator with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. 4. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). ## Managing kits not collected at Kickstart @@ -74,10 +74,10 @@ We need to ship kits from one team to another when a team drops out. TBD. When parts of the kit break teams need replacements. The Kit Logistics Coordinator needs to ship these spares/replacements to teams when instructed to do so by the Kit Support Coordinator. -Begin by requesting the following information from the Team Coordinator for the team that needs replacement parts shipping to them and ask them to confirm that the details are correct via the appropriate local teams co-ordinator: +Begin by requesting the following information from the Team Coordinator for the team that needs replacement parts shipping to them and ask them to confirm that the details are correct via the appropriate local teams coordinator: -* Name of local teams co-ordinator -* Email of local teams co-ordinator \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) +* Name of local teams coordinator +* Email of local teams coordinator \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) * Name of recipient * Email of recipient * Phone number of recipient \(ideally a mobile number as that's what couriers prefer\) @@ -96,7 +96,7 @@ Begin by requesting the following information from the Team Coordinator for the * Once the details have been confirmed, arrange for the package to be collected from yourself and delivered to the team. -* Once you have the tracking number from the courier, email the local teams co-ordinator with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. +* Once you have the tracking number from the courier, email the local teams coordinator with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. * Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). From e9307a991f12e245d7284c7ada0253dbfe542405 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Wed, 1 May 2019 21:00:32 +0100 Subject: [PATCH 099/106] Interlinking is good --- docs/kit/logistics/asset-tracking.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/kit/logistics/asset-tracking.md b/docs/kit/logistics/asset-tracking.md index 682e625a..a3ee1630 100644 --- a/docs/kit/logistics/asset-tracking.md +++ b/docs/kit/logistics/asset-tracking.md @@ -83,10 +83,13 @@ During the *use* stage of an assets lifetime the majority of the updates to its #### Test -The Inventory should, as far as is possible, represent the current state of all assets. However as time passes, the recorded physical and functional condition of a given asset will diverge from reality. To help rectify this, assets are regularly tested. For most assets this occurs once each year at the Kit Collation Event, run by the Hardware Production Coordinator. **TODO: Link to HPC docs.** Assets that have been repaired or modified must also undergo testing. +The Inventory should, as far as is possible, represent the current state of all assets. However as time passes, the recorded physical and functional condition of a given asset will diverge from reality. To help rectify this, assets are regularly tested. For most assets this occurs once each year at the [Kit Collation Event][kit-collation-event], run by the [Hardware Production Coordinator][hardware]. Assets that have been repaired or modified must also undergo testing. As in the *commission* stage, an asset's physical and functional condition must be updated appropriately in its record once it has been tested. If the asset is in full working order it is ready for use. If the asset is broken then it may be possible to repair it. In some situations it is either not cost effective or not possible to repair an asset. When this occurs, the asset is no longer useful to SR and will be *decommissioned* and *disposed* of. +[kit-collation-event]: ../hardware/kit-collation.md +[hardware]: ../hardware/README.md + #### Repair If an asset is found to be broken, it may be possible to repair it. An example of this is a motor board that has a cracked case. It is trivial to replace the broken parts of the case and therefore allow the motor board to once again be used (after being retested). From b08970c654f358806c1a11ac7830616de8d3f36d Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sat, 11 May 2019 21:59:41 +0100 Subject: [PATCH 100/106] sr.tools is now on GitHub Co-Authored-By: Jake Howard --- docs/kit/logistics/logistics-software.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/kit/logistics/logistics-software.md b/docs/kit/logistics/logistics-software.md index e9aca4aa..4cc97db4 100644 --- a/docs/kit/logistics/logistics-software.md +++ b/docs/kit/logistics/logistics-software.md @@ -11,5 +11,5 @@ To fulfil the multitude of responsibilities, the Kit Logistics Coordinator uses | Name | Project URL | Notes | | --------------- | ----------- | ----- | -| Inventory Tools | [https://www.studentrobotics.org/cgit/tools.git/](https://www.studentrobotics.org/cgit/tools.git/) | This project currently contains a mishmash of tools. The Inventory tools need teasing out. See https://srtools.readthedocs.io/en/latest/inventory/ for details of the inventory related commands | +| Inventory Tools | [https://github.com/srobo/tools/](https://github.com/srobo/tools/) | This project currently contains a mishmash of tools. The Inventory tools need teasing out. See https://srtools.readthedocs.io/en/latest/inventory/ for details of the inventory related commands | | Inventory | [https://github.com/srobo/inventory](https://github.com/srobo/inventory) | This is not a software project in itself. It represents the current state of all SR assets. | From 376c7ecf4e162069c96faeead8b8d68830b17117 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Mon, 26 Aug 2019 16:13:20 +0100 Subject: [PATCH 101/106] mkdocs-mermaid-plugin's Python 3 support is now merged upstream Still not on PyPI though :( (https://github.com/pugong/mkdocs-mermaid-plugin/issues/5) --- Pipfile | 2 +- Pipfile.lock | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Pipfile b/Pipfile index 3edf5835..d94d362d 100644 --- a/Pipfile +++ b/Pipfile @@ -12,7 +12,7 @@ pymdown-extensions = "*" mdx-include = "*" yamllint = "*" mkdocs-markdownextradata-plugin = "*" -mkdocs-mermaid-plugin = {git = "https://github.com/PeterJCLaw/mkdocs-mermaid-plugin",ref = "python-3"} +mkdocs-mermaid-plugin = {git = "https://github.com/pugong/mkdocs-mermaid-plugin"} beautifulsoup4 = "*" [requires] diff --git a/Pipfile.lock b/Pipfile.lock index 924a3be3..0e287ffe 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -125,8 +125,8 @@ "version": "==4.1.1" }, "mkdocs-mermaid-plugin": { - "git": "https://github.com/PeterJCLaw/mkdocs-mermaid-plugin", - "ref": "f010e161ed698e189a4f16a372c8996d72e0d47d" + "git": "https://github.com/pugong/mkdocs-mermaid-plugin", + "ref": "abf14392b0ed0c7022210b32c4e7c9c3e4c5c68a" }, "pathspec": { "hashes": [ From 7defe3f8da12fc875ff0e734f98fa64aa32099b7 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Mon, 26 Aug 2019 16:15:20 +0100 Subject: [PATCH 102/106] Remove indirect dependency we don't need to duplicate mkdocs-mermaid-plugin now includes this itself. --- Pipfile | 1 - 1 file changed, 1 deletion(-) diff --git a/Pipfile b/Pipfile index d94d362d..440626cd 100644 --- a/Pipfile +++ b/Pipfile @@ -13,7 +13,6 @@ mdx-include = "*" yamllint = "*" mkdocs-markdownextradata-plugin = "*" mkdocs-mermaid-plugin = {git = "https://github.com/pugong/mkdocs-mermaid-plugin"} -beautifulsoup4 = "*" [requires] python_version = "3" From 37b11417c8435b21b32e2c05b77644d629236f44 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Mon, 26 Aug 2019 17:25:15 +0100 Subject: [PATCH 103/106] Remove link to external original logistics docs --- docs/kit/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/kit/README.md b/docs/kit/README.md index 81c4ecc3..dd059fc8 100644 --- a/docs/kit/README.md +++ b/docs/kit/README.md @@ -12,7 +12,7 @@ This is the Kit Coordinator's documentation. The Kit Coordinator is responsible Role | Volunteer | Location of Documentation ------|---------------|---------------------------- Kit Software Coordinator | Richard Barlow | [Docs](/kit/software) -Kit Logistics Coordinator | Richard Barlow | [Docs](https://www.gitbook.com/read/book/srobo-legacy/student-robotics-kit-logistics) +Kit Logistics Coordinator | Richard Barlow | [Docs](/kit/logistics) Kit Support Coordinator | Richard Barlow | [Docs](/kit/support) Hardware Development Coordinator | [unfilled] | Hardware Production Coordinator | Richard Barlow | [Docs](/hw-prod-coord) From 2d8e00d4b142daa0b91bc775324c51ac7bfedc1a Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sat, 31 Aug 2019 14:25:15 +0100 Subject: [PATCH 104/106] Fix typo Co-Authored-By: Kier Davis --- docs/kit/logistics/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/kit/logistics/README.md b/docs/kit/logistics/README.md index ef05b09d..56c4edfe 100644 --- a/docs/kit/logistics/README.md +++ b/docs/kit/logistics/README.md @@ -11,7 +11,7 @@ The responsibilities of the Kit Logistics Coordinator are as follows: * To store the kit * To manage the transportation/shipping of the kit -* To manage the organisation's third part post handling service +* To manage the organisation's third party post handling service * To maintain a record of the location and state of all Student Robotics assets To fulfil these responsibilities the Kit Logistics Coordinator also does the following From dcc4315fd7ea9978507c4c46c537dede3aa97483 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sat, 31 Aug 2019 15:03:12 +0100 Subject: [PATCH 105/106] No need to escape thes parens --- docs/kit/logistics/kit-transport.md | 2 +- docs/kit/logistics/research.md | 4 +- docs/kit/logistics/transport/couriers.md | 4 +- docs/kit/logistics/transport/packaging.md | 24 ++++++------ docs/kit/logistics/transport/procedures.md | 44 +++++++++++----------- 5 files changed, 39 insertions(+), 39 deletions(-) diff --git a/docs/kit/logistics/kit-transport.md b/docs/kit/logistics/kit-transport.md index 77cb0f5c..b7c2bd1b 100644 --- a/docs/kit/logistics/kit-transport.md +++ b/docs/kit/logistics/kit-transport.md @@ -5,7 +5,7 @@ original: --- # Kit Shipping -Part of the Kit Logistics Coordinator's responsibilities cover moving either whole or parts of kits around the UK and the world. This is generally referred to as shipping \(even though it rarely involves ships!\). All movement of kit is managed by the Kit Logistics Coordinator, so please do not ship anything without first speaking to them. You can contact them at: [logistics@studentrobotics.org](mailto:logistics@studentrobotics.org). +Part of the Kit Logistics Coordinator's responsibilities cover moving either whole or parts of kits around the UK and the world. This is generally referred to as shipping (even though it rarely involves ships!). All movement of kit is managed by the Kit Logistics Coordinator, so please do not ship anything without first speaking to them. You can contact them at: [logistics@studentrobotics.org](mailto:logistics@studentrobotics.org). Almost all shipping requirements happen at well defined points throughout the Student Robotics calendar. When kits or parts therefore need to be shipped specific procedures are followed as detailed in the [Procedures](./transport/procedures.md) chapter. diff --git a/docs/kit/logistics/research.md b/docs/kit/logistics/research.md index 86a7902d..dd186ad3 100644 --- a/docs/kit/logistics/research.md +++ b/docs/kit/logistics/research.md @@ -9,10 +9,10 @@ The following sections document various bits of research that have been carried ## Return Shipping Bag -| Size \(mm\) | Actual size \(mm\) | 18l RUB fit | 9l RUB \(non-XL\) fit | +| Size (mm) | Actual size (mm) | 18l RUB fit | 9l RUB (non-XL) fit | | --- | --- | --- | --- | | 425x600 | | \[untested\] | \[untested\]. I suspect that it will be good, but I need to get a sample bag. | | 525x600 | 524x610 | Does not fit | Fits easily with the box aligned with the bag. Is a tight, but comfortable, fit with the box sideways relative to the bag. It very nearly fits two boxes in sideways, but is a little too short. | -| 575x700 | 583x714 | Perfect easy fit with the box aligned with the bag | Easily fits two boxes either side-by-side or stacked \(preferred due to its rigidity\) | +| 575x700 | 583x714 | Perfect easy fit with the box aligned with the bag | Easily fits two boxes either side-by-side or stacked (preferred due to its rigidity) | | 600x900 | 600x900 | Easily fits with the box aligned with the bag | Easily fits three boxes. Two stacked and one on its side. It is not a particularly solid arrangement. | | 700x850 | 700x850 | Easily fits in both orientations | Fits four boxes, stacked, pretty much perfectly. | diff --git a/docs/kit/logistics/transport/couriers.md b/docs/kit/logistics/transport/couriers.md index 30ec3f1e..c0b0c07b 100644 --- a/docs/kit/logistics/transport/couriers.md +++ b/docs/kit/logistics/transport/couriers.md @@ -12,8 +12,8 @@ We have confirmed that the following couriers are happy handling packages contai Kit data for couriers: * Dimensions: 48cm x 39cm x 20cm -* Weight: 6kg \(A kit weighs 4.95kg [ref](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Kit Definition). 6kg gives some headroom\) -* Value \(for insurance\): £500 +* Weight: 6kg (A kit weighs 4.95kg [ref](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Kit Definition). 6kg gives some headroom) +* Value (for insurance): £500 * Batteries: Lithium Ion. Packed with equipment. Batteries less than 100Wh. In all circumstances a shipment of a kit must have at least £500 worth of insurance. diff --git a/docs/kit/logistics/transport/packaging.md b/docs/kit/logistics/transport/packaging.md index 6d131e70..079fadc6 100644 --- a/docs/kit/logistics/transport/packaging.md +++ b/docs/kit/logistics/transport/packaging.md @@ -9,13 +9,13 @@ This information on packaging of kits and kit parts is for internal use only. Th ## Packaging Info -* Kits should generally be shipped in the while 18l Really Useful Box \(RUB\). +* Kits should generally be shipped in the while 18l Really Useful Box (RUB). * All parts of the kit should be suitably protected either in Jiffy bags or bubble wrap. The Return Shipping Pack includes a new set of jiffy bags. * Batteries **must** be placed inside a small brown jiffy bag and the jiffy bag placed inside the charging bag. -* In general no more than two batteries should be shipped in each RUB \(to ease shipping restrictions\). +* In general no more than two batteries should be shipped in each RUB (to ease shipping restrictions). * Damaged batteries must not be shipped. * Any empty space in the box should be filled with paper or bubble wrap. No packing peanuts; They're messy. The Return Shipping Pack includes sufficient paper. -* The box should be sealed with cable ties and, if available high quality tape over the handles \(not selotape or insulating tape\). The Return Shipping Pack includes cables ties, but no tape \(as it's difficult to obtain a tiny roll of high quality tape\). +* The box should be sealed with cable ties and, if available high quality tape over the handles (not selotape or insulating tape). The Return Shipping Pack includes cables ties, but no tape (as it's difficult to obtain a tiny roll of high quality tape). ## Return Shipping Pack @@ -28,17 +28,17 @@ When teams have to return a kit to us we provide them with a return shipping pac | 112x80mm caution lithium ion battery label | 1 | [Limpet Labels](http://www.limpetlabels.co.uk/shop/view/293_Caution_Lithium_Battery_Labels/755_Caution_Lithium_Ion_Battery_Labels_%28112_x_80mm%29) | | | A6 plain document wallet | 2 | [UK Packaging ref 10008](http://www.ukpackaging.com/document-wallets-a6-document-enclosed-wallets-plain) | One to use for address label. One spare. | | 750mm wide kraft paper | 2m | [UK Packaging ref 11042](http://www.ukpackaging.com/kraft-paper-rolls-imitation-kraft-kraft-paper-rolls-imitation-kraft-750mmx220m) | | -| 120x215mm \(internal\) gold jiffy bag | 4 | [UK Packaging ref 09033](http://www.ukpackaging.com/arofol-classic-postal-bags-gold-2) | | -| 170x245mm \(internal\) white jiffy bag | 4 | [UK Packaging ref 09312](http://www.ukpackaging.com/jiffy-earth-aware-airkraft-white-ak1-170x245mm-50-pack) | | -| 220x320mm \(internal\) white jiffy bag | 1 | [UK Packaging ref 09314](http://www.ukpackaging.com/postal-packaging/jiffy-bags/jiffy-earth-aware-airkraft-white-ak3-220x320mm-50-pack) | To put the whole return shipping pack into. | +| 120x215mm (internal) gold jiffy bag | 4 | [UK Packaging ref 09033](http://www.ukpackaging.com/arofol-classic-postal-bags-gold-2) | | +| 170x245mm (internal) white jiffy bag | 4 | [UK Packaging ref 09312](http://www.ukpackaging.com/jiffy-earth-aware-airkraft-white-ak1-170x245mm-50-pack) | | +| 220x320mm (internal) white jiffy bag | 1 | [UK Packaging ref 09314](http://www.ukpackaging.com/postal-packaging/jiffy-bags/jiffy-earth-aware-airkraft-white-ak3-220x320mm-50-pack) | To put the whole return shipping pack into. | | Return shipping pack instructions | 1 | [Revision SR2017-2](https://github.com/srobo/return-shipping-pack/releases/download/SR2017-2/return-shipping-pack-instructions.pdf) | | | Loan extension instructions | 1 | [Revision SR2017-2](https://github.com/srobo/return-shipping-pack/releases/download/SR2017-2/loanext-instructions.pdf) | Only included in return shipping packs handed out at the end of the competition. | | Kit list | 1 | [Kit Definition](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Kit%20Definition) | Only included in return shipping packs handed out at the end of the competition. Remove 'disclaimer' and the wire from the list. | ### Instruction Notes -1. Check all parts are present \(use list provided and notify the local teams coordinator of any missing items\). -2. Place parts into jiffy bags \(do not seal unless specified\): +1. Check all parts are present (use list provided and notify the local teams coordinator of any missing items). +2. Place parts into jiffy bags (do not seal unless specified): 1. Large white **\[photo of four bags with the parts in front\]:** 1. 1x tablet 2. 1x battery charger @@ -48,16 +48,16 @@ When teams have to return a kit to us we provide them with a return shipping pac 1. 2x batteries 2. 2x motor boards, 1x ruggeduio with screw shields plugged in 3. 2x USB hubs, 1x brain board - 4. Remaining loose items: wifi dongles, usb memory stick, camcons \(7.5, 5 and 3.81mm\), screwdriver, brain board power cable. **seal**. + 4. Remaining loose items: wifi dongles, usb memory stick, camcons (7.5, 5 and 3.81mm), screwdriver, brain board power cable. **seal**. 3. Place jiffy bag containing the batteries into the battery charging bag **\[photo of jiffy bag partially in charging bag\]** 4. Tear the brown paper into two equally sized pieces 5. Scrunch up one piece of brown paper and place in the bottom of the RUB **\[photo of scrunched up paper in the bottom of RUB\]** -6. Place battery charging bag, jiffy bags and all cables \(full size USB, micro USB and any wire\) into the RUB **\[photo of stuff in RUB\]** +6. Place battery charging bag, jiffy bags and all cables (full size USB, micro USB and any wire) into the RUB **\[photo of stuff in RUB\]** 7. Scrunch up the other piece of brown paper and place on top of the stuff **\[photo of scrunched up paper on top\]** -8. Fit the lid onto the RUB and seal handles with four cable ties \(do not cut the cable ties as the sharp corners could tear the bag\) **\[photo of cable tie being threaded through, photo of loose cable tie, photo of complete handle demonstrating tail direction\]** +8. Fit the lid onto the RUB and seal handles with four cable ties (do not cut the cable ties as the sharp corners could tear the bag) **\[photo of cable tie being threaded through, photo of loose cable tie, photo of complete handle demonstrating tail direction\]** 9. Place the sealed RUB into the bag **\[photo of RUB partially in the bag\]** 10. Seal the bag closed **\[photo of the sealed bag highlighting it being tight\]** 11. Stick the LiPo sticker onto the bag -12. Place the supplied shipping label into the document wallet and stick the document wallet onto the bag \(don't forget to remove the narrow backing strip too\) **\[photo of lipo sticker and shipping label in document wallet\]**. +12. Place the supplied shipping label into the document wallet and stick the document wallet onto the bag (don't forget to remove the narrow backing strip too) **\[photo of lipo sticker and shipping label in document wallet\]**. 13. Hand the package to reception/who ever it will be collected from. 14. Notify your local teams coordinator that the kit is ready for collection. diff --git a/docs/kit/logistics/transport/procedures.md b/docs/kit/logistics/transport/procedures.md index c3231924..8638bb8c 100644 --- a/docs/kit/logistics/transport/procedures.md +++ b/docs/kit/logistics/transport/procedures.md @@ -11,26 +11,26 @@ These are the procedures that the Kit Logistics Coordinator follows to perform t To provide sufficient time for problems/delays, kits should be shipped to Kickstart locations no later than 1 week before Kickstart. Shipping the kits many weeks in advance may not be possible due to limited storage requirements at some Kickstart locations. -First ensure that the Kickstart Event Coordinator is aware of the paperwork requirements \(handout forms and disclaimers\). Request the following information from the Kickstart Event Coordinator: +First ensure that the Kickstart Event Coordinator is aware of the paperwork requirements (handout forms and disclaimers). Request the following information from the Kickstart Event Coordinator: * Name of Local Kickstart Event Coordinator * Email address of Local Kickstart Event Coordinator * Number of teams attending -* Name of person able to receive the kit \(if not the Local Kickstart Event Coordinator\) -* Email address of person able to receive the kit \(if not the Local Kickstart Event Coordinator\) +* Name of person able to receive the kit (if not the Local Kickstart Event Coordinator) +* Email address of person able to receive the kit (if not the Local Kickstart Event Coordinator) * Phone number of person able to receive the kit * Address to ship the kit to For each Kickstart: -1. Ensure that the Local Kickstart Event Coordinator, or the person that they are delegating kit management to, has received the necessary training \(to be defined\). -2. Identify the kits to be shipped in the Inventory and move them into an appropriate `in-transit` sub directory \(e.g. `in-transit/to-oxford-ks`\). +1. Ensure that the Local Kickstart Event Coordinator, or the person that they are delegating kit management to, has received the necessary training (to be defined). +2. Identify the kits to be shipped in the Inventory and move them into an appropriate `in-transit` sub directory (e.g. `in-transit/to-oxford-ks`). 3. Instruct UK Postbox to forward the correct items to the recipient. -4. Once UK Postbox have forwarded on the kits, email the LKEC and the recipient \(if not the LKEC\) with the tracking number/link and a list of kit asset numbers shipped to them. Ask them to report back when they have received the shipment and doubled checked that they have the expected kits. -5. Once the kits have been delivered, move them in the Inventory to an appropriate sub directory \(e.g. `kickstart-venues/oxford`\). +4. Once UK Postbox have forwarded on the kits, email the LKEC and the recipient (if not the LKEC) with the tracking number/link and a list of kit asset numbers shipped to them. Ask them to report back when they have received the shipment and doubled checked that they have the expected kits. +5. Once the kits have been delivered, move them in the Inventory to an appropriate sub directory (e.g. `kickstart-venues/oxford`). 6. Email details of what kits are where to the Kickstart Event Coordinator so that they can prepare handout forms for each of the Local Kickstart Event Coordinators. -After Kickstart, request scanned copies of the handout form and disclaimers from all of the Kickstarts from the Kickstart Event Coordinator \(who will then request them from the Local Kickstart Coordinators\). Move each kit into an appropriate sub directory in the Inventory based upon which team it was given to \(e.g. move a kit to `teams/2017/srz`\). +After Kickstart, request scanned copies of the handout form and disclaimers from all of the Kickstarts from the Kickstart Event Coordinator (who will then request them from the Local Kickstart Coordinators). Move each kit into an appropriate sub directory in the Inventory based upon which team it was given to (e.g. move a kit to `teams/2017/srz`). ## Shipping kits to teams that didn't attend a Kickstart @@ -39,13 +39,13 @@ The operations manual currently requires that the Kit Logistics Coordinator ensu Begin by requesting the following information from the Team Coordinator for the teams that didn't attend a Kickstart and ask them to confirm that the details are correct via the appropriate local teams coordinator: * Name of local teams coordinator -* Email of local teams coordinator \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) +* Email of local teams coordinator (so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator) * Name of recipient * Email of recipient -* Phone number of recipient \(ideally a mobile number as that's what couriers prefer\) +* Phone number of recipient (ideally a mobile number as that's what couriers prefer) * Address including: * School name - * Number \(if applicable\) + * Number (if applicable) * Street * Town/City * County @@ -53,18 +53,18 @@ Begin by requesting the following information from the Team Coordinator for the For each team that needs a kit: -1. Identify the kit to be shipped in the Inventory and move it to an appropriate `in-transit` sub directory \(e.g. `in-transit/to-srz`\). +1. Identify the kit to be shipped in the Inventory and move it to an appropriate `in-transit` sub directory (e.g. `in-transit/to-srz`). 2. Once the details have been confirmed, instruct UK Postbox to forward the correct item to the team. 3. Once UK Postbox have forwarded on the kit, email the local teams coordinator with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. -4. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). +4. Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory (e.g. `teams/2017/srz`). ## Managing kits not collected at Kickstart -Some teams may not turn up at Kickstart, therefore leaving their kit uncollected. This kit needs to either be stored safely by someone nearby or returned to UK Postbox. The kit will most likely make its way to a team \(either the originally intended recipient or otherwise\) in the week or two after Kickstart. +Some teams may not turn up at Kickstart, therefore leaving their kit uncollected. This kit needs to either be stored safely by someone nearby or returned to UK Postbox. The kit will most likely make its way to a team (either the originally intended recipient or otherwise) in the week or two after Kickstart. -If a responsible person in attendance at the Kickstart event \(for example the Local Kickstart Coordinator\) is willing to store the kit for a week or two, and is able to make it available for courier collection, then this is preferable. +If a responsible person in attendance at the Kickstart event (for example the Local Kickstart Coordinator) is willing to store the kit for a week or two, and is able to make it available for courier collection, then this is preferable. -If it is not possible to store the kit locally, it must be returned to UK Postbox ASAP. A [Return Shipping Pack](#return-shipping-pack) must be used to package the kit for return. Someone \(possibly the venue\) will need to make the kit available for courier collection in the day or two following Kickstart. +If it is not possible to store the kit locally, it must be returned to UK Postbox ASAP. A [Return Shipping Pack](#return-shipping-pack) must be used to package the kit for return. Someone (possibly the venue) will need to make the kit available for courier collection in the day or two following Kickstart. ## Reallocating kits from drop-outs @@ -77,20 +77,20 @@ When parts of the kit break teams need replacements. The Kit Logistics Coordinat Begin by requesting the following information from the Team Coordinator for the team that needs replacement parts shipping to them and ask them to confirm that the details are correct via the appropriate local teams coordinator: * Name of local teams coordinator -* Email of local teams coordinator \(so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator\) +* Email of local teams coordinator (so that any further queries and an email containing a tracking link doesn't have to go via the Team Coordinator) * Name of recipient * Email of recipient -* Phone number of recipient \(ideally a mobile number as that's what couriers prefer\) +* Phone number of recipient (ideally a mobile number as that's what couriers prefer) * Address including: * School name - * Number \(if applicable\) + * Number (if applicable) * Street * Town/City * County * Postcode -* Identify the replacement parts to be shipped in the Inventory \(as defined by the Kit Support Coordinator\) and move them to an appropriate `in-transit` sub directory \(e.g. `in-transit/to-srz`\). +* Identify the replacement parts to be shipped in the Inventory (as defined by the Kit Support Coordinator) and move them to an appropriate `in-transit` sub directory (e.g. `in-transit/to-srz`). * Package the parts into a cardboard box, using Jiffy bags, bubblewrap or similar to protect the parts. @@ -98,7 +98,7 @@ Begin by requesting the following information from the Team Coordinator for the * Once you have the tracking number from the courier, email the local teams coordinator with the tracking number/link so that they can pass it onto the team. Get them to ask the team to inform them when the kit has been delivered. -* Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory \(e.g. `teams/2017/srz`\). +* Once the kit has been delivered, move the kit in the Inventory to the appropriate `team` sub directory (e.g. `teams/2017/srz`). ## Shipping kits to storage at the end of the competition @@ -110,7 +110,7 @@ Some teams will have been given permission to retain their kit for a while after ## Shipping of non-team kits and development tools to volunteers -Non-team kits \(those that are classed as development, support, PR or local\) and development tools need to be shipped around as deemed appropriate by the person responsible for their allocation. That being the Kit Coordinator for development kits and tools, the Kit Support Coordinator for support kits, the PR coordinator for PR kits and the Team Coordinator for local kits. TBD. +Non-team kits (those that are classed as development, support, PR or local) and development tools need to be shipped around as deemed appropriate by the person responsible for their allocation. That being the Kit Coordinator for development kits and tools, the Kit Support Coordinator for support kits, the PR coordinator for PR kits and the Team Coordinator for local kits. TBD. ## Shipping of non-kit assets From 39fd1e30c99f5015baa25361c67ed8d3adf60306 Mon Sep 17 00:00:00 2001 From: Peter Law Date: Sat, 31 Aug 2019 15:11:56 +0100 Subject: [PATCH 106/106] Fix links to pages already imported --- docs/kit/logistics/transport/couriers.md | 2 +- docs/kit/logistics/transport/packaging.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/kit/logistics/transport/couriers.md b/docs/kit/logistics/transport/couriers.md index c0b0c07b..d7a7fe1d 100644 --- a/docs/kit/logistics/transport/couriers.md +++ b/docs/kit/logistics/transport/couriers.md @@ -12,7 +12,7 @@ We have confirmed that the following couriers are happy handling packages contai Kit data for couriers: * Dimensions: 48cm x 39cm x 20cm -* Weight: 6kg (A kit weighs 4.95kg [ref](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Kit Definition). 6kg gives some headroom) +* Weight: 6kg (A kit weighs 4.95kg [ref](../../kit-definition.md). 6kg gives some headroom) * Value (for insurance): £500 * Batteries: Lithium Ion. Packed with equipment. Batteries less than 100Wh. diff --git a/docs/kit/logistics/transport/packaging.md b/docs/kit/logistics/transport/packaging.md index 079fadc6..526954b9 100644 --- a/docs/kit/logistics/transport/packaging.md +++ b/docs/kit/logistics/transport/packaging.md @@ -33,7 +33,7 @@ When teams have to return a kit to us we provide them with a return shipping pac | 220x320mm (internal) white jiffy bag | 1 | [UK Packaging ref 09314](http://www.ukpackaging.com/postal-packaging/jiffy-bags/jiffy-earth-aware-airkraft-white-ak3-220x320mm-50-pack) | To put the whole return shipping pack into. | | Return shipping pack instructions | 1 | [Revision SR2017-2](https://github.com/srobo/return-shipping-pack/releases/download/SR2017-2/return-shipping-pack-instructions.pdf) | | | Loan extension instructions | 1 | [Revision SR2017-2](https://github.com/srobo/return-shipping-pack/releases/download/SR2017-2/loanext-instructions.pdf) | Only included in return shipping packs handed out at the end of the competition. | -| Kit list | 1 | [Kit Definition](https://bitbucket.org/richardbarlow/sr-kit-coord/wiki/Kit%20Definition) | Only included in return shipping packs handed out at the end of the competition. Remove 'disclaimer' and the wire from the list. | +| Kit list | 1 | [Kit Definition](../../kit-definition.md) | Only included in return shipping packs handed out at the end of the competition. Remove 'disclaimer' and the wire from the list. | ### Instruction Notes