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.

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

Translating Commits, Files and Folders Names #1

Open
1 of 5 tasks
tajmone opened this issue Jul 26, 2020 · 1 comment
Open
1 of 5 tasks

Translating Commits, Files and Folders Names #1

tajmone opened this issue Jul 26, 2020 · 1 comment
Labels
🕙 pending decision Course of action still not decided upon 🔨 Dia Tool: Dia Diagram Editor ⭐ diagrams Topic: diagram images ⭐ Git logs Topic: Git transcript examples in the book ⭐ screenshots Topic: screenshot images ⚠️ important Priority: High
Milestone

Comments

@tajmone
Copy link
Collaborator

tajmone commented Jul 26, 2020

The various Git commands example logs in the book contain German files and folders names, as well as commits messages, that could be translated to English to simplify following the exercises.

Although many files are named in English in the original book, some folders and commits are not, and translating them would provide a better experience.

But we first need to check if translating them would affect some diagrams/images (including screenshots of Git GUI), and evaluate the costs vs benefits of translating them everywhere (main text, Git logs, and illustrations) to ensure file names and commits consistency across the book, and whether keeping minor inconsistencies (e.g. with screenshots, which can't be recreated with matching SHA-1 commits) would be acceptable.

Also, special care is required to ensure that all Git transcripts are updated consistently (shouldn't be a problem, but requires thorough checking).

  • Locate any images that would be affected by translating files names or commits messages.
    • Dia Diagrams (editable):
      • git-objects.dia » §2.2.2. » Fig.4
      • repository-content.dia » §2.2.5. » Fig.6
      • tags.dia » §3.1.3. » Fig.12
    • Screenshots:
      • ???
  • Determine if all these images could be adapted accordingly (i.e. if they are built from editable sources, e.g. via Dia) or not (e.g. screenshots).
  • Check is they relate to commits available from real repositories (in which case, it might not be worth translating them).
@tajmone tajmone added the ⭐ Git logs Topic: Git transcript examples in the book label Jul 26, 2020
@tajmone tajmone added this to the Git examples milestone Jul 26, 2020
@tajmone
Copy link
Collaborator Author

tajmone commented Jul 26, 2020

Real-Case Examples

In §1.2.1. The First Repository, the following Git transcript:

$ git init beispiel
Initialized empty Git repository in /home/esc/beispiel/.git/

could be translated to:

$ git init example
Initialized empty Git repository in /home/esc/example/.git/

and in §1.2.2. The First Commit, the following:

$ git commit -m "Erste Version"
[master (root-commit) 07cc103] Erste Version
 1 file changed, 1 insertion(+)
 create mode 100644 hello.pl

could be translated to:

$ git commit -m "First Version"
[master (root-commit) 07cc103] First Version
 1 file changed, 1 insertion(+)
 create mode 100644 hello.pl

... all of which would make it much clearer to the reader what's going on.

@tajmone tajmone added ⭐ diagrams Topic: diagram images ⭐ screenshots Topic: screenshot images labels Feb 17, 2021
tajmone added a commit that referenced this issue Feb 17, 2021
Update TODOs list in Dia's README:

- Cairo SVG images carrying size info (see #13).
- Annotate diagrams that should only be translated if we decide to also
  translate commits from the book's examples (see #1).
@tajmone tajmone pinned this issue Apr 3, 2021
@tajmone tajmone added the 🔨 Dia Tool: Dia Diagram Editor label Apr 4, 2021
@tajmone tajmone added 🕙 pending decision Course of action still not decided upon ⚠️ important Priority: High labels Sep 22, 2021
@tajmone tajmone unpinned this issue Oct 26, 2021
@tajmone tajmone pinned this issue Oct 30, 2021
@tajmone tajmone unpinned this issue Dec 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕙 pending decision Course of action still not decided upon 🔨 Dia Tool: Dia Diagram Editor ⭐ diagrams Topic: diagram images ⭐ Git logs Topic: Git transcript examples in the book ⭐ screenshots Topic: screenshot images ⚠️ important Priority: High
Projects
None yet
Development

No branches or pull requests

1 participant