வலைபெயர்ப்பு ஆவணங்களுக்கு பங்களிக்கவும்

நீங்கள் விரும்பும் ஆவணப் பக்கத்தை மேம்படுத்த உங்களை வரவேற்கிறோம். பக்கத்தின் மேல் வலது மூலையில் உள்ள GitHub இல் திருத்து பொத்தானைக் சொடுக்கு செய்வதன் மூலம் எளிதாகச் செய்யவும்.

ஆவணப்படுத்தல் வழிகாட்டுதல்கள்

எழுதும் போது இந்த வழிகாட்டுதல்களை மதிக்கவும்:

1. ஆவணத்தின் ஒரு பகுதியை செல்லுபடியாகும் என்றால் அதை அகற்ற வேண்டாம்.

2. தெளிவான மற்றும் எளிதில் புரிந்துகொள்ளக்கூடிய மொழியைப் பயன்படுத்துங்கள். நீங்கள் தொழில்நுட்ப ஆவணங்களை எழுதுகிறீர்கள், ஒரு பா அல்ல. எல்லா டாக்ச் வாசகர்களும் சொந்த பேச்சாளர்கள் அல்ல, சிந்தனையுடன் இருங்கள்.

3. நீங்கள் உறுதியாக தெரியவில்லையா என்று கேட்க பயப்பட வேண்டாம். திருத்துதல் செய்யும் போது சில அம்சங்களைப் பற்றி நீங்கள் கேட்க வேண்டியிருந்தால், உங்களிடம் பதில் இருப்பதற்கு முன்பு அதன் ஆவணங்களை மாற்ற வேண்டாம். இதன் பொருள்: நீங்கள் மாறுகிறீர்கள் அல்லது கேட்கிறீர்கள். இரண்டையும் ஒரே நேரத்தில் செய்ய வேண்டாம்.

4. டாக்சைப் பின்பற்றும்போது விவரிக்கப்பட்ட செயல்களைச் செய்வதன் மூலம் உங்கள் மாற்றங்களைச் சரிபார்க்கவும்.

5. சிறிய துகள்களில் மாற்றங்களுடன் pr ஐ அனுப்பவும், அதை எளிதாகவும் விரைவாகவும் மதிப்பாய்வு செய்து ஒன்றிணைக்கவும்.

6. நீங்கள் ஒரு பெரிய கட்டுரையின் கட்டமைப்பை மீண்டும் எழுதவும் மாற்றவும் விரும்பினால், அதை இரண்டு படிகளில் செய்யுங்கள்:

   1. மீண்டும் எழுதவும்

   2. மீண்டும் எழுதப்பட்டதும், மெருகூட்டப்பட்டதும், ஒன்றிணைந்ததும், பத்திகளின் கட்டமைப்பை மற்றொரு pr இல் மாற்றவும்.

ஆவணங்களை உள்நாட்டில் உருவாக்குதல்

ஆவணங்களை உள்நாட்டிலும் திருத்தலாம் மற்றும் உருவாக்கலாம், பைதான் தேவைகள் டாக்ச் சார்பு குழுவில் pyproject.toml இல் இருக்கும். நீங்கள் ஏற்கனவே முழு வளர்ச்சி சூழலைப் பயன்படுத்தினால், uv sync --all-extras --dev போதுமானது. ஆவணப் பணிகளுக்கு மட்டும், uv sync --group docs போதுமானது.

பரிந்துரைக்கப்பட்ட உள்ளக பணிப்பாய்வு:

make -C docs update-docs
./ci/run-docs

ci/run-docs ரேப்பர் ஆவணங்களை பிழைகளாகக் கருதப்படும் எச்சரிக்கைகளுடன் உருவாக்குகிறது.

Hint

ஆவணத்தை உருவாக்க உங்களுக்கு graphviz நிறுவப்பட்டிருக்க வேண்டும்.

ஆவணங்களை மொழிபெயர்க்கிறது

நீங்கள் <https://hosted.weblate.org/projects/weblate/documentation/>`_ ஆவணத்தை மொழிபெயர்க்கலாம்.

உருவாக்கப்பட்ட ஆவணத் துணுக்குகளைப் புதுப்பிக்கிறது

பல ஆவணப் பிரிவுகள் குறியீட்டிலிருந்து உருவாக்கப்பட்ட டெம்ப்ளேட்களைப் பயன்படுத்துகின்றன. அவற்றைப் புதுப்பிக்க விருப்பமான வழி:

make -C docs update-docs

இந்த இலக்கு தற்போது ஆவணத்தால் பயன்படுத்தப்படும் துணுக்குகளை மீண்டும் உருவாக்குகிறது, இதில் அடங்கும்:

• கூடுதல் நிகழ்வுகள், உள்ளமைக்கப்பட்ட துணை நிரல்கள் மற்றும் பொதுவான துணை அளவுருக்கள்

• இயந்திர மொழிபெயர்ப்பு சேவைகள்

• கோப்பு வடிவ அளவுருக்கள் மற்றும் கோப்பு வடிவமைப்பு அம்ச அட்டவணைகள்

• அனுமதிகள் மற்றும் உள்ளமைக்கப்பட்ட பாத்திரங்கள்

• சரிபார்க்கிறது மற்றும் கொடிகளை சரிபார்க்கிறது

தானாக உருவாக்கப்பட்ட துணுக்குகளில் சேர்ப்பதற்குப் பதிலாக, கைமுறையாகப் பராமரிக்கப்படும் உரையை பெற்றோர் ஆவணப் பக்கத்தில் வைக்கவும். எடுத்துக்காட்டாக, துணை நிரல்கள் ஆனது நிகழ்வுகளுக்கான மூன்று உருவாக்கப்பட்ட கோப்புகள், உள்ளமைக்கப்பட்ட துணை நிரல்கள் மற்றும் பொதுவான கூடுதல் அளவுருக்கள் ஆகியவற்றை உள்ளடக்கியது, அதே நேரத்தில் வழக்கற்றுப் போன துணை நிரல்கள் நேரடியாக பக்கத்தில் பராமரிக்கப்படும்.

நீங்கள் ஒரு பகுதியை மட்டும் மீண்டும் உருவாக்க வேண்டும் என்றால், தனிப்பட்ட நிர்வாகக் கட்டளைகள் மேலாண்மை கட்டளைகள் இல் ஆவணப்படுத்தப்படும், மேலும் update-docs பயன்படுத்தும் சரியான கட்டளைகள் docs/Makefile இல் பட்டியலிடப்படும்.