[x] Review annotator creation error

[amberreeves]

David’s team used the annotator documentation to attempt to build a mark-up instance. (We need two more build for the two PNW modules testing tomorrow.) They were able to get through Step 3. And then ran into an error. Can you please have a look?

Our team got the following error when running step 4:

D:\inetpub\nmai_mainsite2_test\nk360\pnw-history-culture-regions>grunt dist --dir=pnw1-markup3 --theme=pnw --json=m3a3

A valid Gruntfile could not be found. Please see the getting started guide for more information on how to configure grunt: http://gruntjs.com/getting-started

It seems that all files may have note been provided since your access was limited and you didn’t have access to other folders where you may need to drop additional files. The folders they have are the folders for end products.

• Please provide the missing file as indicated in the message.
• Please provide all the files, including the files the build process depend on, as shown in the above example.
• Please update the documentation with full details and supporting files.

[amberreeves]

A note from Mike that should clarify: The steps for building a new resource annotator require using the cloned repository from GitHub on your local machine and running the grunt commands there (not on the production server). The files on the production server are packaged for distribution, not for development. Please begin by following the Quick Start instructions. Then, if you follow the instructions using the code in the repository, and run through step #4 under Building a New Resource Annotator, it will generate the new annotator for you with all required files (as noted in step #5).

From David Thanks for the additional information. It is still unclear to me where/how to proceed. Please see a question and comment below:

The steps for building a new resource annotator require using the cloned repository from GitHub on your local machine

Where is the repository?

Please begin by following the Quick Start instructions.

We did this.

We really appreciate it if the document can be expanded with more details such as screenshots and steps.

[amberreeves]

from david

With the updated document and the info in your emails, I was able to go through the four steps successfully. Thank you! During the process, I got the following message: You need to have Ruby and Sass installed and in your PATH for this task to work.

Could you please have Michael to update the document to indicate the need for the install of the two tools before run Step 4?

[mtedeschi]

I added a note to the Quick Start guide to install Ruby (it is installed on Macs by default). Sass should be installed with the npm install script.

[mtedeschi]

Closing for now, unless new things come up