Skip to content

Commit

Permalink
Merge pull request #3 from Morganov/translate/readme
Browse files Browse the repository at this point in the history
Дададзены переклад README і LICENSE, адноулены файлы сборкі, выдалены састарэлыя файлы
  • Loading branch information
Morganov authored Jun 21, 2022
2 parents a0f5bb2 + fcd967e commit 5d7dee9
Show file tree
Hide file tree
Showing 15 changed files with 288 additions and 250 deletions.
20 changes: 8 additions & 12 deletions .github/workflows/pr-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,13 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- name: Download bootstrap file
run: wget https://raw.githubusercontent.com/progit/progit2-pub/master/bootstrap.sh
- name: Run bootstrap
run: sh bootstrap.sh
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 2.7
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 2.7
bundler-cache: true # runs 'bundle install' and caches installed gems automatically

- name: Build book
run: bundle exec rake book:build_action
- name: Build Book
run: bundle exec rake book:build
61 changes: 30 additions & 31 deletions .github/workflows/release-on-merge.yml
Original file line number Diff line number Diff line change
@@ -1,42 +1,41 @@
name: Release on push to main
name: Release from master

on:
push:
branches: [ main, master ]
branches: [ master ]

workflow_dispatch:

jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: get bootstrap file
run: wget https://raw.githubusercontent.com/progit/progit2-pub/master/bootstrap.sh
- name: run bootstrap
run: sh bootstrap.sh
- name: Compute tag name
id: compute-tag
run: |
echo Computing next tag number
LASTPATCH=$(git describe --tags | cut -d- -f1 | cut -d. -f3)
PATCH=$(($LASTPATCH+1))
echo "::set-output name=tagname::2.1.${PATCH}"
echo "::set-output name=branch::${GITHUB_REF#refs/heads/}"
- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Compute tag name
id: compute-tag
run: |
echo "Computing next tag number"
LASTPATCH=$(git describe --tags | cut -d- -f1 | cut -d. -f3)
PATCH=$(($LASTPATCH+1))
echo "New tag name: 2.1.${PATCH}"
echo "::set-output name=tagname::2.1.${PATCH}"
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 2.7
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 2.7
bundler-cache: true # runs 'bundle install' and caches installed gems automatically

- name: Build release assets
run: bundle exec rake book:build_action
- name: Build release assets
run: bundle exec rake book:build

- name: Create release
uses: ncipollo/release-action@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
tag: ${{ steps.compute-tag.outputs.tagname }}
commit: ${{ steps.compute-tag.outputs.branch }}
artifacts: './progit.epub,./progit.mobi,./progit.pdf,./progit.html'
- name: Create Release
uses: ncipollo/release-action@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
tag: ${{ steps.compute-tag.outputs.tagname }}
commit: master
artifacts: './progit.epub,./progit.mobi,./progit.pdf,./progit.html'
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
output
.DS_Store
.vscode
.bundle

# build artifacts
Gemfile.lock
Expand Down
35 changes: 0 additions & 35 deletions .travis.yml

This file was deleted.

18 changes: 9 additions & 9 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
source 'https://rubygems.org'

gem 'rake', '13.0.3'
gem 'asciidoctor', '2.0.12'
gem 'rake', '13.0.6'
gem 'asciidoctor', '2.0.17'

gem 'json', '2.5.1'
gem 'awesome_print', '1.8.0'
gem 'json', '2.6.2'
gem 'awesome_print', '1.9.2'

gem 'asciidoctor-epub3', '1.5.0.alpha.19'
gem 'asciidoctor-pdf', '1.5.4'
gem 'asciidoctor-epub3', '1.5.1'
gem 'asciidoctor-pdf', '2.0.8'

gem 'coderay', '1.1.3'
gem 'pygments.rb', '2.0.0'
gem 'pygments.rb', '2.3.0'
gem 'thread_safe', '0.3.6'
gem 'epubcheck-ruby', '4.2.4.0'
gem 'html-proofer', '3.18.5'
gem 'epubcheck-ruby', '4.2.6.0'
gem 'html-proofer', '3.19.4'
4 changes: 2 additions & 2 deletions LICENSE.asc
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.
To view a copy of this license, visit https://creativecommons.org/licenses/by-nc-sa/3.0 or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
Гэты твор распаўсюджваецца па вольнай ліцэнзіі Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.
Азнаёміцца з тэкстам ліцэнзіі вы можаце на сайце https://creativecommons.org/licenses/by-nc-sa/3.0/deed.be або па пошце, даслаўшы ліст у арганізацыю Creative Commons па адрасе: PO Box 1866, Mountain View, CA 94042, USA.
127 changes: 106 additions & 21 deletions README.asc
Original file line number Diff line number Diff line change
@@ -1,41 +1,126 @@
= Pro Git, Second Edition
= Pro Git, Другое Выданне

Welcome to the second edition of the Pro Git book.
Вітаем у другім выданні кнігі Pro Git.

You can find this book online at: https://git-scm.com/book
Гэтую ж самую кнігу можна знайсці онлайн: https://git-scm.com/book

Like the first edition, the second edition of Pro Git is open source under a Creative Commons license.
Гэтае выданне, як і першае, з'яўляецца праектам з адкрытым зыходным кодам з ліцэнзіяй Creative Commons.
A couple of things have changed since open sourcing the first edition.
For one, we've moved from Markdown to the amazing AsciiDoc format for the text of the book; here's an https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[AsciiDoc quick reference].
З моманту публікацыі першага выдання шмат што змянілася.
Па-першае, мы перайшлі з Markdown на AsciiDoc -- вось кароткі даведнік па сінтаксісе https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[AsciiDoc].
We've also moved to keeping the translations in separate repositories rather than subdirectories of the English repository.
See link:TRANSLATING.md[the translating document] for more information.
Па-другое, пераклады на іншыя мовы перанесены ў асобныя рэпазітары.
Падрабязна у пункце пра пераклады.
== How To Generate the Book
== Як прыняць удзел
You can generate the e-book files manually with Asciidoctor.
We used to be able to build .mobi files (Kindle), but cannot do so now, see #1496 for more information.
If you run the following you _may_ actually get HTML, Epub and PDF output files:
Каб выправіць памылку або дадаць нешта новае ў гэты рэпазітар, вам трэба адкрыць запыт на зліццё (Pull Request) на GitHub.
Нягледзячы на тое, што ў ангельскай версіі просяць ўстрымацца ад стылістычных змен на вялікіх участках тэксту, гэты пераклад прафесійныя рэдактары не праглядалі, будзем рады вашым праўкам.
== Як сабраць кнігу
Ёсць два сбосабу атрымаць файл электроннай кнігі з гэтага коду.
Самы просты -- даручыць гэта нам.
Робат рэагуе на змены ў ветцы `master` рэпазітара и аутаматычна збірае кнігу ва ўсіх фарматах.
Апошнюю зборку можна знайсці на старонцы https://git-scm.com/book/be/v2.
Іншы спосаб атрымаць кнігу -- сабраць яе самастойна з дапамогай Asciidoctor.
Выкарыстоўваючы каманды ніжэй, вы зможаце атрымаць кнігу ў фарматах HTML, EPUB і PDF.
----
$ bundle config set --local path '.bundle/vendor'
$ bundle install
$ bundle exec rake book:build
Downloading locale attributes file...
-- Saved at attributes-ru.adoc
Converting to HTML...
-- HTML output at progit.html
Converting to EPub...
-- Epub output at progit.epub
Converting to EPUB...
-- EPUB output at progit.epub
Converting to PDF...
-- PDF output at progit.pdf
-- PDF output at progit.pdf
Validating generated files...
-- Validate HTML file progit.html
Running ["ScriptCheck", "LinkCheck", "ImageCheck", "HtmlCheck"] on progit.html on *.html...
Checking 89 external links...
Ran on 1 file.
HTML-Proofer finished successfully.
-- Validate EPUB output file progit.epub
Validating using EPUB version 3.2 rules.
No errors or warnings detected.
Messages: 0 fatals / 0 errors / 0 warnings / 0 infos
EPUBCheck completed
----
Тут выкарыстоўваюцца праекты `asciidoctor`, `asciidoctor-pdf` и `asciidoctor-epub`.
Па змаўчанні, `bundle install` усталёўвае залежнасці глабальна у сістэму.
Каб гэтага пазбегнуць, у прыкладзе вышэй менеджэр пакетаў дадаткова канфігуруецца перад усталяваннем залежнасцяў з дапамогай наступнай каманды:
----
bundle config set --local path '.bundle/vendor'
----
Таксама існуе магчымасць сабраць кнігу толькі ў адным з фарматаў.
Для генерацыі толькі HTML файла:
----
bundle exec rake book:build_html
----
== Signaling an Issue
Для генерацыі толькі EPUB-файла:
----
bundle exec rake book:build_epub
----
Для генерацыі толькі PDF файла:
----
bundle exec rake book:build_pdf
----
Для валідацыі згенераваных файлаў прадугледжаны каманды праверкі.
Для праверкі HTML файла:
----
bundle exec rake book:check_html
----
Для праверкі EPUB-файла:
----
bundle exec rake book:check_epub
----
Звярніце ўвагу, што для запуску праверкі EPUB-файла патрабуецца наяўнасць усталяванага JRE.
== Пераклады
Пераклады на іншыя мовы горача вітаюцца, але апрацоўваюцца некалькі інакш, чым у першым выданні.
Мы захоўваем кожны пераклад у асобным рэпазітары і аўтаматычна збіраем гатовыя файлы з дапамогай AsciiDoctor.
Гэта было рэальна складаным у мінулым выданні.
Раз кожны пераклад захоўваецца ў сваім рэпазітары, зараз мы можам выбраць свайго каардынатара для кожнага з іх.
Каманда Pro Git проста дадасць іх да сябе.
Для аўтаматычнай зборкі рэпазітар павінен знаходзіцца ў каманды Pro Git https://github.com/progit[на GitHub].
Before signaling an issue, please check that there isn't already a similar one in the bug tracking system.
== Ілюстрацыі
Also, if this issue has been spotted on the git-scm.com site, please cross-check that it is still present in this repo.
The issue may have already been corrected, but the changes have not been deployed yet.
Малюнкі гэтай кнігі былі створаны з дапамогай https://www.sketch.com/[Sketch 3], арыгінальны https://github.com/progit/progit2/blob/master/diagram-source/progit.sketch[файл] у фармаце sketchbook даступны ў ангельскай версіі кнігі.
== Contributing
Даданне ілюстрацыі:
If you'd like to help out by making a change, take a look at the link:CONTRIBUTING.md[contributor's guide].
. Дадайце старонку ў sketchbook; па-магчымасці старайцеся выкарыстоўваць убудаваныя сімвалы.
. Дадайце «slice» на сваю старонку; назавіце яе таксама, як PNG файл, адносна каранёвай часткі зыходнага кода кнігі.
. Пераканайцеся, што ў наладах экспарту выстаўлены трохразовы памер.
Loading

0 comments on commit 5d7dee9

Please sign in to comment.