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

Remove non-English markdowns which have xliff versions #17281

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

SaschaCowley
Copy link
Member

@SaschaCowley SaschaCowley commented Oct 11, 2024

Link to issue number:

Closes #17237

Summary of the issue:

As translated markdown files are generated from xliff files for languages that have been moved to Crowdin, markdown files for these languages should not be under version control.

Description of user facing changes

None.

Description of development approach

Removed files listed in #17237.

Also used the following script to make sure nothing was missed:

Code snippet
import os.path
import glob
import subprocess

proc = subprocess.run("git diff head~1 --diff-filter=D --name-only", capture_output=True)
deleted_files = proc.stdout.decode().splitlines()

for file in deleted_files:
	xliff = f"{os.path.splitext(file)[0]}.xliff"
	assert os.path.isfile(xliff)

for file in glob.glob("user_docs/**/*.md"):
	if os.path.split(os.path.split(file)[0])[1] == 'en':
		continue
	xliff = f"{os.path.splitext(file)[0]}.xliff"
	assert not os.path.isfile(xliff)

Testing strategy:

Built locally and on AppVeyor.

Known issues with pull request:

This will need to be done as further languages are moved over from l10n to Crowdin.

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

@coderabbitai summary

@wmhn1872265132
Copy link
Contributor

wmhn1872265132 commented Oct 11, 2024

BTW, as of a recent beta version, .md files were accidentally included in the installer

@SaschaCowley SaschaCowley marked this pull request as ready for review October 15, 2024 05:04
@SaschaCowley SaschaCowley requested a review from a team as a code owner October 15, 2024 05:04
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.

After running scons -c, some of the .md files in the user_docs directory were deleted.
2 participants