Skip to content

Commit

Permalink
feat: inform users of the calculation changes (#32)
Browse files Browse the repository at this point in the history
Update the notification in the start page to describe what has changed
and its relation to the result averages.
Add links to this repository and the releases page, which will, in the
future, contain the change log of the system


![image](https://github.com/user-attachments/assets/3010ee8c-e3a9-400d-b5b3-87e799bed6c7)

---------

Co-authored-by: SaraKoskelainen <[email protected]>
  • Loading branch information
spaasis and SaraKoskelainen authored Oct 15, 2024
1 parent e77b50a commit 844aa5b
Show file tree
Hide file tree
Showing 9 changed files with 36 additions and 3 deletions.
14 changes: 14 additions & 0 deletions src/components/BaseFooter.vue
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,20 @@
>
API
</a>
<a
href="https://github.com/sykefi/climatediet"
target="_blank"
rel="noopener"
>
{{ $t('$openSource') }}
</a>
<a
href="https://github.com/sykefi/climatediet/releases"
target="_blank"
rel="noopener"
>
{{ $t('$changeLogLink') }}
</a>
<a href="mailto:[email protected]">[email protected]</a>
</div>
<div id="foot-fill2" />
Expand Down
2 changes: 2 additions & 0 deletions src/locale/en/footer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@ const en: IFooterTranslations = {
$termsOfUse: 'Terms of use',
$share: 'Share on',
$accessibility: 'Accessibility',
$changeLogLink: 'Change log',
$openSource: 'Open source',
}
export default en
3 changes: 2 additions & 1 deletion src/locale/en/start.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const en: IStartViewTranslations = {
$groupCodeError:
'Group code verification failed. It is either expired or does not exist. Check the code and try again.',
$infoForUsers:
'NB: The carbon footprint coefficients of different products and services will be updated. It means that your calculated carbon footprint will change, even if you enter the same data as earlier about your consumption. In addition, reference values like the carbon footprints of average consumption (shown in the result figure) will change. However, your own result history will not change.',
'The carbon footprint coefficients of housing, food and consumption have been updated with the newest research data. The results generated by the old calculation model are no longer available as averages of the results, but for logged in users their own result history will remain available for browsing. See what has changed in the ',
$postalCode: 'Postal code',
$postalCodeDetails:
'The postal code is used in estimating energy consumption and regional comparisons. Postal codes in Finland consist of five numbers.',
Expand All @@ -31,6 +31,7 @@ const en: IStartViewTranslations = {
$registrationInfo:
'Login each time you use the calculator to automatically store your results. Login is done via email and a single-use code, no passwords required. You can see your result history in the "Results" tab.',
$termsOfUseInfo: 'Before continuing, familiarize yourself with the ',
$changelog: 'change log',
}

export default en
2 changes: 2 additions & 0 deletions src/locale/fi/footer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@ const fi: IFooterTranslations = {
$termsOfUse: 'Käyttöehdot',
$share: 'Jaa',
$accessibility: 'Saavutettavuusseloste',
$changeLogLink: 'Muutosloki',
$openSource: 'Avoin lähdekoodi',
}
export default fi
3 changes: 2 additions & 1 deletion src/locale/fi/start.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,15 @@ const fi: IStartViewTranslations = {
$groupCodeError:
'Ryhmäkoodin varmistaminen epäonnistui. Koodi on joko vanhentunut tai sitä ei ole olemassa. Tarkista koodi ja yritä uudelleen.',
$infoForUsers:
'HUOM! Laskurin päästökertoimia päivitetään. Tämän takia tuloksesi tulee muuttumaan, vaikka syöttäisit samat tiedot kulutuksestasi kuin aiemminkin. Myös vertailuarvoihin kuten suomalaisten kulutuksen keskiarvotuloksiin (tuloskuvassa) tulee muutoksia. Oma tuloshistoriasi pysyy ennallaan.',
'Laskurin päästökertoimia asumisen, ruuan ja kulutuksen osalta on päivitetty uusimman tutkimusdatan mukaisesti. Vanhalla laskentamallilla muodostetut tulokset eivät ole enää saatavilla tulosten keskiarvoina, mutta kirjautuneiden käyttäjien omat tuloshistoriat ovat edelleen selattavissa. Katso tarkemmat tiedot ',
$postalCode: 'Postinumero',
$postalCodeDetails:
'Postinumeroa käytetään asumisen energiankulutuksen arviointiin ja aluevertailuihin.',
$yearlyIncome: 'Henkilökohtaiset bruttotulot',
$siteSlogan: 'Laske ilmastovaikutuksesi ja aloita Ilmastodieetti!',
$registrationInfo: `Kirjaudu jokaisella laskurin käyttökerralla sähköpostiosoitteella ja sähköpostitse saamallasi kertakäyttöisellä koodilla. Näin tuloshistoriasi tallentuu automaattisesti. Pääset katsomaan aiempia hiilijalanjälkituloksiasi ”Tulokset”-välilehdellä.`,
$termsOfUseInfo: 'Ennen jatkamista, varmista että olet lukenut ',
$changelog: 'muutoslokista',
}

export default fi
3 changes: 3 additions & 0 deletions src/locale/interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export interface IStartViewTranslations {
$yearlyIncome: string
$siteSlogan: string
$termsOfUseInfo: string
$changelog: string
}

export interface ICreateGroupCodeTranslations {
Expand Down Expand Up @@ -481,6 +482,8 @@ export interface IFooterTranslations {
$termsOfUse: string
$share: string
$accessibility: string
$openSource: string
$changeLogLink: string
}

export interface IGlobalTranslations {
Expand Down
2 changes: 2 additions & 0 deletions src/locale/sv/footer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,7 @@ const sv: IFooterTranslations = {
$calculationInfo: 'Beräkningsgrunder',
$termsOfUse: 'Användarvillkor',
$share: 'Dela',
$changeLogLink: 'Ändringsloggen',
$openSource: 'Öppen källkod',
}
export default sv
3 changes: 2 additions & 1 deletion src/locale/sv/start.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,15 @@ const sv: IStartViewTranslations = {
$groupCodeError:
'Det gick inte att bekräfta gruppkoden. Koden är antingen förfallen eller så existerar den inte. Kontrollera koden och försök igen.',
$infoForUsers:
'OBS! Utsläppsfaktorerna för räknaren uppdateras. Därför kommer ditt resultat att förändras, även om du matar in samma uppgifter om din konsumtion som tidigare. Även jämförelsevärden såsom genomsnittsresultaten för finländarnas konsumtion (i resultatbilden) kommer att ändras. Din egen resultatshistorik förblir oförändrad.',
'Utsläppsfaktorerna för boende, mat och konsumtion har uppdaterats med den senaste forskningsdatan. Resultaten från den tidigare kalkylatorversionen är inte längre tillgängliga i genomsnitt, men för inloggade användare kommer resultathistoriken att vara tillgänglig för granskning. Se vad som har ändrats i',
$postalCode: 'Postnummer',
$postalCodeDetails:
'Postnumret används för uppskattning av boendets energiförbrukning och för områdesjämförelser.',
$yearlyIncome: 'Personlig bruttoinkomst',
$siteSlogan: 'Räkna ut din klimatpåverkan och börja Klimatdieten!',
$registrationInfo: `Logga in med e-postadress och den engångskod du får per e-post varje gång du använder kalkylatorn. Då sparas dina resultat automatiskt. Du kommer åt dina tidigare klimatavtryck på fliken Resultat.`,
$termsOfUseInfo: 'Innan du fortsätter, säkerställ att du har läst ',
$changelog: 'ändringsloggen',
}

export default sv
7 changes: 7 additions & 0 deletions src/views/start/StartView.vue
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
<h1>{{ $t('$siteSlogan') }}</h1>
<div v-if="$t('$infoForUsers') != ''" class="infoBox">
{{ $t('$infoForUsers') }}
<a
href="https://github.com/sykefi/climatediet/releases"
target="_blank"
rel="noopener"
>
{{ $t('$changelog') }}
</a>
</div>
<form @submit.prevent="submit(false)" class="calc-form">
<SubForm
Expand Down

0 comments on commit 844aa5b

Please sign in to comment.