Uploaded image for project: 'Forge'
  1. Forge
  2. FORGE-1992

Create a "Welcome to Forge Tutorial" for new CLI users (Build tutorial functionality)

    XMLWordPrintable

Details

    • Feature Request
    • Resolution: Unresolved
    • Major
    • 3.x Future
    • 2.8.1.Final
    • UI - Shell, Usability
    • None

    Description

      This should be an interactive tutorial like:

      "Welcome to Forge! If you're used to a typical system terminal, we do things a little differently here. This appears to be your first time, so we've prepared a short tutorial to guide you through how to best use the system. To begin the tutorial, type `tutorial-run`"
      
      Show the tutorial on startup? [Y,n]: 
      
      $ tutorial-run
      
      Welcome to the Forge Tutorial! We'd like to show you around our system. At any time, you may press CTRL-D, or type `tutorial-stop`, to exit the tutorial. 
      
      Let's start by creating a new project. Please type `project-new --named forge-tuturial`, but don't press `<RETURN>`.
      

      User then types `project-new --named forge-tuturial`, at which point, Forge intercepts the partially typed command (might need a new type of Shell buffer listener) and says:

      Great! You've started typing the `project-new` command, but you still need to specify a project type. Press <TAB> to see a list of available options, and select the `java-web-application` project type:
      

      This would also introduce a delay until which user input would be blocked, so they don't press return by accident. It should count down visually if possible (with dots ..... if necessary), then say, "Go!"

      User now presses <TAB>, and selects --type, or just types it, and Forge replies with:

      Excellent job! You're now ready to create this project. Continue customizing your project (press <TAB> to see more options) or press `<ENTER>` to continue to the next step.
      

      User presses <ENTER> and Forge replies:

      Now that you have create a project, it's time to make it do something! Let's get our creative juices flowing and get this thing hooked into a database.
      

      Etc... This should continue for some time, with examples of several java-ee technologies. We could even break the tutorial up into different lessons. (Extendable?)

      Attachments

        Activity

          People

            Unassigned Unassigned
            lincolnthree Lincoln Baxter III (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: