Creating Guides for the Adafruit Learning System

Transcription

1 Creating Guides for the Adafruit Learning System Created by Tyler Cooper Last updated on :41:37 PM UTC

2 Guide Contents Guide Contents Overview Creating a New Guide Creating & Organizing Pages Externally Linked Pages Adding Featured Products Deleting Understanding Elements Text Element Media Element Code Element Embed Element Embedding MakeCode Blocks Alert Element FAQ Element What is Adafruit's Ask an Engineer? Side2 Element Button Element Github Latest Release Links Table Element Product Element Adafruit METRO Arduino Compatible - with Headers Markdown Element Add Parts Element Split Page Element Publishing Pages & Guides Adafruit Industries Page 2 of 30

3 Overview We are really happy to have you building guides for the greatest learning system in the world. In order to keep high quality guides in the system, we want to make sure you understand the Adafruit Learning System inside and out. Even if you have created hundreds of guides in the past, we ask that you take the time to go through this entire guide. There are a lot of tips and tricks that will help you create the best guide possible. In this guide we will go over creating and organizing pages, adding featured products to the right sidebar, a detailed breakdown of each of the elements that make ALS unique, and show you how to publish pages and guides. This guide is a living document and I will continue to add to it and adjust it as ALS continues to grow. Check back often and use this guide as a tool to reference as you work through your own guides. Adafruit Industries Page 3 of 30

4 Creating a New Guide Start by clicking the CREATE A NEW GUIDE button once you have logged in and clicked Admin in the top navigation bar. Once you click that button you will be sent to the guide settings page. You will need to fill in the information on this page and then click the SAVE & CONTINUE button in the subnav to create the guide. As you add information about your new guide, you will see a preview of how it will be shown to users in the right sidebar. Make sure to use a nice high resolution image or animated GIF for your guide image. After you pick your image, you will be asked to crop the image. Be sure to choose your categories wisely. These are used to help users find your guide. Adafruit Industries Page 4 of 30

5 Creating & Organizing Pages Before you start your guide, you will need to create your first page. In the left sidebar, enter the name of your new page, and then press the CREATE NEW PAGE button. Your new page will show up in your left sidebar, and you will be taken to that page automatically. You can change the order of the pages at any time. Click on the REORGANIZE PAGES button. This will bring you into a mode allowing you to drag and drop pages into your preferred order. Adafruit Industries Page 5 of 30

6 Make sure to click SAVE REORGANIZATION when you have the pages in the correct order. When it comes to our Text Element, we really want to group it with under the Understanding Elements page. To do this, click on the REORGANIZE PAGES button, and slide the page you want to turn into a subpage to the right (while under the parent page). You will then see the page indented. Click SAVE REORGANIZATION and you will see your page as a subpage. Adafruit Industries Page 6 of 30

7 Adafruit Industries Page 7 of 30

8 Externally Linked Pages If you want to have a link in the sidebar that goes to an external page, just follow these simple steps. First, create and name a new blank page just like we did in the previous step. Then, in the right sidebar, click on Page Settings. At the bottom of the popup, you will see a place to put an external URL. Copy and paste in the URL you want to link to, and then check the box if you want the link to open in a new window or not. Then click Save changes. In the sidebar, you will now see the external URL icon next to the link. Anytime someone clicks that link it will open the url you specified. Adafruit Industries Page 8 of 30

9 Adding Featured Products Whenever you use an Adafruit product in your guide, you can add it to the featured products sidebar. This makes it easy for readers to quickly buy all of the components needed to complete your guide. To manage featured products, click on the Featured Products link in the TOOLS section of the admin sidebar. Adding products is incredibly easy. Just search for the product by name, or by Product ID (PID). You will need to type in at least three letters for a product list to show up. Once you see the product you want to add, just click on it to add it to your featured products list. If you can't seem to find your product when searching for it by name, try searching for it by PID. You can find the product ID in a few spots. When on the product page in the Adafruit Shop, you will see it right below the product name. Adafruit Industries Page 9 of 30

10 You will also see the PID in the URL. You can reorganize your products by dragging and dropping them. It is important that you sort your product list with the most important products at the top. Be sure to sort the products in order of importance. Only the top 5-8 products will be visible to the user in the sidebar, the rest of the products will only be on the featured products page. We also use the featured products list to help recommend other guides in the Adafruit Learning System that the reader may find interesting. Adafruit Industries Page 10 of 30

11 Deleting If you have accidentally added a wrong product, hover your mouse cursor over the product and a delete button will appear in the upper right of the product area. Clicking Delete removes that item from the Featured Product list. Adafruit Industries Page 11 of 30

12 Understanding Elements Elements are what makes the Adafruit Learning System editor so unique and easy to use. You can rapidly build guides by adding one element after another until each page is completed. This is what the elements bar looks like. You can add any of the above elements to your guide. We will go over each element and explain how and when to use each. While building your guide, you can drag and drop elements to reorganize them. You can also use the divider like shown above to insert an element between two other elements. Adafruit Industries Page 12 of 30

13 Text Element The text element is pretty straight forward. You can change the size of the text by selecting H1, H2, or Normal text from the dropdown on the far left. Normal text is set by default. The rest of the buttons are, from left to right: Bold Italics Underline Bulleted list Numbered list Outdent - if you have an indented paragraph, you can remove the indent with this button Indent - you can indent a paragraph by highlighting a paragraph and pressing this button. Hyperlink - make text clickable. Highlight a section of text, click the button, then enter in a web address. The HTML button. Click this to make it so you can directly edit the HTML. Make sure to click the SAVE button below the text box to continue. Cancel out of the text box, or open and delete an entire text box with the CANCEL and DELETE buttons. Adafruit Industries Page 13 of 30

14 Media Element The media element is where things start to get a bit more interesting. The media element will handle any sort of file you can throw at it. It will handle images, animated gifs, and any type of downloadable file (such as a.pdf). Instead of designing and building a file manager within the Adafruit Learning System, we decided to just use the one built right into your computer. When you click the Media element button, you will locate the media file(s) you would like to upload on your computer. Select the file, and click the Open button. Pro Tip: you can select multiple images at once and it will insert them all into your guide! If you select a file, like a.pdf, the system will automatically create a download button for you like this one: Feel free to click on the button while in the editor to change the text and color of the button: If you hover over the top of any image, in the upper right corner you will see some settings. Adafruit Industries Page 14 of 30

15 If you click the replace link, it will open up your file manager where you can look for a new image, and it will replace the current image with the new one you choose. If you click delete, it will delete the image from your guide. If you would like to change the license attached to your image, click update license. Adafruit Industries Page 15 of 30

16 Code Element The code element is used when you want to paste in bits of code, like so: void loop() { uint8_t red, blue; float temp = mlx.readobjecttempf(); if (temp < COLDTEMP) temp = COLDTEMP; if (temp > HOTTEMP) temp = HOTTEMP; // map temperature to red/blue color // hotter temp -> more red red = map(temp, COLDTEMP, HOTTEMP, 0, 255); // hotter temp -> less blue blue = map(temp, COLDTEMP, HOTTEMP, 255, 0); colorwipe(strip.color(red, 0, blue), 0); } delay(50); // can adjust this for faster/slower updates // Fill the dots one after the other with a color void colorwipe(uint32_t c, uint8_t wait) { for(uint16_t i=0; i<strip.numpixels(); i++) { strip.setpixelcolor(i, c); strip.show(); delay(wait); } The most important thing here is to make sure to select the right type of code you are pasting. In this case, I pasted Arduino code: By selecting what type of code you are pasting, it changes how the code is displayed to your readers to make it easier to read. Adafruit Industries Page 16 of 30

17 Embed Element The Embed Element is how you add YouTube and Vimeo videos, Vine clips, and Github Gists to your guide. Embedding videos or Gists couldn't be easier. All you need to do is get the URL of the page that the video is on and paste it into the Embed Element text box. Dump the entire URL into the text box like shown below and click SAVE: While you are in the editor, you will see the embed URL, but your readers will see the full video. This is what you will see in the editor: This is what your readers will see in the front end: You can always click the preview link in the right sidebar to view what your readers will see, even if you haven't published your guide. Adafruit Industries Page 17 of 30

18 Embedding MakeCode Blocks Just like in the last step, embedding MakeCode blocks into your guide is just as easy. In MakeCode, click on the share project button and you will see a popup like this: Just like as before, copy that link and then in your guide choose the EMBED element. Just paste in the URL from MakeCode above, and click save. Your MakeCode block should now be in your guide. Adafruit Industries Page 18 of 30

19 Alert Element The Alert Element is an easy to use element that is designed to grab your reader's attention. Enter in a short sentence and click SAVE. This is what an alert looks like. It is sure to grab your reader's attention! Just remember to use them sparingly, and only for the most important reminders that you need to burn into your reader's brains. The more of these you use, the less impact they will have. Adafruit Industries Page 19 of 30

20 FAQ Element The FAQ Element is for, you guessed it, Frequently Asked Questions. These are generally used on their own dedicated pages, or in a section at the end of a page. All you need to do is enter in your question in the smaller text box at the top, then enter in the answer to that question below. When done, the element will look like this on the front end: What is Adafruit's Ask an Engineer? From the electronics enthusiast to the professional community -- "Ask an Engineer" has a little bit of everything for everyone. If you're a beginner, or a seasoned engineer -- stop in and see what we're up to! We have demos of projects and products we're working on, we answer your engineering and electronics questions and we have a trivia question + give away each week. Adafruit Industries Page 20 of 30

21 Side2 Element The Side2 Element is used when you want to put a bit of text next to one or more images. Think of it as a really smart two column table. Side2 Elements are perfect for creating step-by-step guides, such as kit assembly instructions. For a good example of how these should be used, check out the MiniPOV4 soldering instructions here. ( Adafruit Industries Page 21 of 30

22 Button Element The Button Element allows you to create different colored buttons. These are typically used to link to a downloadable media file, or to send someone to another site like Github. First type in what you want the button to say, and then enter a link. You can choose between multiple button colors. Choose wisely! Here is an example of what buttons look like: Github Latest Release Links The button element has one further feature that allows it to process release links for github releases. If you provide it with a fairly specific url, and then maintain consistency in naming your releases, it will always link to the latest version in your github repository. The link structure is as follows: in place of version}. {extension} ( Example: ( The extension is optional, but the wildcard for the version is required. Example button: Adafruit Industries Page 22 of 30

23 Table Element The Table Element is an element that should only be used when absolutely necessary. It is our way of taking an old way of doing things on the web and modernizing it. It is really the only way to organize content in multiple rows and columns, but it certainly doesn't play nice with phones and tablets. Tables are typically used when making a parts list for a project. Check out the MENTA Kit parts list for an example. ( There are probably better ways to handle this without using tables, such as using the Side2 element like in the minipov4 guide. ( Adafruit Industries Page 23 of 30

24 Product Element The Product Element is very similar to the featured products part of the guide. Use it if you want to highlight a product in the middle of the guide and allow a reader to quickly and easily add that product to their shopping cart. Just like the featured products page, just search for an Adafruit product by name or with the PID. If I do a search for Adafruit METRO 328, it will open a list of matches. Click on the correct match and it will load a featured product into your guide like this: Adafruit METRO Arduino Compatible - with Headers $17.50 IN STOCK ADD TO CART Adafruit Industries Page 24 of 30

25 Markdown Element If you are already familiar with the Markdown language, the Markdown element is pretty self-explanatory. It is simply a blank box that you can either write Markdown, or more often paste in Markdown from a separate editor Adafruit Industries Page 25 of 30

26 Add Parts Element The Add Parts Element is also know as the parts list maker. This element is great for making lists of not only Adafruit parts, but also for adding parts that need to be purchased from other vendors. Start by clicking the Add Parts Element. You will then be asked to give the part a name, enter a part URL, a part description, and how many the reader will need to buy. The Part Name is the name of the part, and also the clickable link. For the Part URL, you just need to paste in either an Adafruit URL, or a third party URL like Amazon. If it is an Adafruit URL the system will automatically allow people to instantly add that product to their shopping cart. If it is a third party, they will need to click the buy now button which will open the part URL into a new tab. The part description is a good spot to put how that part will be used in that project. Last, click the quantity dropdown to let the reader know how many of that part they should buy. For example, if I fill in this: Click save and it will turn into this: 1 x Adafruit METRO This will be the brains of the project ADD TO CART Just keep choosing the Add Parts Element to add on to the parts list. Add a few parts or a whole bunch of parts to create lists like this: 1 x Adafruit METRO This will be the brains of the project ADD TO CART 1 x Adafruit Proto Shield This is where we will build out the project ADD TO CART 2 x Giant Googly Eyes Every project should have giant googly eyes Adafruit Industries Page 26 of 30

27 BUY NOW Adafruit Industries Page 27 of 30

28 Split Page Element If you ever get in a situation where you have a page that ends up getting too long and can be broken up into multiple pages, the Split Page Element is the tool for you. To use the Split Page Element, go to a page that is too long and find a good spot where you think the page can be broken up. Click the dividing line to expand and then click the Split Page Element. Anything below that line was will be sent to a new page. So, the only thing you need to do is name the new page. Once you click the Split button, the system will grab everything below that point and move it to your new page. It will automatically load into the new page so if you need to split a page into multiple parts, you can just scroll down from there and repeat the process. Adafruit Industries Page 28 of 30

29 Publishing Pages & Guides Once you are done with a page within your guide, you can publish the page. Publishing the page won't show the page to readers until you have also published the guide. This allows you to publish a guide while still working on pages that you would like to publish later. You can also go in and unpublish a page while keeping the rest of the guide visible to readers. To publish a page, just click on the toggle in the PUBLISH section of the right sidebar. Once clicked, the color will change to green, and the status will change from draf to published. Once a page is published, and you should see the [draft] tag removed from the left sidebar once you refresh: Adafruit Industries Page 29 of 30

30 Once you are ready to go live with your guide, click on the publish guide toggle just like you did the page toggle above. Once clicked, the color will change to yellow and the status will change to Pending final review. This means that one of the ALS moderators has been notified to take a quick look over your guide to make sure everything is in order. Once they approve, they will publish the guide and it will show up on ALS! Congrats on creating your first guide! If you have any questions or concerns while creating your guide, please me: tyler@adafruit.com. Adafruit Industries Last Updated: :41:32 PM UTC Page 30 of 30