-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Beta Checklist! #22
Comments
Start preparing the repository to serve the HTML book via GHPages from the `docs/` folder (see #22): - The preview docs is now renamed to `GitBook_Preview.html` and ignored by Git, its Asciidoctor settings are adjusted to previewing. - Add `docs/` folder with `.nojekyll` file. - Delete Git hook scripts (see #24). - Use Rake tasks to handle all builds: + `rake publish` to build `docs/GitBook.html` (tracked). + `rake preview` (default) to build HTML preview doc (ignored). + `rake all` to execute all tasks. + Delete old Asciidoctor build scripts. - Update `docs_src/README.md`.
Start preparing the repository to serve the HTML book via GHPages from the `docs/` folder (see #22): - The preview docs is now renamed to `GitBook_Preview.html` and ignored by Git, its Asciidoctor settings are adjusted to previewing. - Add `docs/` folder with `.nojekyll` file. - Delete Git hook scripts (see #24). - Use Rake tasks to handle all builds: + `rake publish` to build `docs/index.html` (tracked). + `rake preview` (default) to build HTML preview doc (ignored). + `rake all` to execute all tasks. + Delete old Asciidoctor build scripts. - Update `docs_src/README.md`.
Start polishing and updating main README doc in view of the upcoming Beta stage (see #22). Also update Dia's README and begin tweaking the main ADoc source.
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.
Enabled website served from `master` branch `docs/` folder (see #22). https://tajmone.github.io/Git-Buch_EN/
Beta Stage Active!@SicroAtGit, development has now moved from Some of the above tasks have not yet been completed, but it's OK — I'll just move them to individual Issues to be dealt with in the Beta stage. |
GitHub Community AnnouncementI've announced the availability for the Beta preview, also asking for help with the proofreading and revision work: https://github.1git.demunity/t/the-git-book-free-english-translation-available-on-github/202390 |
We're about to enter the Beta stage of the book, where its HTML version will be made available on the WWW via the repository GHPages website — with a clear admonition regarding its Beta status, and a call for help to polish the translation before reaching v1.0.0.
Below is a checklist of all the things that need to be done before and after moving to the Beta stage.
docs/
folder.docs/.nojekyll
file to enforce static website.master
branch — In order to use GitHub Pages, we'll need to publish the current book to the default branch (master
).alpha-dev
branch, and create a newbeta-dev
branch for all PRs, which will be then merged intomaster
— i.e. until we reach version 1.0.0 of the book. We shouldn't accept PRs directly onmaster
.Rakefile
providing cross-platform tasks to achieve the same goals:docs/
folder instead.docs_src/
, the HTML doc is then ignored by Git.README.md
:CONTRIBUTING.md
— we'll need to provide some guidelines regarding the project standards, which branch to commit to, etc.The above list is probably incomplete, and it will be updated as new pending chores come up during discussions and practical work. All suggestions are welcome.
The text was updated successfully, but these errors were encountered: