Changes between Version 48 and Version 49 of Webdev


Ignore:
Timestamp:
11/17/16 13:10:32 (8 years ago)
Author:
Willem Elbers
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Webdev

    v48 v49  
    11[[PageOutline]]
    22
    3 We use the [https://www.drupal.org Drupal] Content Management System (CMS) for [https://www.clarin.eu].
    4 [http://poplarware.com/articles/drupal_cheat_sheet A general, brief overview of Drupal].
     3We use the [https://www.drupal.org Drupal] Content Management System (CMS) for [https://www.clarin.eu].  [http://poplarware.com/articles/drupal_cheat_sheet A general, brief overview of Drupal].
    54
    65## Important links ##
    … …  
    2120
    2221Development follows a three-stage workflow:
    23 1. development: [[./dev-www.clarin.eu]]
    24 1. acceptance
    25 1. production: [[./Archive/www.clarin.eu]]
     22
     23 1. development: [[./dev-www.clarin.eu ./dev-www.clarin.eu]]
     24 1. acceptance
     25 1. production: [[./Archive/www.clarin.eu ./Archive/www.clarin.eu]]
    2626
    2727Drupal should be managed from the command line with [https://github.com/drush-ops/drush Drush]. [https://groups.drupal.org/drush/commands Commands for drush].
    … …  
    3737[[Image(clarin website HA setup.png)]]
    3838
    39 * Requests are normally handled by the primary (live) instance.
    40 * If the primary instance is unavailable, the hot standby will take over. This is a read-only version of the website.
    41 * A full backup is created every day and imported into the hot stanby instance.
     39 * Requests are normally handled by the primary (live) instance.
     40 * If the primary instance is unavailable, the hot standby will take over. This is a read-only version of the website.
     41 * A full backup is created every day and imported into the hot stanby instance.
     42
     43## Docker images ##
     44
     45Each component is run as a docker container based on a docker image. The following images are used:
     46
     47|| '''Component''' || '''Docker Image''' || '''Repository''' ||
     48|| website (primary and secondary) || registry.gitlab.com/clarin-eric/alpine-httpd-drupal || [https://gitlab.com/CLARIN-ERIC/alpine-httpd-drupal gitlab] ||
     49|| database (primary and secondary) || mariadb || [https://hub.docker.com/_/mariadb/ docker hub] ||
     50|| proxy || registry.gitlab.com/clarin-eric/alpine-httpd-proxy || [https://gitlab.com/CLARIN-ERIC/alpine-httpd-proxy gitlab] ||
    4251
    4352# Conversion from legacy state to basic Drupal #
    … …  
    5665drush.phar views-enable 'frontpage'
    5766}}}
    58 
    59 1. [https://dev-www-3.clarin.eu/admin/appearance ‘Sub Seven’ admin theme -> ‘Default theme’].
    60 2. [https://dev-www-3.clarin.eu/admin/appearance Set Bootstrap theme as default].
    61 3. [https://dev-www-3.clarin.eu/admin/appearance Disable ‘Clarin.eu Theme’].
    62 5. [https://dev-www-3.clarin.eu/admin/structure/menu/settings ‘Source for the Secondary links’: User menu -> Secondary menu].
    63 6. [https://dev-www-3.clarin.eu/admin/structure/block/manage/system/main-menu/configure?destination=admin/structure/menu/settings Disable block ‘Main menu’ by setting it to `- None -` in the dropdown in ‘Region settings’].
    64 7. [https://dev-www-3.clarin.eu/admin/config/system/site-information -> Set ‘Default front page’ to 'frontpage'].
    65 8. [https://dev-www-3.clarin.eu/admin/structure/menu/item/489/edit Use relative ‘Login’ link: Path * (URL)/user -> user
    66 9. [https://dev-www-3.clarin.eu/admin/config/search/redirect/add Add redirect /user/register -> https://user.clarin.eu/user/register]
     67 1. [https://dev-www-3.clarin.eu/admin/appearance ‘Sub Seven’ admin theme -> ‘Default theme’].
     68 1. [https://dev-www-3.clarin.eu/admin/appearance Set Bootstrap theme as default].
     69 1. [https://dev-www-3.clarin.eu/admin/appearance Disable ‘Clarin.eu Theme’].
     70 1. [https://dev-www-3.clarin.eu/admin/structure/menu/settings ‘Source for the Secondary links’: User menu -> Secondary menu].
     71 1. [https://dev-www-3.clarin.eu/admin/structure/block/manage/system/main-menu/configure?destination=admin/structure/menu/settings Disable block ‘Main menu’ by setting it to `- None -` in the dropdown in ‘Region settings’].
     72 1. [https://dev-www-3.clarin.eu/admin/config/system/site-information -> Set ‘Default front page’ to 'frontpage'].
     73 1. [https://dev-www-3.clarin.eu/admin/structure/menu/item/489/edit Use relative ‘Login’ link: Path * (URL)/user -> user
     74 1. [https://dev-www-3.clarin.eu/admin/config/search/redirect/add Add redirect /user/register -> https://user.clarin.eu/user/register]
    6775
    6876## Disable legacy/redundant extensions ##
    … …  
    107115drush.phar pm-update --no-backup
    108116}}}
    109 
    110117Remove residual Drupal ''views'' by visiting:
    111118
    112 1. https://dev-www-3.clarin.eu/admin/structure/views/view/openscience_events/delete
    113 2. https://dev-www-3.clarin.eu/admin/structure/views/view/openscience_group_river/delete
    114 3. https://dev-www-3.clarin.eu/admin/structure/views/view/openscience_movies/delete
    115 4. https://dev-www-3.clarin.eu/admin/structure/views/view/openscience_popular_content/delete
    116 5. https://dev-www-3.clarin.eu/admin/structure/views/view/featured_lrt_showcase/delete
    117 6. https://dev-www-3.clarin.eu/admin/structure/views/view/featured_showcase/delete
    118 7. https://dev-www-3.clarin.eu/admin/structure/views/view/lrtshowcases/delete
     119 1. https://dev-www-3.clarin.eu/admin/structure/views/view/openscience_events/delete
     120 1. https://dev-www-3.clarin.eu/admin/structure/views/view/openscience_group_river/delete
     121 1. https://dev-www-3.clarin.eu/admin/structure/views/view/openscience_movies/delete
     122 1. https://dev-www-3.clarin.eu/admin/structure/views/view/openscience_popular_content/delete
     123 1. https://dev-www-3.clarin.eu/admin/structure/views/view/featured_lrt_showcase/delete
     124 1. https://dev-www-3.clarin.eu/admin/structure/views/view/featured_showcase/delete
     125 1. https://dev-www-3.clarin.eu/admin/structure/views/view/lrtshowcases/delete
    119126
    120127## Enhance functionality before testing ##
    … …  
    156163wget https://github.com/woothemes/FlexSlider/raw/version/2.2/fonts/flexslider-icon.woff
    157164}}}
    158 
    159 1. [https://dev-www-3.clarin.eu/admin/config/system/smtp -> Disable Drupal queue]
     165 1. [https://dev-www-3.clarin.eu/admin/config/system/smtp -> Disable Drupal queue]
    160166
    161167## Content restructuring tasks ##
    … …  
    165171Restructure content so that excess hierarchy is flattened.
    166172
    167 Each page title should exactly match the related menu item's title, to reduce confusion. This becomes more important as the navigation on the website changes with the new CLARIN Horizon theme.
    168 For example, [https://www.clarin.eu/webform/clarin-related-research-and-activities-user-involvement here] this rule was broken.
    169 In case the page title is considered too long for the menu, shorten it to a single, brief title.
    170 
    171 1. [https://www.clarin.eu/node/3788 Two children that are not truly siblings].
    172 2. [https://www.clarin.eu/node/4006 Has a single child node: poor, deep structure].
    173 3. [https://www.clarin.eu/node/3626 Not really clear what should be listed here as ‘Services’ and what entries are merely one software package]. The ranking/importance of items is not clear (and as it stands based on current items and order, is bad). Sander suggests that this page be more general and that it refers to /applications.
     173Each page title should exactly match the related menu item's title, to reduce confusion. This becomes more important as the navigation on the website changes with the new CLARIN Horizon theme. For example, [https://www.clarin.eu/webform/clarin-related-research-and-activities-user-involvement here] this rule was broken. In case the page title is considered too long for the menu, shorten it to a single, brief title.
     174
     175 1. [https://www.clarin.eu/node/3788 Two children that are not truly siblings].
     176 1. [https://www.clarin.eu/node/4006 Has a single child node: poor, deep structure].
     177 1. [https://www.clarin.eu/node/3626 Not really clear what should be listed here as ‘Services’ and what entries are merely one software package]. The ranking/importance of items is not clear (and as it stands based on current items and order, is bad). Sander suggests that this page be more general and that it refers to /applications.
    174178
    175179### Language use ###
    … …  
    177181The website has quite some pages and text with insufficient editorial quality. The basic rule should be that pages ''aren't published'' before someone who is good at that has reviewed the editorial quality.
    178182
    179 '''Example''':
    180 ''Every year, the CLARIN - the Common Language Resources and Technology Infrastructure - holds an annual meeting. 2013 the meeting was held in Prague, information on the event can be found here.''
    181 
    182 1. Keep sentences short. ‘Information on the event can be found here’ -> ‘annual meeting’ (= link).
    183 2. Do not redeclare abbreviations inconsistently. Ideally, do not declare them at all outside the Glossary and/or About pages.
    184 3. Check whether you are writing redundantly. E.g., ‘annual meetings’ are always ‘every year’.
    185 4. ‘. 2013 the’: missing words. Edit your text carefully (certainly if the text is published).
     183'''Example''': ''Every year, the CLARIN - the Common Language Resources and Technology Infrastructure - holds an annual meeting. 2013 the meeting was held in Prague, information on the event can be found here.''
     184
     185 1. Keep sentences short. ‘Information on the event can be found here’ -> ‘annual meeting’ (= link).
     186 1. Do not redeclare abbreviations inconsistently. Ideally, do not declare them at all outside the Glossary and/or About pages.
     187 1. Check whether you are writing redundantly. E.g., ‘annual meetings’ are always ‘every year’.
     188 1. ‘. 2013 the’: missing words. Edit your text carefully (certainly if the text is published).
    186189
    187190### Misc ###
    188191
    189 1. [https://www.clarin.eu/content/short-guides Image HTML tags used to reference attachment files]. Use something else, now it renders as broken images.
    190 2. Decide which language variety and terms to use, and use them consistently.
    191     1. Center -> centre
    192     2. movies, films -> clips
    193     3. federated login / federated identity / federation / ... ?
    194 3. Decide on table style(s), describe the chosen style(s) in the CLARIN Style guide, and apply style(s) to all tables across the website by means of the CLARIN Horizon theme, ''not'' by separately styling each table. Currently, various style-influencing and noise attributes are in the HTML code for many pages.
    195     1. [https://www.clarin.eu/content/web-services Tables should have table headings]. If not, is a table appropriate?
    196     2. [https://www.clarin.eu/applications Unnecessary final column, should be merged with first column].
    197 4. [https://www.clarin.eu/content/federated-content-search-clarin-fcs Too drafty]. Diagrams should be properly rendered, realize that it is ''not an (internal) Trac page''.
    198 5. Simplify/clean up hard-to-read, excess, noisy HTML code. E.g. in:
    199     1. https://www.clarin.eu/node/4101/edit
    200     2. https://www.clarin.eu/node/4102/edit
    201     3. https://www.clarin.eu/node/3449/edit
    202 6. Are page summaries (top text field in node editing view) really needed? They are being generated automatically if left empty. If manually specified, what is the policy for keeping them in sync with the content?
    203 7. Find in page contents (HTML) improper absolute links (e.g. `http://www.clarin.eu/content/...`) and replace them with proper relative links (`/node/...`).
     192 1. [https://www.clarin.eu/content/short-guides Image HTML tags used to reference attachment files]. Use something else, now it renders as broken images.
     193 1. Decide which language variety and terms to use, and use them consistently.
     194   1. Center -> centre
     195   1. movies, films -> clips
     196   1. federated login / federated identity / federation / ... ?
     197 1. Decide on table style(s), describe the chosen style(s) in the CLARIN Style guide, and apply style(s) to all tables across the website by means of the CLARIN Horizon theme, ''not'' by separately styling each table. Currently, various style-influencing and noise attributes are in the HTML code for many pages.
     198   1. [https://www.clarin.eu/content/web-services Tables should have table headings]. If not, is a table appropriate?
     199   1. [https://www.clarin.eu/applications Unnecessary final column, should be merged with first column].
     200 1. [https://www.clarin.eu/content/federated-content-search-clarin-fcs Too drafty]. Diagrams should be properly rendered, realize that it is ''not an (internal) Trac page''.
     201 1. Simplify/clean up hard-to-read, excess, noisy HTML code. E.g. in:
     202   1. https://www.clarin.eu/node/4101/edit
     203   1. https://www.clarin.eu/node/4102/edit
     204   1. https://www.clarin.eu/node/3449/edit
     205 1. Are page summaries (top text field in node editing view) really needed? They are being generated automatically if left empty. If manually specified, what is the policy for keeping them in sync with the content?
     206 1. Find in page contents (HTML) improper absolute links (e.g. `http://www.clarin.eu/content/...`) and replace them with proper relative links (`/node/...`).
    204207
    205208## Acceptance tests ##
    206209
    207 1. Adding a basic page.
    208 2. Uploading multiple files in one go.
    209 3. Writing a blog post.
    210 4. Filling out the Centre Registry form.
    211 5. TODO: ...
     210 1. Adding a basic page.
     211 1. Uploading multiple files in one go.
     212 1. Writing a blog post.
     213 1. Filling out the Centre Registry form.
     214 1. TODO: ...
    212215
    213216### Criteria ###
    … …  
    252255chown -Rc '0:www-data' 'CLARIN_Horizon/'
    253256}}}
    254 
    255 1. [https://dev-www-3.clarin.eu/admin/appearance/ -> Enable and set as default theme ‘CLARIN_Horizon’]
    256 2. [https://dev-www-3.clarin.eu/admin/config/content/formats/safe_html CKeditor: stop filtering content].
    257   1. `safe_html` -> `table[width|cellspacing|class]`.
    258   2. ‘Rules for Class Names’ -> `table`.
    259   3. ‘Rules for URLs used within inline styles’ -> `/*`. (???)
    260 3. [https://dev-www-3.clarin.eu/admin/appearance/settings/CLARIN_Horizon -> ‘bordered table’]
     257 1. [https://dev-www-3.clarin.eu/admin/appearance/ -> Enable and set as default theme ‘CLARIN_Horizon’]
     258 1. [https://dev-www-3.clarin.eu/admin/config/content/formats/safe_html CKeditor: stop filtering content].
     259   1. `safe_html` -> `table[width|cellspacing|class]`.
     260   1. ‘Rules for Class Names’ -> `table`.
     261   1. ‘Rules for URLs used within inline styles’ -> `/*`. (???)
     262 1. [https://dev-www-3.clarin.eu/admin/appearance/settings/CLARIN_Horizon -> ‘bordered table’]
    261263
    262264## Acceptance tests ##
    … …  
    302304## Remove LRT Showcase content type: if adding a content node, this content type is picked.
    303305}}}
    304 
    305306## Acceptance test ##
    306307
    307308(details to be added)
    308309
    309 * working frontpage
    310 * event list
    311 * news + blog list
    312 * contact page
    313 * views/static pages for: committees (governance), showcases, featured resources
    314 * intranet pages (drupal groups) reachable and usable
    315 * redirect /user/register to CLARIN IdP
     310 * working frontpage
     311 * event list
     312 * news + blog list
     313 * contact page
     314 * views/static pages for: committees (governance), showcases, featured resources
     315 * intranet pages (drupal groups) reachable and usable
     316 * redirect /user/register to CLARIN IdP
    316317
    317318## Finishing touch ##
    … …  
    319320### Enhancement: do not use CDN. ###
    320321
    321 IMPORTANT: breaks the website without alternative source other than CDN.
    322 [https://www.clarin.eu/admin/appearance/settings/bootstrap Make independent from `jsdeliver`: -> Advanced]
     322IMPORTANT: breaks the website without alternative source other than CDN. [https://www.clarin.eu/admin/appearance/settings/bootstrap Make independent from `jsdeliver`: -> Advanced]
    323323
    324324### Clean up content types ###
    … …  
    327327
    328328Although these node have a similar (technical/internal) name (due to a misconception earlier on), they are fundamentally different: the showcases are more elaborate descriptions of how a CLARIN tool or resource can be used to answer a specific question. The featured resources (LRT Showcase) are simple examples of resources/tools. Many of them have a searchbox included. They should not be merged.
    329