Merge branch 'master' into release

README.md

@@ -53,26 +53,36 @@ which should be updated with `master` only to make new releases.
 
 ## Publishing releases
 
-The Electron Forge's [Github publisher](https://www.electronforge.io/config/publishers/github) is used to upload files and draft a new release,
-thus avoiding the need to upload and tag releases manually.
+The Electron Forge's [Github publisher](https://www.electronforge.io/config/publishers/github) is
+used to upload files and draft a new release, thus avoiding the need to upload and tag releases
+manually.
 
-The resulting draft must be reviewed, edited and approved in Github to make it publically available to everyone.
-This allows testing the package and making final fixes to it before making it public.
+The resulting draft must be reviewed, edited and approved in Github to make it publically available
+to everyone. This allows testing the package and making final fixes to it before making it public.
 
 1. Test and bring all the desired changes in the `master` branch.
-1. Remove if there's word `SNAPSHOT` in `version` field of [package.json](./package.json), and update version as per semver practises.
-    - See also: [Semantic Versioning](https://semver.org/)
+1. Remove if there's word `SNAPSHOT` in `version` field of [package.json](./package.json), and
+   update version as per [semver practises](https://semver.org/).
 1. Switch to `release` branch
 1. Merge `master` to `release` and push to remote
     - `$ git merge master`
     - `$ git push`
-1. Wait for [GitHub Actions](https://github.com/HSLdevcom/helmet-ui/actions) to build the application.
-1. Go to [releases page](https://github.com/HSLdevcom/helmet-ui/releases) page and **Edit** the newly created draft.
+1. Wait for [GitHub Actions](https://github.com/HSLdevcom/helmet-ui/actions) to build the
+   application.
+1. Go to [releases page](https://github.com/HSLdevcom/helmet-ui/releases) page and **Edit** the
+   newly created draft.
     1. Ensure the release name corresponds to version number
     1. Write a brief description (new features, changes, fixes etc)
     1. Check/uncheck the pre-release checkbox as needed.
     1. Select `release` branch as the target for tagging
     1. Press **Publish release** when all is good.
-    1. Switch back to `master` branch and update the version number matching the release. This can be updated to indicate a [snapshot](http://codethataint.com/blog/what-are-maven-snapshots/) before next release (e.g. `1.3.0-SNAPSHOT`) while said release (`1.3.0`) is in development, if necessary.
-
-_Notice: you cannot create drafts with an existing version number (i.e. release name). Thus, any intermediate drafts must be deleted before pushing final tweaks and fixes for the version about to be released._
+1. Switch back to `master` branch and update the version number matching the release. This can be
+   updated to indicate a [snapshot](http://codethataint.com/blog/what-are-maven-snapshots/) before
+   next release (e.g. `1.3.0-SNAPSHOT`) while said release (`1.3.0`) is in development, if necessary.
+    1. [`package.json#L4`](https://github.com/HSLdevcom/helmet-ui/blob/15a7c6e5ae020b8048907a7498d0d534a68ce21b/package.json#L4)
+    1. [`package-lock.json#L3`](https://github.com/HSLdevcom/helmet-ui/blob/15a7c6e5ae020b8048907a7498d0d534a68ce21b/package-lock.json#L3)
+       and [`#L9`](https://github.com/HSLdevcom/helmet-ui/blob/15a7c6e5ae020b8048907a7498d0d534a68ce21b/package-lock.json#L9)
+
+:warning: You cannot create drafts with an existing version number (i.e. release name). Thus, any
+intermediate drafts must be deleted before pushing final tweaks and fixes for the version about to
+be released.

docs/HSL-mallitoiden_tilaajan_ohje.md

@@ -1,5 +1,5 @@
 ---
-sort: 7
+sort: 8
 ---
 
 # Ohje HSL:n mallitöiden tilaamiseen
@@ -12,14 +12,28 @@ Yleistietoa HSL:n Helmet-mallista, sen lähtötiedoista, epävarmuuksista ja tul
 
 ## Mallitöiden tilaaminen
 
-Työohjelmaa laadittaessa ole yhteydessä HSL:n malliasiantuntijoihin (Jens West, Mervi Vatanen). Heiltä saat apua mm. lähtötietojen ja skenaarioiden määrittelyyn sekä dokumentointiin. Pääsääntöisesti töiden lähtötietoina käytetään HSL:n virallisia aineistoja, joita projekteissa sitten muokataan. Pohja-aineiston valinnassa kannattaa ottaa kyseisen projektin tarpeiden lisäksi huomioon myös mahdolliset tarpeet käyttää projektin tuloksia ja koodauksia jatkossa. Hankearvioinneissa vertailuvaihtoehdossa tulee aina olla mukana vain jo päätetyt hankkeet, muissa tarkasteluissa tutkittavat verkkovaihtoehdot voidaan valita vapaammin. Hankearvioinneista lisätietoa Väyläviraston hankearviointiohjeissa.
+Työohjelmaa laadittaessa ole yhteydessä HSL:n malliasiantuntijoihin (Johanna Piipponen, Mervi Vatanen).
+Heiltä saat apua mm. lähtötietojen ja skenaarioiden määrittelyyn sekä dokumentointiin.
+Pääsääntöisesti töiden lähtötietoina käytetään HSL:n virallisia aineistoja, joita projekteissa sitten muokataan.
+Pohja-aineiston valinnassa kannattaa ottaa kyseisen projektin tarpeiden lisäksi huomioon myös mahdolliset tarpeet käyttää projektin tuloksia ja koodauksia jatkossa.
+Hankearvioinneissa vertailuvaihtoehdossa tulee aina olla mukana vain jo päätetyt hankkeet,
+muissa tarkasteluissa tutkittavat verkkovaihtoehdot voidaan valita vapaammin.
+Hankearvioinneista lisätietoa Väyläviraston hankearviointiohjeissa.
 
-Pääsääntöisesti HSL:n tilaamien konsulttitöiden nollavaihtoehto laaditaan HSL:ssä. Pohjaverkkona toimii yleensä HSL:n tuorein verkkokuvaus, mutta jos niissä on paljon MAL-työn jälkeen tehtyjä muutoksia, herkkyystarkasteluja tehdään myös edellisen MAL-kierroksen virallisissa verkoissa. Töiden aloituksessa on huomioitava, että nollavaihtoehdon laatiminen vie pari viikkoa.
+Pääsääntöisesti HSL:n tilaamien konsulttitöiden nollavaihtoehto laaditaan HSL:ssä.
+Pohjaverkkona toimii yleensä HSL:n tuorein verkkokuvaus, mutta jos niissä on paljon MAL-työn jälkeen tehtyjä muutoksia,
+herkkyystarkasteluja tehdään myös edellisen MAL-kierroksen virallisissa verkoissa.
+Töiden aloituksessa on huomioitava, että nollavaihtoehdon laatiminen vie pari viikkoa.
 
-Työn tilausvaiheessa varmista, että konsultti tuntee ja käyttää HSL:n laatimia mallin [käyttö-](mallitoiden_yleisohje.md) ja [dokumentointiohjeita](HSL-toiden_dokumentointi.md). Näitä ohjeita tulee noudattaa, jotta voidaan varmistua mallitarkastelujen tulosten luotettavuudesta sekä hyödynnettävyydestä jatkotarkasteluissa.
+Työn tilausvaiheessa varmista, että konsultti tuntee ja käyttää HSL:n laatimia
+mallin [käyttö-](mallitoiden_yleisohje.md) ja [dokumentointiohjeita](HSL-toiden_dokumentointi.md).
+Näitä ohjeita tulee noudattaa, jotta voidaan varmistua mallitarkastelujen tulosten luotettavuudesta sekä hyödynnettävyydestä jatkotarkasteluissa.
 
-Työn valmistuessa varmista, että sen tulokset ja malliaineistot toimitetaan HSL:n malliasiantuntijoille ohjeissa määritellyssä muodossa. Projektin päättyessä sovitaan myös, viedäänkö työn lopputuloksia jatkossa osaksi HSL:n virallisia [lähtötietoja](HSL_lahtotiedot.md) seuraavia projekteja varten.
+Työn valmistuessa varmista, että sen tulokset ja malliaineistot toimitetaan HSL:n malliasiantuntijoille ohjeissa määritellyssä muodossa.
+Projektin päättyessä sovitaan myös, viedäänkö työn lopputuloksia jatkossa osaksi HSL:n virallisia [lähtötietoja](HSL_lahtotiedot.md) seuraavia projekteja varten.
 
 ## Menneiden projektien aineistot
 
-Projektin päättyessä HSL:n malliasiantuntijat tallentavat saadut aineistot verkkolevylle arkistoon. Täältä voi tarvittaessa poimia aineistoja myöhempää käyttöä varten. Ennen aineistojen käyttöä, olethan yhteydessä malliasiantuntijoihin.
+Projektin päättyessä HSL:n malliasiantuntijat tallentavat saadut aineistot verkkolevylle arkistoon.
+Täältä voi tarvittaessa poimia aineistoja myöhempää käyttöä varten.
+Ennen aineistojen käyttöä, olethan yhteydessä malliasiantuntijoihin.

docs/HSL-toiden_dokumentointi.md

@@ -1,39 +1,57 @@
 ---
-sort: 8
+sort: 9
 ---
 
 # HSL:n mallitöiden dokumentointiohje
 
-Tässä ohjeessa kuvataan mallitöiden dokumentointi HSL:n tilaamissa töissä. Ohjeita voi toki soveltaa myös muissa projekteissa. Ohjeeseen kannattaa perehtyä jo työn aloitusvaiheessa, jotta työskentelytavat tukevat parhaiten tarvittavien dokumenttien tuottamista.
+Tässä ohjeessa kuvataan mallitöiden dokumentointi HSL:n tilaamissa töissä.
+Ohjeita voi toki soveltaa myös muissa projekteissa.
+Ohjeeseen kannattaa perehtyä jo työn aloitusvaiheessa, jotta työskentelytavat tukevat parhaiten tarvittavien dokumenttien tuottamista.
 
-HSL:n tilaamissa töissä kaikki tehdyt muutokset tulee dokumentoida mallitekniseen muistioon ja tallentaa lisäksi muutostiedostot ja/tai muokatut lähtötiedot. Alla on kuvattu tarkemmin mallitöissä tuotettavia ja HSL:lle luovutettavia aineistoja. Lisäohjeita saat tarvittaessa HSL:n yhteyshenkilöiltä.
+HSL:n tilaamissa töissä kaikki tehdyt muutokset tulee dokumentoida mallitekniseen muistioon ja tallentaa lisäksi muutostiedostot ja/tai muokatut lähtötiedot.
+Alla on kuvattu tarkemmin mallitöissä tuotettavia ja HSL:lle luovutettavia aineistoja.
+Lisäohjeita saat tarvittaessa HSL:n yhteyshenkilöiltä.
 
 [Mallin käyttöön](mallitoiden_yleisohje.md) ja [lähtötietojen muokkaamiseen](mallin_lahtotietotiedostot.md) löydät lisätietoja edellisten linkkien kautta.
 
 ## Luovutettavat aineistot
 
-Työn päättyessä toimita HSL:n yhteyshenkilölle tässä luetellut aineistot. Tämän dokumentoinnin tavoitteena on helpottaa tulosten tulkintaa, mahdollistaa tulosten toistettavuus ja helpottaa aineistojen jatkohyödyntämistä.
+Työn päättyessä toimita HSL:n yhteyshenkilölle tässä luetellut aineistot.
+Tämän dokumentoinnin tavoitteena on helpottaa tulosten tulkintaa, mahdollistaa tulosten toistettavuus ja helpottaa aineistojen jatkohyödyntämistä.
 
 ### Mallitarkastelujen yleiskuvaus
 
-Kirjaa tehdyistä tarkasteluista ja verkkomuutoksista yleiskuvaus omaan dokumenttiinsa ja kirjaa vastaavat asiat myös työn raporttiin. Esimerkkinä voi käyttää lähtöaineistojen yhteydessä olevia yleiskuvauksia.
+Kirjaa tehdyistä tarkasteluista ja verkkomuutoksista yleiskuvaus omaan dokumenttiinsa ja kirjaa vastaavat asiat myös työn raporttiin.
+Esimerkkinä voi käyttää lähtöaineistojen yhteydessä olevia yleiskuvauksia.
 
 Kuvaa lyhyesti myös mm. mahdollisten poikkeavien skriptien ja parametrien käyttö. 
 
 ### Mallitekninen muistio
 
-Työn mallitekniseen toteutukseen liittyvät huomiot kirjataan mallitekniseen muistioon, joka luovutetaan työn päättyessä. Kirjaa käytetyt lähtötiedot ja kaikki näihin tehdyt muutokset mallitekniseen muistioon. Merkinnästä tulee käydä ilmi, mitä kysyntä- ja tarjontakuvauksen tai malliajon osaa ja ominaisuuksia on muokattu. Merkitse myös muutosmakro (ems-tiedosto), jolla muutos on toistettavissa ja josta käyvät ilmi käytetyt lukuarvot, tai lähtötietotiedosto, johon muutokset on viety. Jos olet lisännyt verkolle solmuja, listaa käyttämäsi uudet solmunumerot. HUOM. Virallisia solmuja saa koodata vain, jos siitä sovitaan erikseen HSL:n kanssa. Pääsääntönä käytetään aina villejä solmunumeroita (ks. raportti Helsingin seudun liikenteen Emme-verkon kuvaus, joka on saatavilla EXT-Helmet -Teams-ryhmässä). Kirjaa muistioon, mistä tiedostoista ja/tai kansioista eri tiedot löytyvät.
+Työn mallitekniseen toteutukseen liittyvät huomiot kirjataan mallitekniseen muistioon, joka luovutetaan työn päättyessä.
+Kirjaa käytetyt lähtötiedot ja kaikki näihin tehdyt muutokset mallitekniseen muistioon.
+Merkinnästä tulee käydä ilmi, mitä kysyntä- ja tarjontakuvauksen tai malliajon osaa ja ominaisuuksia on muokattu.
+Merkitse myös muutosmakro (ems-tiedosto), jolla muutos on toistettavissa ja josta käyvät ilmi käytetyt lukuarvot, tai lähtötietotiedosto, johon muutokset on viety.
+Jos olet lisännyt verkolle solmuja, listaa käyttämäsi uudet solmunumerot.
+HUOM. Virallisia solmuja saa koodata vain, jos siitä sovitaan erikseen HSL:n kanssa.
+Pääsääntönä käytetään aina villejä solmunumeroita (ks. raportti Helsingin seudun liikenteen Emme-verkon kuvaus, joka on saatavilla EXT-Helmet -Teams-ryhmässä).
+Kirjaa muistioon, mistä tiedostoista ja/tai kansioista eri tiedot löytyvät.
 
 Dokumentoi muistioon myös muutosten perustelut.
 
 ### Tallennettavat muutos- ja lähtötietotiedostot 
 
-* Tallenna kaikista tekemistäsi muutoksista muokatut versiot lähtötietotiedostoista tilaajalle toimitettavaksi
-* Tallenna muutosmakrot kaikista tekemistäsi muutoksista: Tallenna kaikista muutoksista ems-tiedostot, ja nimeä tiedostot hankkeen/muutoksen mukaan. Tallenna eri skenaarioiden (myös eri tarkasteluvuodet) muutokset eri tiedostoihin. Muutokset voi tarvittaessa jakaa vieläkin useampaan osaan, sillä pieniä osia on helpompi jatkokäsitellä kuin liian suuria paloja. Koodaa aina erikseen autoverkolle, joukkoliikenneverkolle (sis. vaihdot) ja joukkoliikennelinjastoon tehtävät muutokset, jotta näistä muodostuu erilliset muutostiedostot.
-* Tarjontamuutoksista (linjat ja vuorovälit), joista ei ole .ems-tiedostoja, toimita tilaajalle muokatut lähtötiedostot, ja kirjaa mallitekniseen muistioon, mitä muutoksia olet tehnyt, esim.:
-  * Linja 10141 ja 10142 reittimuutos Töölössä
-  * Linja 25501 ja 25502 uudet vuorovälit
-  * Solmut 123456 ja 123457 lisätty label-tiedot
+- Tallenna kaikista tekemistäsi muutoksista muokatut versiot lähtötietotiedostoista tilaajalle toimitettavaksi
+- Tallenna muutosmakrot kaikista tekemistäsi muutoksista: Tallenna kaikista muutoksista ems-tiedostot, ja nimeä tiedostot hankkeen/muutoksen mukaan.
+  Tallenna eri skenaarioiden (myös eri tarkasteluvuodet) muutokset eri tiedostoihin.
+  Muutokset voi tarvittaessa jakaa vieläkin useampaan osaan, sillä pieniä osia on helpompi jatkokäsitellä kuin liian suuria paloja.
+  Koodaa aina erikseen autoverkolle, joukkoliikenneverkolle (sis. vaihdot) ja joukkoliikennelinjastoon tehtävät muutokset,
+  jotta näistä muodostuu erilliset muutostiedostot.
+- Tarjontamuutoksista (linjat ja vuorovälit), joista ei ole .ems-tiedostoja, toimita tilaajalle muokatut lähtötiedostot,
+  ja kirjaa mallitekniseen muistioon, mitä muutoksia olet tehnyt, esim.:
+  - Linja 10141 ja 10142 reittimuutos Töölössä
+  - Linja 25501 ja 25502 uudet vuorovälit
+  - Solmut 123456 ja 123457 lisätty label-tiedot
 
 ### Muokatut malliskriptit
 
@@ -45,10 +63,11 @@ Työn päättyessä HSL:lle palautetaan työn Emme-pankki, jossa on kaikki tarka
 
 ### Emmen worksheetit
 
-Tallenna luovutettavaan aineistoon tuloksissa esiteltävistä raporttikuvista Emmen worksheetit sekä mahdolliset tunnuslukujen laskentakaavat, joiden avulla raportit ovat helposti toistettavissa. Kuvaa tunnuslukujen laskentakaavat projektin raportissa, tai ainakin malliteknisessä muistiossa.
+Tallenna luovutettavaan aineistoon tuloksissa esiteltävistä raporttikuvista Emmen worksheetit sekä mahdolliset tunnuslukujen laskentakaavat,
+joiden avulla raportit ovat helposti toistettavissa.
+Kuvaa tunnuslukujen laskentakaavat projektin raportissa, tai ainakin malliteknisessä muistiossa.
 
 ### Emmen ulkopuolisten analyysien dokumentointi
 
-Mikäli työn yhteydessä laaditaan lisätarkasteluja esim. paikkatieto-ohjelmalla, tulee myös näissä mahdollisesti käytetyt laskentakaavat dokumentoida mallitekniseen muistioon.
-
-
+Mikäli työn yhteydessä laaditaan lisätarkasteluja esim. paikkatieto-ohjelmalla, tulee myös näissä mahdollisesti käytetyt laskentakaavat
+dokumentoida mallitekniseen muistioon.