ANGULAR DOCUMENTATION

[rosalieucla]

At the end of the project, we need to have documentation (like a cookbook, recipe) of how you created the site and its elements so that we can maintain the site ourselves.

There are tools that will help you to document you code as you go: such as Dgeni. https://toddmotto.com/documenting-angular-dgeni or here: https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation

[kjallen]

We have a few use cases we would like to review to go over:

• A developer would like to change the structure/html of an existing page or edit existing features

• A developer would like to add a brand new page

• The Solr schema has changed, and there is a a new field, a field has been renamed, or the data structure behind a field has changed (for example, a string to a multivalue/array field), what is the most efficient way to identify and update the pages to reflect these changes

[rosalieucla]

Some other use cases just to give you an idea of all the types of things we'll need

• we need to change the the value for a field that displays in the search results
• we need to update or change the script for the dynamically generated pages, eg Institution page, and browse by collection title/ institution page.
  -we need to add a banner that displays on all pages
  -we need to change the font/size or link treatment on pages
  -we want to add a new or change an existing search filter
  -we want to make edits to the parameters of the social media share features
• the urls of the items pages are really long, we'd like to explore other ways of forming those, so we need to understand what you are doing now - eg. http://prl.library.ucla.edu/detail/oai:ira.lib.polyu.edu.hk:10397%2F3036?s_page=1&s_filters=%7B%7D&s_therms=&s_order=

[pghorpade]

walk through of pages getting data from solr in code.

[amereshchuk]

https://github.com/pier2marketing/ucla-prrla/blob/master/ucla-prrla/docs/README.MD
https://github.com/pier2marketing/ucla-prrla/tree/master/ucla-prrla/documentation

[markmatney]

We also would like any tips on developer environment setup regarding the following:

• are any of the developers using an IDE? If so
  • Which IDEs?
  • Do you recommend these IDEs?
  • Can you share any of the configuration files for this project?

[Hlopec]

Hi,

• We used PHPStorm, but you can use any IDE for developing.
• We are accustomed to working in this environment.
• There no any configuration files. All files for use, ng-cli add automaticaly.