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

Translate documents to Persian 🇮🇷 #459

Closed
mmdbalkhi opened this issue Jul 6, 2021 · 11 comments
Closed

Translate documents to Persian 🇮🇷 #459

mmdbalkhi opened this issue Jul 6, 2021 · 11 comments

Comments

@mmdbalkhi
Copy link
Contributor

Translate document to Persian 🇮🇷

Hello, I can translate documents into Persian. If you agree, I will do it.

thank you

@mmdbalkhi
Copy link
Contributor Author

Of course I mean wiki and readme.
And another suggestion, I think copy the wiki to the docs folder and enable the github page to make it easier to read.

@o2sh
Copy link
Owner

o2sh commented Jul 6, 2021

IMO, translating the wiki may be overkill and possible cumbersome to maintain considering that its content may evolve with time.

But yeah, a Persian version of the README.md would be awesome @KomeilParseh 🇮🇷

@mmdbalkhi
Copy link
Contributor Author

Hi @o2sh

Your opinion is very respectful to me. I will do this. But my suggestion is to copy the wiki to the documentation folder and make a version of the version to make it easier to read and find.

Thanks for reading this

@o2sh
Copy link
Owner

o2sh commented Jul 6, 2021

Sorry, I missed the second part of your first comment 🤦

my suggestion is to copy the wiki to the documentation folder and make a version of the version to make it easier to read and find

It does sound appealing to have a local version of the wiki (in a .md file format), but it kinda bugs me to have two version of the same thing that would require to be kept in sync. Besides, the man page kinda fulfill this role.

But I may be wrong...

@mmdbalkhi
Copy link
Contributor Author

Sorry, I missed the second part of your first comment 🤦

my suggestion is to copy the wiki to the documentation folder and make a version of the version to make it easier to read and find

It does sound appealing to have a local version of the wiki (in a .md file format), but it kinda bugs me to have two version of the same thing that would require to be kept in sync. Besides, the man page kinda fulfill this role.

But I may be wrong...

Hi again @o2sh

Yes it is very attractive.
The truth is that man is very different from this, and GitHub pages a very attractive , and it is a Persian proverb that says, "People's minds are in their eyes (what they see)!"

@mmdbalkhi mmdbalkhi removed their assignment Jul 6, 2021
@spenserblack
Copy link
Collaborator

spenserblack commented Jul 6, 2021

It does sound appealing to have a local version of the wiki (in a .md file format), but it kinda bugs me to have two version of the same thing that would require to be kept in sync.

Just a possibility: With a version of the wiki in the main repo, it might be possible to create a workflow that checks for changes to docs/ and copies all files to the wiki repo, commits and pushes them. Kind of like this

# deploy.sh
# triggered on changes to docs
# creates a new repo in docs with 1 commit and force pushes from local
# master branch (of inner repo, not onefetch repo) to remote master branch
cd docs

git init
git add -A
git commit -m "refresh wiki"

git push -f https://github.com/o2sh/onefetch.wiki.git master:master

Or this script could be run on new releases, instead.

I'm not sure if this would be useful, though 🤔
One problem that I can think of is that I'm not sure if a workflow can listen to wiki changes and copy
them to the main repo to keep them in sync. If it can, it would be a bit more complicated since you
couldn't force-push a one-commit history to the main repo.

@mmdbalkhi
Copy link
Contributor Author

Sorry about that removed their assignment

Unfortunately, my finger hit it.🤦🏻‍♂️

@mmdbalkhi
Copy link
Contributor Author

It does sound appealing to have a local version of the wiki (in a .md file format), but it kinda bugs me to have two version of the same thing that would require to be kept in sync.

Just a possibility: With a version of the wiki in the main repo, it might be possible to create a workflow that checks for changes to docs/ and copies all files to the wiki repo, commits and pushes them. Kind of like this

# deploy.sh
# triggered on changes to docs
# creates a new repo in docs with 1 commit and force pushes from local
# master branch (of inner repo, not onefetch repo) to remote master branch
cd docs

git init
git add -A
git commit -m "refresh wiki"

git push -f https://github.com/o2sh/onefetch.wiki.git master:master

Or this script could be run on new releases, instead.

I'm not sure if this would be useful, though 🤔
One problem that I can think of is that I'm not sure if a workflow can listen to wiki changes and copy
them to the main repo to keep them in sync. If it can, it would be a bit more complicated since you
couldn't force-push a one-commit history to the main repo.

Hi @spenserblack

No, there is no need to do this. In the pages menu in repo settings, by setting the branch and theme, GitHub can automatically render md and show it to users

Screenshot

Like the photo above👆👆

@spenserblack
Copy link
Collaborator

spenserblack commented Jul 6, 2021

there is no need to do this

If the wiki pages are deleted in favor of github pages, there is no need. That suggestion is for if the wiki is still used.

@mmdbalkhi
Copy link
Contributor Author

If the wiki pages are deleted in favor of github pages, there is no need. That suggestion is for if the wiki is still used

I mean the content of the same wiki on the pages (with their translation), if the page and the wiki are active together, there will be no problem

@mmdbalkhi
Copy link
Contributor Author

Hello @o2sh. I think maybe we can localize the wikis. We create a folder called docs and then localize the files using po, and with a bit of bash script and GitHub workflow, we might be able to do this automatically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants