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

Add directory to Translations to Portuguese [Incrementally] #1679

Closed
wants to merge 15 commits into from

Conversation

ropinho
Copy link

@ropinho ropinho commented Jul 5, 2019

Description

[Edited] I added a directory on docs called ptbr to add the files translated from English. It may be used to provides documentation with dynamic language to external webpages, if need in the future.

My idea is to do it incrementally, until all translate files.

GitHub Issues

I commented about this in Issue #1674

Translated files

  • tutorial.md
  • assertions.md
  • benchmarks.md
  • ci-and-misc.md
  • cmake-integration.md
  • command-line.md
  • commercial-users.md
  • configuration.md
  • deprecations.md
  • event-listeners.md
  • generators.md
  • limitations.md
  • list-of-examples.md
  • logging.md
  • matchers.md
  • opensource-users.md
  • other-macros.md
  • own-main.md
  • release-notes.md
  • release-process.md
  • reporters.md
  • slow-compiles.md
  • test-cases-and-sections.md
  • test-fixtures.md
  • tostring.md
  • why-catch.md

@codecov
Copy link

codecov bot commented Jul 5, 2019

Codecov Report

Merging #1679 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #1679   +/-   ##
======================================
  Coverage    83.9%   83.9%           
======================================
  Files         123     123           
  Lines        3403    3403           
======================================
  Hits         2855    2855           
  Misses        548     548

@codecov
Copy link

codecov bot commented Jul 5, 2019

Codecov Report

Merging #1679 into master will increase coverage by 0.73%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1679      +/-   ##
==========================================
+ Coverage    86.5%   87.23%   +0.73%     
==========================================
  Files         136      136              
  Lines        5275     5332      +57     
==========================================
+ Hits         4563     4651      +88     
+ Misses        712      681      -31

@horenmar
Copy link
Member

horenmar commented Jul 7, 2019

As a small nitpick, I would prefer the subdirectories be named in locale style, that is pt_BR.

Before the end, you will also have to update the scripts that automatically update documentation links on release.

@ropinho
Copy link
Author

ropinho commented Jul 8, 2019

Ok. I'll take care for this. ;)

@claremacrae
Copy link
Contributor

Hi, any thoughts about what will happen to existing links, bookmarks, references from other project's documentation, when the existing English Markdown pages get moved to a sub-directory?

Could anything be done to prevent broken links? Does github allow redirects to be set up?

@ropinho
Copy link
Author

ropinho commented Jul 10, 2019

Hi, any thoughts about what will happen to existing links, bookmarks, references from other project's documentation, when the existing English Markdown pages get moved to a sub-directory?

Could anything be done to prevent broken links? Does GitHub allow redirects to be set up?

Hello! I removed the subdirectory for English documentation. Let all markdown files in docs directory and i created a pt_BR directory for docs translated, justly to keep the links on the original files.

I don't know well about links management in markdown files on the Github.
Some projects uses a subdirectory for each language, but generally, the content of the files is used by webpages (see about Brython project and it structure on Github). I believe this documentation type is usual.

@horenmar horenmar closed this Oct 20, 2020
@horenmar horenmar deleted the branch catchorg:master October 20, 2020 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants