From 130223584271ffe4dc99aefe4c15745ad7798f45 Mon Sep 17 00:00:00 2001 From: kewang Date: Wed, 6 Sep 2017 15:17:19 +0800 Subject: [PATCH 1/3] Use official Traditional Chinese name --- config.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/config.rb b/config.rb index b64fe7d..93653cf 100644 --- a/config.rb +++ b/config.rb @@ -77,8 +77,8 @@ $languages = { notice: "最新版 (#{$last_version}) 暂时还没有翻译到简体中文，您可以阅读最新的英语版，并且帮助翻译，不胜感激。" }, "zh-TW" => { - name: "繁體中文", - notice: "最新版 (#{$last_version}) 暫時還沒有翻譯到繁體中文，您可以閱讀最新的英語版，並且幫助翻譯，不勝感激。" + name: "正體中文", + notice: "最新版 (#{$last_version}) 暫時還沒有翻譯到正體中文，您可以閱讀最新的英語版，並且幫助翻譯，不勝感激。" } } From fc4d21db347b5bedcb9f65e3b85027d71934ca80 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Wed, 4 Oct 2017 00:20:17 +0200 Subject: [PATCH 2/3] Make the website use responsive design This makes it more readable on mobile devices. --- .../assets/stylesheets/application.css.sass | 5 +- source/assets/stylesheets/layout.sass | 32 +++++++++--- source/assets/stylesheets/sections.sass | 51 +++++++++++++------ 3 files changed, 65 insertions(+), 23 deletions(-) diff --git a/source/assets/stylesheets/application.css.sass b/source/assets/stylesheets/application.css.sass index 4dce326..21c00c6 100644 --- a/source/assets/stylesheets/application.css.sass +++ b/source/assets/stylesheets/application.css.sass @@ -33,7 +33,6 @@ h1 margin-bottom: 0 line-height: 1 text-transform: lowercase - width: 50% h2 font-size: 1.2em @@ -97,3 +96,7 @@ pre, code font-family: $source-code-font-family code white-space: nowrap + +@media (min-width: 1077px) + h1 + width: 50% diff --git a/source/assets/stylesheets/layout.sass b/source/assets/stylesheets/layout.sass index e0be2b5..ddcee3d 100644 --- a/source/assets/stylesheets/layout.sass +++ b/source/assets/stylesheets/layout.sass @@ -2,26 +2,28 @@ $break-small: em(480px) $break-medium: em(800px) $break-large: em(1024px) +body + margin: 0 + article margin: 0 auto - width: 65em + max-width: 65em .main background-color: $color-white - margin-bottom: 2em div - padding-left: 20% - padding-right: 20% + padding-left: 5% + padding-right: 5% padding-bottom: 3em aside background-color: lighten(desaturate($color-bark, 5%), 10%) margin-bottom: -3em - margin-left: -35% - margin-right: -35% + margin-left: -5% + margin-right: -5% margin-top: 3em - padding: 2em 20% + padding: 2em 5% text-align: center aside & @@ -41,3 +43,19 @@ article ul line-height: 1.5 list-style-type: square padding-left: 1em + +@media (min-width: 1077px) + body + margin: 8px + + .main + margin-bottom: 2em + + div + padding-left: 20% + padding-right: 20% + + aside + margin-left: -35% + margin-right: -35% + padding: 2em 20% diff --git a/source/assets/stylesheets/sections.sass b/source/assets/stylesheets/sections.sass index 517179e..eaee539 100644 --- a/source/assets/stylesheets/sections.sass +++ b/source/assets/stylesheets/sections.sass @@ -3,7 +3,7 @@ div.header padding-bottom: 0.1em background-color: $color-ocre background-image: image-url("bg-hero@2x.png") - background-size: 100% + background-size: cover h1 color: $color-sand @@ -33,8 +33,8 @@ div.header div.answers margin-top: 12em - padding-left: 25% - padding-right: 25% + padding-left: 5% + padding-right: 5% background-color: $color-white h3 @@ -61,14 +61,9 @@ div.answers h3 font-size: 1.6em font-weight: bold - width: 50% - - h4 - padding-left: 15em ul font-size: 1em - padding-left: 16em p a @@ -102,18 +97,16 @@ div.bad-practices font-size: 1.7em color: $color-gold float: left - width: 35% - h4, p - padding-left: 12em + p clear: left font-size: 1em div.effort padding-top: 2em - padding-left: 25% - padding-right: 25% + padding-left: 5% + padding-right: 5% background-color: $color-white h3 @@ -123,8 +116,8 @@ div.effort div.frequently-asked-questions padding-top: 2em - padding-left: 25% - padding-right: 25% + padding-left: 5% + padding-right: 5% background-color: $color-white h2 @@ -178,3 +171,31 @@ div.frequently-asked-questions content: "" display: table clear: both + +@media (min-width: 1077px) + div.answers + padding-left: 25% + padding-right: 25% + + div.effort + padding-left: 25% + padding-right: 25% + + div.frequently-asked-questions + padding-left: 25% + padding-right: 25% + + .good-practices + h3 + width: 50% + h4 + padding-left: 15em + ul + padding-left: 16em + + .bad-practices + h3 + width: 35% + + h4, p + padding-left: 12em From 00db5be66956041af84ca7c071b80f0d7c96ef9b Mon Sep 17 00:00:00 2001 From: Juraj Kostolansky Date: Tue, 17 Oct 2017 19:26:57 +0200 Subject: [PATCH 3/3] add slovak translation --- CHANGELOG.md | 1 + config.rb | 3 + source/sk/1.0.0/index.html.haml | 303 ++++++++++++++++++++++++++++++++ 3 files changed, 307 insertions(+) create mode 100644 source/sk/1.0.0/index.html.haml diff --git a/CHANGELOG.md b/CHANGELOG.md index b67645a..78cc4e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,6 +25,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - Brazilian Portugese translation from @aisamu. - Polish translation from @amielucha. - Russian translation from @aishek. +- Slovak translation from @jkostolansky. ### Changed - Start using "changelog" over "change log" since it's the common usage. diff --git a/config.rb b/config.rb index 93653cf..cee748b 100644 --- a/config.rb +++ b/config.rb @@ -60,6 +60,9 @@ $languages = { русский, но вы можете прочитать её на английском и помочь с переводом." }, + "sk" => { + name: "Slovenčina" + }, "sl" => { name: "Slovenščina" }, diff --git a/source/sk/1.0.0/index.html.haml b/source/sk/1.0.0/index.html.haml new file mode 100644 index 0000000..ef430df --- /dev/null +++ b/source/sk/1.0.0/index.html.haml @@ -0,0 +1,303 @@ +--- +description: Udržuj changelog +title: Udržuj changelog +language: sk +version: 1.0.0 +--- + +- changelog = "https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md" +- gemnasium = "https://gemnasium.com/" +- gh = "https://github.com/olivierlacan/keep-a-changelog" +- issues = "https://github.com/olivierlacan/keep-a-changelog/issues" +- semver = "http://semver.org/" +- shields = "http://shields.io/" +- thechangelog = "http://5by5.tv/changelog/127" +- vandamme = "https://github.com/tech-angels/vandamme/" +- iso = "http://www.iso.org/iso/home/standards/iso8601.htm" +- ghr = "https://help.github.com/articles/creating-releases/" + +.header + .title + %h1 Udržuj changelog + %h2 Nenechaj kamarátov sypať git logy do changelogov. + + = link_to changelog do + Verzia + %strong= current_page.metadata[:page][:version] + + %pre.changelog= File.read("CHANGELOG.md") + +.answers + %h3#what + %a.anchor{ href: "#what", aria_hidden: "true" } + Čo je to changelog? + + %p + Changelog je súbor obsahujúci organizovaný, chronologicky usporiadaný + zoznam významných zmien pre každú verziu daného projektu. + + %h3#why + %a.anchor{ href: "#why", aria_hidden: "true" } + Prečo udržiavať changelog? + + %p + Aby používatelia a prispievatelia presne vedeli, aké podstatné zmeny + sa udiali medzi jednotlivými vydaniami (alebo verziami) projektu. + + %h3#who + %a.anchor{ href: "#who", aria_hidden: "true" } + Kto potrebuje changelog? + + %p + Ľudia. Či už konzumenti, alebo vývojári, koncoví používatelia softvéru + sú ľudské bytosti, ktorým záleží na tom, čo softvér obsahuje. Keď sa + softvér zmení, ľudia chcú vedieť prečo a ako. + +.good-practices + %h3#how + %a.anchor{ href: "#how", aria_hidden: "true" } + Ako vytvorím dobrý changelog? + + %h4#principles + %a.anchor{ href: "#principles", aria_hidden: "true" } + Hlavné princípy + + %ul + %li + Changelogy sú pre ľudí, nie stroje. + %li + Changelog by mal obsahovať záznam pre každú jednu verziu. + %li + Rovnaké typy zmien by mali byť zoskupené. + %li + Mala by existovať možnosť odkazovať na jednotlivé verzie a sekcie. + %li + Posledná verzia je uvedená na prvom mieste. + %li + Pre každú verziu je uvedený dátum jej vydania. + %li + Uveď tiež, že sa držíš #{link_to "sémantického verziovania", semver}. + + %a.anchor{ href: "#types", aria_hidden: "true" } + %h4#types Typy zmien + + %ul + %li + %code Added + pre nové funkcie. + %li + %code Changed + pre zmeny existujúcej funkcie. + %li + %code Deprecated + pre funkcie, ktoré budú čoskoro odstránené. + %li + %code Removed + pre odstránené funkcie. + %li + %code Fixed + pre opravy chýb. + %li + %code Security + v prípade bezpečnostných zraniteľností. + +.effort + + %h3#effort + %a.anchor{ href: "#effort", aria_hidden: "true" } + Ako minimalizovať úsilie vynaložené na udržiavanie changelogu? + + %p + Udržuj Unreleased sekciu na začiatku changelogu + pre nadchádzajúce zmeny. + + %p Má to dva dôvody: + + %ul + %li + Ľudia môžu vidieť, aké zmeny môžu očakávať v ďalších vydaniach + %li + V čase vydávania novej verzie môžeš presunúť zmeny z + Unreleased sekcie do sekcie novej verzie + +.bad-practices + %h3#bad-practices + %a.anchor{ href: "#bad-practices", aria_hidden: "true" } + Môžu byť changelogy zlé? + + %p Áno. Tu je hneď niekoľko spôsobov, ako môžu byť neužitočné. + + %h4#log-diffs + %a.anchor{ href: "#log-diffs", aria_hidden: "true" } + Diffy z commit logu + + %p + Použitie diffov z commit logu ako changelog nie je dobrý nápad: + sú plné balastu. Veci ako merge commity, commity s nejasnými názvami, + zmeny dokumentácie a pod. + + %p + Účel commitu je dokumentovanie kroku v evolúcii zdrojového kódu. + Niektoré projekty commity prečisťujú, iné nie. + + %p + Účelom changelogu je dokumentovanie významných zmien, často naprieč + viacerými commitmi, a jasne ich komunikovať koncovému používateľovi. + + %h4#ignoring-deprecations + %a.anchor{ href: "#ignoring-deprecations", aria_hidden: "true" } + Ignorovanie oznámenia zastaralých funkcií + + %p + Keď používatelia prechádzajú na novšiu verziu, musí byť jasné, čo sa + rozbije. Mala by pre nich existovať možnosť prejsť na verziu so zoznamom + zastaralých funkcií, tieto funkcie odstrániť a následne prejsť na verziu, + kde sú tieto zastaralé funkcie už odstránené. + + %p + Ak už nič iné, tak aspoň uveď zastaralé, odstránené funkcie a všetky zmeny, + ktoré môžu niečo rozbiť, do changelogu. + + + %h4#confusing-dates + %a.anchor{ href: "#confusing-dates", aria_hidden: "true" } + Mätúce dátumy + + %p + Regionálne formáty dátumov sa líšia naprieč svetom a často je zložité + nájsť formát dátumu, ktorý by bol prívetivý a intuitívny pre všetkých + používateľov. Výhodou dátumu vo formáte 2017-07-17 je poradie + od najväčšej jednotky po najmenšiu: rok, mesiac, deň. Tento formát sa tiež + neprekrýva s inými formátmi, ktoré zamieňajú pozíciu dňa a mesiaca. Kvôli + týmto dôvodom spolu s faktom, že ide o #{link_to "ISO štandard", iso}, + je tento formát odporučený pre záznamy v changelogu. + + %aside + Je toho však viac. Pomôž mi zozbierať tieto antivzory + = link_to "otvorením issue", issues + alebo pull requestom. + +.frequently-asked-questions + %h3#frequently-asked-questions + %a.anchor{ href: "#frequently-asked-questions", aria_hidden: "true" } + Často kladené otázky + + %h4#standard + %a.anchor{ href: "#standard", aria_hidden: "true" } + Existuje štandardný formát pre changelog? + + %p + Nie. Existuje GNU príručka pre štýl changelogu alebo dvojodstavcová + GNU "smernica" pre NEWS súbor. Obe sú však nevhodné či nedostatočné. + + %p + Tento projekt sa snaží byť + = link_to "lepšou konvenciou pre changelog.", changelog + Vychádza z pozorovania a zozbierania osvedčených postupov komunity okolo projektov s otvoreným zdrojovým kódom. + + %p + Zdravá kritika, diskusia a návrhy na zlepšenie + = link_to "sú vítané.", issues + + + %h4#filename + %a.anchor{ href: "#filename", aria_hidden: "true" } + Ako by mal byť súbor changelogu pomenovaný? + + %p + Nazvi ho CHANGELOG.md. Niektoré projekty používajú tiež + HISTORY, NEWS alebo RELEASES. + + %p + Je jednoduché myslieť si, že názov changelogu nie je taký dôležitý. + Prečo však sťažovať koncovému používateľovi hľadanie významných zmien? + + %h4#github-releases + %a.anchor{ href: "#github-releases", aria_hidden: "true" } + A čo GitHub Releases? + + %p + Je to skvelá iniciatíva. Služba #{link_to "Releases", ghr} môže byť použitá + pre premenu git tagov (napríklad tagu v1.0.0) na bohaté + poznámky k vydaniam manuálnym pridávaním týchto poznámok alebo získaním + správ z anotovaných git tagov a vytvorením poznámok k vydaniu z nich. + + %p + GitHub Releases vytvorí neprenosný changelog, ktorý môže byť zobrazený + používateľom v rámci GitHubu. Je možné ich upraviť na veľmi podobný štýl, + aký navrhuje projekt Udržuj changelog, tento postup však býva trochu + zložitejší. + + %p + Súčasná verzia GitHub Releases tiež nie je ľahko objaviteľná koncovým + používateľom, na rozdiel od klasického súboru s názvom napísaným veľkými + písmenami (README, CONTRIBUTING atď.). Ďalším + menším problémom je, že v súčasnosti nepodporuje odkazy na commit logy + medzi jednotlivými vydaniami. + + %h4#automatic + %a.anchor{ href: "#automatic", aria_hidden: "true" } + Môžu byť changelogy automaticky parsované? + + %p + Je to zložité, pretože ľudia používajú rôzne formáty a názvy súborov. + + %p + #{link_to "Vandamme", vandamme} je Ruby gem vytvorený tímom + #{link_to "Gemnasium", gemnasium}, ktorý parsuje mnohé (ale nie všetky) + changelogy projektov s otvoreným zdrojovým kódom. + + + %h4#yanked + %a.anchor{ href: "#yanked", aria_hidden: "true" } + A čo spätne stiahnuté vydania? + + %p + Stiahnuté vydania sú verzie, ktoré museli byť neskôr spätne odobraté + kvôli vážnej chybe alebo bezpečnostným rizikám. Tieto verzie sa často + v changelogu ani neobjavia. Ale mali by sa. Zobrazovať by sa mali takto: + + %p ## 0.0.5 - 2014-12-13 [YANKED] + + %p + Tag [YANKED] kričí naschvál. Je dôležité, aby si ho ľudia + všimli. Keďže je uzavretý zátvorkami, je tiež jednoduchšie ho programovo + parsovať. + + + %h4#rewrite + %a.anchor{ href: "#rewrite", aria_hidden: "true" } + Mal by sa changelog niekedy prepisovať? + + %p + Samozrejme. Vždy sa nájde dobrý dôvod na vylepšenie changelogu. Sám často + otváram pull requesty pre pridanie chýbajúceho vydania projektov + s otvoreným kódom a neudržiavaným changelogom. + + %p + Tiež môže nastať situácia, že v poznámkach k vydaniu určitej verzie sa + zabudla spomenúť podstatná zmena. V takom prípade je samozrejme dôležité + tento changelog aktualizovať. + + + %h4#contribute + %a.anchor{ href: "#contribute", aria_hidden: "true" } + Ako môžem prispieť? + + %p + Tento dokument nie je úplná pravda; je mojím starostlivo + zváženým názorom spolu s informáciami a príkladmi, ktoré som zozbieral. + + %p + Je tomu tak preto, aby komunita dosiahla určitý konsenzus. Verím, že + diskusia je rovnako dôležitá ako samotný výsledok. + + %p + Takže, prosím, #{link_to "prilož ruku k dielu", gh}. + +.press + %h3 Rozhovory + %p + Zúčastnil som sa podcastu #{link_to "The Changelog", thechangelog}, + kde sme sa rozprávali o tom, prečo by sa správci projektov a prispievatelia + mali zaujímať o changelogy a tiež o motivácii za týmto projektom.