Enter Beta Stage

Development now moves to the new `dev-beta` branch (see #22). Add admonition in book Preamble, explaining that the book in in Beta preview, provide summary info and a link to repository.
Fossy-Cats · Sep 22, 2021 · c912811 · c912811
1 parent fb3a1ce
commit c912811
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 [![Build Status][Travis badge]][Travis link]&nbsp;
 ![project status][status badge]&nbsp;
 [![CC BY-NC-SA 4.0 License][license badge]][LICENSE]&nbsp;
-![project branch][branch badge]&nbsp;
+[![project branch][branch badge]][beta-dev]&nbsp;
 
 # Git-Buch, English Translation
 
@@ -99,19 +99,21 @@ work. If not, see <http://creativecommons.org/licenses/by-nc/4.0/>.
 
 Summary info on the repository and its current status.
 
-The current development branch is [`alpha-dev`][alpha-dev].
+The current development branch is [`beta-dev`][beta-dev], all pull requests should be submitted there.
 
 
 ## Branches
 
 |                   branch                   |                            description                             |
 |--------------------------------------------|--------------------------------------------------------------------|
-| [`alpha-dev`][alpha-dev] &ast;             | Current dev branch, until Beta stage.                              |
-| [`master`][master]                         | Contains only README and LICENSE, frozen until 1st release.        |
+| [`alpha-dev`][alpha-dev]                   | Current dev branch, until v1.0.0 is ready.                         |
+| [`beta-dev`][beta-dev] &ast;               | Old dev branch for the Alpha stage, no longer used.                |
+| [`master`][master]                         | Main branch, no pull request allowed.                              |
 | [`upstream-de-master`][upstream-de-master] | Orphan mirror of `master` from `gitbuch/gitbuch_cc` upstream repo. |
 
-The [`alpha-dev`][alpha-dev] branch is the current development branch.
-Once the project has been adapted from AsciiDoc (Python) to our custom Asciidoctor (Ruby) workflow, and we have a buildable English draft, development will switch to the Beta stage and another branch.
+The [`beta-dev`][beta-dev] branch is the current development branch (until the book reaches v1.0.0); any pull requests should be submitted there.
+
+The [`alpha-dev`][alpha-dev] branch is no longer active, it's kept for reference purposes only.
 
 The [`upstream-de-master`][upstream-de-master] orphan branch is a mirror of the `master` branch from the upstream repository, kept as a reference to the original files and in case we'll need to integrate future updates from the upstream project.
 
@@ -180,7 +182,7 @@ Open Source Press:
 
 [license badge]: https://img.shields.io/badge/license-CC_BY--NC--SA_4.0-00b5da.svg
 [status badge]: https://img.shields.io/badge/status-beta-orange "Project Status: Beta (polishing in progress)"
-[branch badge]: https://img.shields.io/badge/branch-alpha--dev-yellow "Current Branch: alpha-dev"
+[branch badge]: https://img.shields.io/badge/PRs_Branch-beta--dev-yellow "Pull Requests Branch: beta-dev"
 [Travis badge]: https://img.shields.io/travis/com/tajmone/Git-Buch_EN/master?logo=travis
 [Travis link]: https://travis-ci.com/tajmone/Git-Buch_EN "Travis CI: EditorConfig validation status"
 
@@ -205,6 +207,7 @@ Open Source Press:
 <!-- repo branches -->
 
 [alpha-dev]: https://github.com/tajmone/Git-Buch_EN/tree/alpha-dev "View the 'alpha-dev' branch on GitHub"
+[beta-dev]: https://github.com/tajmone/Git-Buch_EN/tree/beta-dev "View the 'beta-dev' branch on GitHub"
 [master]: https://github.com/tajmone/Git-Buch_EN/tree/master "View the 'master' branch on GitHub"
 [upstream-de-master]: https://github.com/tajmone/Git-Buch_EN/tree/upstream-de-master "View the 'upstream-de-master' branch on GitHub"
 

diff --git a/docs/index.html b/docs/index.html
@@ -446,7 +446,7 @@ <h1>Git: Distributed Version Control for Code and Documents</h1>
 <span id="author" class="author">Valentin Haenel</span><br>
 <span id="author2" class="author">Julius Plenz</span><br>
 <span id="revnumber">version 3.0</span>
-<br><span id="revremark">Beta</span>
+<br><span id="revremark">Beta Preview</span>
 </div>
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
@@ -569,6 +569,50 @@ <h1>Git: Distributed Version Control for Code and Documents</h1>
 </div>
 </div>
 <div id="content">
+<div id="preamble">
+<div class="sectionbody">
+<div class="exampleblock">
+<div class="content">
+<div class="admonitionblock warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>This document is still in Beta version, but fully translated; so enjoy reading it and leave us some feedback on how we might improve it.</p>
+</div>
+<div class="paragraph">
+<p>This is the English translation of
+<a href="http://gitbu.ch" title="Visit the Git-Buch website" target="_blank" rel="noopener"><em>Das Git-Buch</em></a>
+(The Git Book) by
+<a href="https://github.com/esc" target="_blank" rel="noopener">Valentin Haenel</a>
+and
+<a href="https://github.com/Feh" target="_blank" rel="noopener">Julius Plenz</a>,
+released under the
+<a href="https://creativecommons.org/licenses/by-nc-sa/4.0/" title="Learn morea bout the Creative Common BY-NC-SA 4.0 license" target="_blank" rel="noopener">CC BY-NC-SA 4.0</a>
+license.</p>
+</div>
+<div class="paragraph">
+<p>We&#8217;re currently proofreading and polishing the entire text, and fixing some styling and formatting issues.
+Any help with proofreading is much appreciated; if you wish to contribute submit your changes via pull request on the <code>beta-dev</code> branch of the project repository:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><a href="https://github.com/tajmone/Git-Buch_EN" class="bare">https://github.com/tajmone/Git-Buch_EN</a></p>
+</li>
+</ul>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</div>
+</div>
+</div>
+</div>
 <div class="sect1">
 <h2 id="ch.preface"><a class="anchor" href="#ch.preface"></a>Preface</h2>
 <div class="sectionbody">

diff --git a/docs_src/gitbuch.asciidoc b/docs_src/gitbuch.asciidoc
@@ -3,7 +3,7 @@
 Valentin Haenel; Julius Plenz
 :doctype: book
 :revnumber: 3.0
-:revremark: Beta
+:revremark: Beta Preview
 :lang: en
 // Sections Numbering:
 :sectnums:
@@ -15,9 +15,32 @@ Valentin Haenel; Julius Plenz
 :section-refsig: Sec.
 :appendix-refsig: App.
 
-
 include::gitbuch_custom-attributes.adoc[]
 
+// Preamble
+
+================================================================================
+[WARNING]
+===============================
+This document is still in Beta version, but fully translated; so enjoy reading it and leave us some feedback on how we might improve it.
+
+This is the English translation of
+http://gitbu.ch[_Das Git-Buch_^, title="Visit the Git-Buch website"]
+(The Git Book) by
+https://github.com/esc[Valentin Haenel^]
+and
+https://github.com/Feh[Julius Plenz^],
+released under the
+https://creativecommons.org/licenses/by-nc-sa/4.0/[CC BY-NC-SA 4.0^, title="Learn morea bout the Creative Common BY-NC-SA 4.0 license"]
+license.
+
+We're currently proofreading and polishing the entire text, and fixing some styling and formatting issues.
+Any help with proofreading is much appreciated; if you wish to contribute submit your changes via pull request on the `beta-dev` branch of the project repository:
+
+* https://github.com/tajmone/Git-Buch_EN
+===============================
+================================================================================
+
 :leveloffset: +1
 
 // "vorwort.txt"          ->  Preface