From e310c34b71c621b86313a68fbc2ee9b230e5395c Mon Sep 17 00:00:00 2001 From: Daniel McKnight Date: Mon, 14 Aug 2023 15:40:54 -0700 Subject: [PATCH 01/10] Add Docker skill installation guide --- docs/guides/docker_skill_installation.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/guides/docker_skill_installation.md diff --git a/docs/guides/docker_skill_installation.md b/docs/guides/docker_skill_installation.md new file mode 100644 index 00000000..2a18a57f --- /dev/null +++ b/docs/guides/docker_skill_installation.md @@ -0,0 +1,19 @@ +# Docker Skill Installation +This guide summarizes how to add custom skills to a Docker deployment. + +## Steps +1. Locate your `neon.yaml` configuration file. +2. Create or add to the configuration list `skills`, `default_skills` +3. Add any desired skill(s) to the list by PyPI name or URL starting with `git+` +4. Restart the `neon-skills` container + +## Troubleshooting +- Make sure the `neon.yaml` file being changed is the one used by Docker containers. +- Make sure any skill package names or URLs are valid. +- Check the `neon-skills` container logs in Docker or `skills.log` file for errors. + +## Tags +- skill installation +- install skill +- docker +- skill development \ No newline at end of file From c5c42084b78f8b2f6cef9e4739c905427aa235ef Mon Sep 17 00:00:00 2001 From: Clary Date: Mon, 14 Aug 2023 16:18:28 -0700 Subject: [PATCH 02/10] Create make_bootable_media.md going to add a couple more sets of directions --- docs/guides/make_bootable_media.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/guides/make_bootable_media.md diff --git a/docs/guides/make_bootable_media.md b/docs/guides/make_bootable_media.md new file mode 100644 index 00000000..8450937f --- /dev/null +++ b/docs/guides/make_bootable_media.md @@ -0,0 +1,24 @@ +# Make Bootable Media +How to image a drive using your Mark II's "Make Bootable Media" skill. + +## Requires +Two USB drives, or a USB drive and an SSD drive, or two SSD drives with supplemental power to one of them. Any data on the secondary drive will be erased by this process. + +## Steps +1. Start with your machine booted up, with the boot drive in the upper left USB port. +2. Plug in your secondary drive in the upper right USB port. +3. Say "Hey Neon, make bootable media". +4. Follow the prompts. +5. When finished, shut down your Mark II and unplug the power. +6. Unplug the boot drive you were using from the left USB port and set it aside. +7. Move the second boot drive from the right hand port to the left hand port. +8. Plug power back in to your Mark II. +9. Congratulations, you're on the new version! +10. If you would like to use the new version on your original boot drive, simply repeat this process. + +## Troubleshooting +- The Mark II may not provide enough power to run two SSD drives at the same time. + +## Tags +- make bootable media +- image boot drive From 6f2bb53be8112d4c0513a0e25f994bc4fd9baf7a Mon Sep 17 00:00:00 2001 From: Clary Date: Mon, 14 Aug 2023 16:42:57 -0700 Subject: [PATCH 03/10] Create make_a_boot_drive_using_a_computer.md --- .../make_a_boot_drive_using_a_computer.md | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/guides/make_a_boot_drive_using_a_computer.md diff --git a/docs/guides/make_a_boot_drive_using_a_computer.md b/docs/guides/make_a_boot_drive_using_a_computer.md new file mode 100644 index 00000000..da5d44dd --- /dev/null +++ b/docs/guides/make_a_boot_drive_using_a_computer.md @@ -0,0 +1,34 @@ +# Make a Boot Drive Using Your Computer +How to use your Windows computer to make a USB or SSD boot drive for your Mark II. + +## Requires +A portable drive, either USB or SSD with a USB version 3.0 or greater connection. + +## Steps +1. Download the Neon OS to your computer from the link on this page: https://neon.ai/NeonAIforMycroftMarkII +2. Download a (free) imaging program, if you don't have one already. We suggest Raspberry Pi Imager or Balena Etcher. +3. Plug the drive you want to update into your computer. +4. Open your imaging program. +- If using Raspberry Pi Imager: + - Under the 'Operating System' menu, select 'Use Custom'. + - Locate and select the Neon OS image you downloaded. + - Under 'Storage', select the drive you intend to write to. + - Click 'Write' and wait for the image to be written and verified. This takes several minutes, depending on your system. +- If using Balena Etcher + - Under the '+', choose 'Flash from file'. + - Locate and select the Neon OS image you downloaded. + - Under 'Select target', select the drive you intend to write to. + - Click 'Flash' and wait for the image to be written and verified. This takes several minutes, depending on your system. +6. Remove the USB or SSD drive from your computer. +7. Disconnect power from your Mark II. +8. Plug the newly imaged USB drive into the top left USB port on your Mark II (Port 0). +9. Reconnect power to your Mark II. +10. Set up as normal, and you're on the new version! + +## Troubleshooting +- Imaging using a computer is not quite 100% reliable. If your newly imaged drive does not perform well, try imaging it again. + +## Tags +- imaging +- make a boot drive +- computer From 7e268b6fcf7355ff3103fd4252773b8e436d4e3e Mon Sep 17 00:00:00 2001 From: Clary Date: Mon, 14 Aug 2023 18:11:52 -0700 Subject: [PATCH 04/10] Create upgrade_paths_for_neon_os_v2.md I created the "upgrade page" but it's an unpublished draft still. --- docs/guides/upgrade_paths_for_neon_os_v2.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/guides/upgrade_paths_for_neon_os_v2.md diff --git a/docs/guides/upgrade_paths_for_neon_os_v2.md b/docs/guides/upgrade_paths_for_neon_os_v2.md new file mode 100644 index 00000000..cd2d0963 --- /dev/null +++ b/docs/guides/upgrade_paths_for_neon_os_v2.md @@ -0,0 +1,19 @@ +# Ugrade Paths for Neon OS Version 2.0 on the Mark II +Describes your basic options for upgrading your Neon OS to V2.0. + +## Options +1. Make a version 2.0 boot drive on your Mark II using the "Make Bootable Media" skill. +2. Make a version 2.0 boot drive using a computer. +3. Order a free USB with the image on it from Neon AI with coupon code "UPGRADE". Our square site is https://neonai.square.site/ +4. Order an SSD from our Square site for $29.99 with coupon code "UPGRADE". The site is https://neonai.square.site/ +5. Visit the upgrade page on our website at https://neon.ai/V2 for written directions, how-to videos, and open tech support calls. That's https://neon.ai/V2 + +- To hear more detailed directions, you can ask Neon for: + - help making bootable media + - help making a boot drive using your computer + + ## Tags +- upgrade +- upgrade choices +- version 2 +- version 2.0 From 7c0cf8eabdd543911127f720908dd11dc794ae0c Mon Sep 17 00:00:00 2001 From: Clary Date: Tue, 15 Aug 2023 15:34:07 -0700 Subject: [PATCH 05/10] Update make_a_boot_drive_using_a_computer.md --- docs/guides/make_a_boot_drive_using_a_computer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/make_a_boot_drive_using_a_computer.md b/docs/guides/make_a_boot_drive_using_a_computer.md index da5d44dd..551b445d 100644 --- a/docs/guides/make_a_boot_drive_using_a_computer.md +++ b/docs/guides/make_a_boot_drive_using_a_computer.md @@ -21,7 +21,7 @@ A portable drive, either USB or SSD with a USB version 3.0 or greater connection - Click 'Flash' and wait for the image to be written and verified. This takes several minutes, depending on your system. 6. Remove the USB or SSD drive from your computer. 7. Disconnect power from your Mark II. -8. Plug the newly imaged USB drive into the top left USB port on your Mark II (Port 0). +8. Plug the newly imaged USB drive into the upper USB port closest to the center of your Mark II (Port 0). 9. Reconnect power to your Mark II. 10. Set up as normal, and you're on the new version! From 12693d1b584ba94b82303fe0fdbf72386e81ca97 Mon Sep 17 00:00:00 2001 From: Clary Date: Tue, 15 Aug 2023 15:38:24 -0700 Subject: [PATCH 06/10] Update make_a_boot_drive_using_a_computer.md --- docs/guides/make_a_boot_drive_using_a_computer.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/guides/make_a_boot_drive_using_a_computer.md b/docs/guides/make_a_boot_drive_using_a_computer.md index 551b445d..830e5f3e 100644 --- a/docs/guides/make_a_boot_drive_using_a_computer.md +++ b/docs/guides/make_a_boot_drive_using_a_computer.md @@ -26,7 +26,10 @@ A portable drive, either USB or SSD with a USB version 3.0 or greater connection 10. Set up as normal, and you're on the new version! ## Troubleshooting -- Imaging using a computer is not quite 100% reliable. If your newly imaged drive does not perform well, try imaging it again. +- Imaging using a computer is not quite 100% reliable. If your newly imaged drive does not perform well, try imaging it again. +- If you get an error that verification has failed, try imaging again. +- If you get an error that it is unable to write to your drive, try erasing the drive first using Raspberry Pi imager, and then try imaging again. +- If you get repeated errors, the drive may be faulty or your system may be having problems writing to the disk. You could try using a different computer, try imaging using your Mark II's "Make Bootable Media" skill, or order an imaged drive from Neon AI at https://neonai.square.site/ ## Tags - imaging From fa7e4351c5b1c8786588f61e6a99bbe6cb940045 Mon Sep 17 00:00:00 2001 From: Clary Date: Tue, 15 Aug 2023 15:45:24 -0700 Subject: [PATCH 07/10] Update make_bootable_media.md --- docs/guides/make_bootable_media.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/guides/make_bootable_media.md b/docs/guides/make_bootable_media.md index 8450937f..487b2404 100644 --- a/docs/guides/make_bootable_media.md +++ b/docs/guides/make_bootable_media.md @@ -1,20 +1,19 @@ # Make Bootable Media -How to image a drive using your Mark II's "Make Bootable Media" skill. +How to image a drive using your Mark II's "Make Bootable Media" intent. ## Requires Two USB drives, or a USB drive and an SSD drive, or two SSD drives with supplemental power to one of them. Any data on the secondary drive will be erased by this process. ## Steps -1. Start with your machine booted up, with the boot drive in the upper left USB port. -2. Plug in your secondary drive in the upper right USB port. +1. Start with your machine booted up, with the boot drive in the upper USB port closest to the center of the back of your Mark II. +2. Plug in your secondary drive in the second USB port, which is closer to the edge of the back of your Mark II. 3. Say "Hey Neon, make bootable media". 4. Follow the prompts. 5. When finished, shut down your Mark II and unplug the power. -6. Unplug the boot drive you were using from the left USB port and set it aside. -7. Move the second boot drive from the right hand port to the left hand port. -8. Plug power back in to your Mark II. -9. Congratulations, you're on the new version! -10. If you would like to use the new version on your original boot drive, simply repeat this process. +6. Unplug the boot drive you were using to run your Mark II and set it aside. +7. Plug power back in to your Mark II (you can move the new boot drive to the other port, but it is not necessary unless you have an extra drive you want to plug in). +8. Congratulations, you're on the new version! +9. If you would like to use the new version on your original boot drive, simply repeat this process. ## Troubleshooting - The Mark II may not provide enough power to run two SSD drives at the same time. From 641992560543b9a350e2a532398c6d6c2e22f771 Mon Sep 17 00:00:00 2001 From: Clary Date: Tue, 15 Aug 2023 15:48:56 -0700 Subject: [PATCH 08/10] Update upgrade_paths_for_neon_os_v2.md --- docs/guides/upgrade_paths_for_neon_os_v2.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/guides/upgrade_paths_for_neon_os_v2.md b/docs/guides/upgrade_paths_for_neon_os_v2.md index cd2d0963..839fdb81 100644 --- a/docs/guides/upgrade_paths_for_neon_os_v2.md +++ b/docs/guides/upgrade_paths_for_neon_os_v2.md @@ -8,10 +8,6 @@ Describes your basic options for upgrading your Neon OS to V2.0. 4. Order an SSD from our Square site for $29.99 with coupon code "UPGRADE". The site is https://neonai.square.site/ 5. Visit the upgrade page on our website at https://neon.ai/V2 for written directions, how-to videos, and open tech support calls. That's https://neon.ai/V2 -- To hear more detailed directions, you can ask Neon for: - - help making bootable media - - help making a boot drive using your computer - ## Tags - upgrade - upgrade choices From b1ee03286aa674414f5d79fff22507a46a43be91 Mon Sep 17 00:00:00 2001 From: Daniel McKnight Date: Tue, 15 Aug 2023 16:17:58 -0700 Subject: [PATCH 09/10] Add example config to docker notes --- docs/guides/docker_skill_installation.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/guides/docker_skill_installation.md b/docs/guides/docker_skill_installation.md index 2a18a57f..260a0ba3 100644 --- a/docs/guides/docker_skill_installation.md +++ b/docs/guides/docker_skill_installation.md @@ -7,6 +7,16 @@ This guide summarizes how to add custom skills to a Docker deployment. 3. Add any desired skill(s) to the list by PyPI name or URL starting with `git+` 4. Restart the `neon-skills` container +## Example Configuration +```yaml +skills: + default_skills: + - git+https://github.com/neongeckocom/skill-date_time@dev + - neon-skill-translation>=0.3.1a4 + - neon-homeassistant-skill +``` +> Skills can be specified by URL or PyPI package spec (versioning optional) + ## Troubleshooting - Make sure the `neon.yaml` file being changed is the one used by Docker containers. - Make sure any skill package names or URLs are valid. From c68e6cb51c2a0938da4246d9e873432af082d738 Mon Sep 17 00:00:00 2001 From: Daniel McKnight Date: Tue, 15 Aug 2023 16:20:58 -0700 Subject: [PATCH 10/10] Add guides to mkdocs --- mkdocs.yml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index a35f56e0..62a727b0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -31,12 +31,17 @@ nav: - Neon Image Recipes: neon_os/neon_image_recipe.md - Developer References: neon_os/developers.md - Tips: neon_os/tips.md - - Quick Reference Guides: + - Quick References: - Terminal: quick_reference/terminal.md - Logs: quick_reference/logging.md - Configuration: quick_reference/configuration.md - Installing Skills: quick_reference/installing_skills.md - Installing Plugins: quick_reference/installing_plugins.md + - Guides: + - Docker Skill Installation: guides/docker_skill_installation.md + - Make a Boot Drive Using a Computer: guides/make_a_boot_drive_using_a_computer.md + - Make a Boot Drive Using a Mark 2: guides/make_bootable_media.md + - Upgrade Paths for Neon OS v2: guides/upgrade_paths_for_neon_os_v2.md - Skill Development: - Voice User Interface Design Guidelines: - What Can A Skill Do?: skill_development/voice-user-interface-design-guidelines/what-can-a-skill-do.md