Forum Discussion

DavidBaird-AUS's avatar
DavidBaird-AUS
Community Member
5 months ago

Managing code resources

With the introduction of the Code Block feature I have began to realise the accumulation of multiple code snippets. I'm wondering whether there are any good tools / methods for managing these resources? In particular, the ability to tag these snippets to indicate where they have been used.

16 Replies

  • I don't have a suggestion, but I think this is a great question. I'd be interested in seeing how others organize this type of information.

  • Stacey's avatar
    Stacey
    Community Member

    Try out Notion. You can create a free account. Inside you create pages (like folders) and on the page you can create tables/databases to hold your information. It's quick and allows you to categorize you snips. It also has a simple copy from each block that you can use to grab the code when you need it. I'm not paid to refer Notion, it's just a handy tool for me.

  • In my Rise Code Block examples, I'm actually using Rise to not only organize and test the code blocks, but also to store the code in code snippets. I have also created templates for each code block to easily drop into new courses. 

  • CassandraW's avatar
    CassandraW
    Community Member

    Care to share any examples on how to replace the images using RISE libary?

    • Stephanie's avatar
      Stephanie
      Super Hero

      When searching in the content library, hovering over the bottom of the image produces two links; one to the author of the image and one to the hosting platform. You can locate the image this way. If you Preview it, right-click and choose 'copy image address' this provides the direct URL for the free image. You can use that url in your code.

  • For others looking at working collaboratively, or who want to use version control, I'd suggest using git. It's got a small learning curve but it enables you to privately host all your code and pull and edit it from anywhere etc.

    • TeresaIden-9681's avatar
      TeresaIden-9681
      Community Member

      BlendedLearn959​ I have git, but have to relearn it every time I use it 🤪 Any chance you've created a "How to use Git for Rise Code Blocks" course or anything?  LOL  

  • Our team has added these blocks to a Rise file we share, sort of a Code Library. We categorized different types of blocks (sales blocks, general blocks, activities, etc.) and created a lesson for each. That way everyone can see the block and then go in and copy/paste the code to their own Rise file.

  • I'm also dropping code snippets into a Code Block course in Rise.  I copy the code I find into one block. Then I edit the code in Visual Studio Code and drop in my own versions into additional blocks.  That I way I have a variety of similar code blocks to use for other courses.

  • My team and I use Google Docs because our organisation's standards require the use of Google Apps. We organised a document alphabetically by exercises' names, using tabs and subtabs features and I think that any document organising tool might work :) 

    Tab 1: Code with explanations -> table of contents with links to subcards through headlines
    Subtabs: Specific exercises with illustrations, an introduction about how it works, and each and every line of code explained in detail - what it does, why, what we can change (bold for code, normal text for explanation) - for us to understand what we are doing as non-programmers. (AI helps explain, but we also used resources and our own knowledge, because AI is not always right or specific enough)

    Tab 2: Working code -> Table of contents
    Subtabs: Each and every exercise in plain code to easily copy and paste by Ctrl+A without additional notes (only useful ones, such as - "//don't forget to change here if..." etc.:D)

    Archive: old code, if we need to come back to any version of old code during iterations 

    We have a test course in Rise in which we test and iterate on exercises. And when we finalise a working exercise, we create a block template in Rise. 
     
    Little caveat here: it is quite a lot of work to keep all the documents and block templates up to date - if you change anything in code, you need to change it in two tabs in Google and in the block template. But we have a few people on the team, and we need everyone to have easy access to both the code and the explanations. 

  • Why wouldnt you use Git to store these it is what it was built for and allows you to commit and track changes.

    • DavidBaird-AUS's avatar
      DavidBaird-AUS
      Community Member

      Are there restrictions in using Git? For example, do files need to be stored externally? If this is the case, it may go against organisational policy. Also, what is the learning curve to get up to speed with Git? If these don't pose any restrictions then Git would be a good tool.

      • PhilMayor's avatar
        PhilMayor
        Super Hero

        Does your organisation have their own repsoitory, we do, so I store everything there and it is not public.