firstcontributions
Discussion of minor problems in `README` and `cli-tool-tutorial` files
Note: This issue is a continued discussion from PR #106342.
TL;DR: There are some minor problems in README, cli-tool-tutorial and their respective translation files (translations and cli-tool-tutorials). Originally intended to solve only the angle bracket problem (more detail on #106341), it later expanded to include other problems discovered along the way.
There are files with formatting problem, most of them led to Error code to be outside of code block and 3 lines of error code on the same line. All problems are listed in this comment and the 2nd section of this other comment.
List of all files with other problems not listed above:
- github-cli-tutorials-arabic.md Unreadable file.
- README.ec.md uses hyperlink inside code block.
- README.ps.md have a red highlight on error code.
- README.assamese.md broken code blocks.
The current approach is to fix angle bracket problem, formatting problem and other problems simultaneously, files with not only one problem will prioritize formatting problem first (as described in this comment).
Currently waiting approval for personal access token to create issues for README files with only angle bracket problem. Other problems and files are being addressed.
Since the location of discussion has changed, I'll ask the language name question again (more detail in this comment):
The following are the files that I think the language code is the language name:
Gujarati: https://github.com/firstcontributions/first-contributions/blob/main/docs/cli-tool-tutorials/github-cli-tutorial-gujarati.mdKannada: https://github.com/firstcontributions/first-contributions/blob/main/docs/cli-tool-tutorials/git-cli-tutorial-kannada.mdSinhala: https://github.com/firstcontributions/first-contributions/blob/main/docs/cli-tool-tutorials/github-cli-tutorial-sinhala.mdMalayalam: https://github.com/firstcontributions/first-contributions/blob/main/docs/cli-tool-tutorials/translations/github-cli-tutorial-malayalam.mdUrdu: https://github.com/firstcontributions/first-contributions/blob/main/docs/cli-tool-tutorials/github-cli-tutorial-Urdu.mdArabic: https://github.com/firstcontributions/first-contributions/blob/main/docs/cli-tool-tutorials/github-cli-tutorials-arabic.md
The following are the files that I have some or no clue:
francais(maybeFrench): https://github.com/firstcontributions/first-contributions/blob/main/docs/cli-tool-tutorials/github-cli-tutorials-francais.mdmarathi(Turkish?Marathi?): https://github.com/firstcontributions/first-contributions/blob/main/docs/cli-tool-tutorials/translations/Marathi/github-cli-tutorial.marathi.md
@Roshanjossey, Please let me know what language name I should use for these files! @rammba, Thanks for the remind, discussion is moved to this issue! Thank you both in advance! ✨
Update:
Current addressed problems: angle bracket problem, formatting problem.
Current addressed files: README, cli tool tutorials.
All the combinations of the problems and files above have been addressed. Issues can be created immediately after the approval for personal access token. See the preview of all the issues at the following links:
https://github.com/Sharl0tteIsTaken/test/issues
Issues with other problems will need to be created manually, because each have a different problem.
Language name question
During the double check before this update, I found out that language code hi (github-cli-tutorial.hi.md) is in Hindi (source #105818). I must be blind or something cause how could I have not noticed it at all?? (hi has been removed from the description of this issue.)
Also, here are the reference materials for language code marathi, PR #93856 (I missed it when creating this issue). The title was written as Turkish in the issue, but the file name was written as marathi. I'll use Marathi for now as there are a Marathi translation of readme.
Update: Issues with other problems have been manually created.
List of all issues can be created without any other input:
- #107870
- #107871
- #107875
List of all issues needed input:
- https://github.com/Sharl0tteIsTaken/test/issues/102
- https://github.com/Sharl0tteIsTaken/test/issues/103
These two issues was created in my test repository for better preview, they need help because they are written in RTL, I think this is a good enough approach to describe and locate the problem, what do you think? @Roshanjossey
Lastly, the red highlight in README.ps.md, does this need to be removed? (I was unable to reproduce it locally):