Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Beta Checklist! #22

Open
9 of 20 tasks
tajmone opened this issue Sep 13, 2021 · 2 comments
Open
9 of 20 tasks

Beta Checklist! #22

tajmone opened this issue Sep 13, 2021 · 2 comments
Labels
⚙️ checklist Pending tasks before a major step 🔨 Dia Tool: Dia Diagram Editor 🔨 GHPages Tool: GitHub Pages (repo website) 🔨 Git Tool: Git 🔨 Rake Tools: Rake (Ruby Make)

Comments

@tajmone
Copy link
Collaborator

tajmone commented Sep 13, 2021 •
edited
Loading

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.

  • GitHub Pages:
    • Configure repository to serve the website from the docs/ folder.
      • Add empty 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).
      • We should stop using the alpha-dev branch, and create a new beta-dev branch for all PRs, which will be then merged into master — i.e. until we reach version 1.0.0 of the book. We shouldn't accept PRs directly on master.
  • Rake automation — all Bash and batch scripts should be dropped in favor of a Rakefile providing cross-platform tasks to achieve the same goals:
    • HTML Book — needs to build into the docs/ folder instead.
    • HTML Book Preview — build the HTML book (no URI-Data) in docs_src/, the HTML doc is then ignored by Git.
    • Git Hooks — installation and removal of the Git hooks become Rake tasks.
      • Delete old hooks script (preview doc is no longer tracked, (see Moving to Beta & Git Hooks #24).
      • If we decide to keep some hooks, then it should invoke the Rake task, not use its own Shell script, to avoid conflicting output due to different AsciiDoc options.
    • EClint — validation of the repository files should also become a Rake task, so we can use Ruby to exclude from the result files which are ignored by Git. Also, we might want to have two separate tasks:
      • Validate whole repository — for local validation.
      • Validate commit files — to validate commits before pushing or creating a PR. This task should be assigned to the Git pre-commit hook.
  • Update Docs:
    • Main README.md:
      • Add/fix badges:
        • Ruby v3.
        • Status Beta.
    • Add 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.
@tajmone tajmone pinned this issue Sep 13, 2021
@tajmone tajmone added ⚙️ checklist Pending tasks before a major step 🔨 Dia Tool: Dia Diagram Editor 🔨 Git Tool: Git 🔨 Rake Tools: Rake (Ruby Make) 🔨 GHPages Tool: GitHub Pages (repo website) labels Sep 14, 2021
tajmone added a commit that referenced this issue Sep 21, 2021
@tajmone
GHPages Preparation
bfe2c4d 
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`.
tajmone added a commit that referenced this issue Sep 21, 2021
@tajmone
GHPages Preparation
b343b43 
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`.
tajmone added a commit that referenced this issue Sep 21, 2021
@tajmone
Update Main README
fb3a1ce 
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.
tajmone added a commit that referenced this issue Sep 22, 2021
@tajmone
Enter Beta Stage
c912811 
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.
tajmone added a commit that referenced this issue Sep 22, 2021
@tajmone
Enable GitHub Pages Website
86e9cd3 
Enabled website served from `master` branch `docs/` folder (see #22).

https://tajmone.github.io/Git-Buch_EN/
@tajmone
Copy link
Collaborator Author

tajmone commented Sep 22, 2021

Beta Stage Active!

@SicroAtGit, development has now moved from alpha-dev to beta-dev, and the book can be previewed by GHPages:

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.

@tajmone
Copy link
Collaborator Author

tajmone commented Sep 22, 2021

GitHub Community Announcement

I've announced the availability for the Beta preview, also asking for help with the proofreading and revision work:

https://github.community/t/the-git-book-free-english-translation-available-on-github/202390

@tajmone tajmone unpinned this issue Dec 8, 2021
@tajmone tajmone pinned this issue Dec 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
⚙️ checklist Pending tasks before a major step 🔨 Dia Tool: Dia Diagram Editor 🔨 GHPages Tool: GitHub Pages (repo website) 🔨 Git Tool: Git 🔨 Rake Tools: Rake (Ruby Make)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tajmone