ஆவணப்படுத்துதல்¶
Tip
இந்த தளத்தின் ஆவணங்கள் மறுசீரமைப்பு அல்லது சுருக்கமாக RST இல் எழுதப்பட்டுள்ளன. உங்களுக்கு rst உடன் தெரிந்திருக்கவில்லை என்றால் rst ப்ரைமர் ஐ சரிபார்க்கவும்.
இந்த தளத்தில் இடம்பெறக்கூடிய யுபிதுறைமுகங்கள் திட்டத்திற்கான சிறந்த ஆவணங்களை எழுதுவதன் மூலம் இந்த பக்கம் உங்களுக்கு வழிகாட்டும்.
ஆவணப்படுத்தல் வழிகாட்டுதல்கள்¶
நடை, வடிவம் அல்லது இணைப்பில் உள்ள சிக்கல்களைத் தவிர்க்க ஆவணங்களை எவ்வாறு எழுத வேண்டும் என்பதை இந்த விதிகள் நிர்வகிக்கின்றன.
தலைப்பு¶
எல்லா பக்கங்களிலும் ஒரு ஆவண தலைப்பு இருக்க வேண்டும், அவை உள்ளடக்க அட்டவணையில் (இடது பக்கப்பட்டி) மற்றும் பக்கத்தின் மேலே காட்டப்படும்.
Titles should be "sentence cased" rather than "Title Cased". For example:
Incorrect casing:
Writing A Good Bug Report
Correct casing:
Writing a good bug report
Correct casing when proper nouns are involved:
Installing Ubuntu Touch on your phone
எல்லோரும் பின்பற்றும் தலைப்பு உறை ஒரு வரையறை இல்லை, ஆனால் வாக்கிய உறை எளிதானது. இது மூலதனமயமாக்கலை உள்ளடக்க அட்டவணையில் சீராக வைத்திருக்க உதவுகிறது.
பக்க தலைப்புகள் சம அறிகுறிகளுடன் அடிக்கோடிட்டுக் காட்டப்பட்டுள்ளன. எடுத்துக்காட்டாக, இதற்கான மார்க்அப் பிழை அறிக்கை பின்வரும் தலைப்பை உள்ளடக்கியது:
Bug reporting
=============
அதை கவனியுங்கள்:
தலைப்பு தண்டனை வழக்கு
தலைப்பு சமமான அறிகுறிகளுடன் அடிக்கோடிட்டுக் காட்டப்பட்டுள்ளது
அடிக்கோடிட்டது தலைப்பை முழுவதுமாகச் செல்லாமல் பரவுகிறது
தலைப்புகளின் தவறான எடுத்துக்காட்டுகள் பின்வருமாறு:
தவறான உறை
Bug Reporting =============
மிகக் குறுகியதாக அடிக்கோடிட்டுக் காட்டுங்கள்
Bug reporting =====
நீண்ட நேரம் அடிக்கோடிட்டுக் காட்டுங்கள்
Bug reporting ================
தலைப்புகள்¶
நீங்கள் ஒரு பக்கத்தில் வைக்கக்கூடிய தலைப்புகளில் பல நிலைகள் உள்ளன. இந்த நிலைகள் இங்கே வரிசையில் காட்டப்பட்டுள்ளன:
Page title
==========
Level one
---------
Level two
^^^^^^^^^
Level three
"""""""""""
நான்கு நிலைகளுக்கு மேல் பயன்படுத்துவதைத் தவிர்க்கவும். உங்களுக்கு கூடுதல் நிலைகள் தேவை என்று நீங்கள் நினைத்தால், ஆவணம் பல பக்கங்களாகப் பிரிக்கப்பட வேண்டும் என்பதற்கான நல்ல அறிகுறியாகும். மேலும் ஆவணத்தின் இணையப் பதிப்பு அதன் உள்ளடக்க அட்டவணையில் நான்கு நிலைகளை மட்டுமே காட்டுகிறது.
உள்ளடக்க அட்டவணை¶
நீங்கள் ஒரு புதிய பக்கத்தைச் சேர்த்தால், அதை உள்ளடக்க அட்டவணையில் சேர்க்க வேண்டும். நீங்கள் உருவாக்கிய அதே கோப்பகத்தில் உள்ள index.rst கோப்பில் பக்கத்தைச் சேர்ப்பதன் மூலம் இதைச் செய்யலாம். எடுத்துக்காட்டாக, நீங்கள் "newpage.rst" என்ற கோப்பை உருவாக்கினால், அருகிலுள்ள குறியீட்டில் செவ்ரான் (>) என்று குறிக்கப்பட்ட வரியைச் சேர்ப்பீர்கள்:
.. toctree::
:maxdepth: 1
:name: example-toc
oldpage
anotheroldpage
> newpage
ஒழுங்கு முக்கியமானது. உள்ளடக்க அட்டவணையில் உங்கள் பக்கம் ஒரு குறிப்பிட்ட நிலையில் தோன்ற விரும்பினால், அதை அங்கே வைக்கவும். முந்தைய எடுத்துக்காட்டில், இந்த உள்ளடக்க அட்டவணையின் முடிவில் புதிய பக்கம் சேர்க்கப்படும்.
நகரும் பக்கங்கள்¶
சில நேரங்களில் ஒரு பக்கத்திலிருந்து ஒரு இடத்திலிருந்து ஆவணத்தில் இன்னொரு இடத்திற்கு நகர்த்துவது அவசியமாகிறது. பொதுவாக இது ஆவண ஓட்டத்தை மேம்படுத்துவதாகும்: எடுத்துக்காட்டாக, நீங்கள் வேறு பிரிவில் சேர்த்த ஒரு பக்கத்திற்குப் பிறகு பக்கம் வருவது கூடுதல் அர்த்தமுள்ளதாக இருக்கிறது.
இருப்பினும், நாங்கள் கட்டுப்படுத்தாத பல ஆதாரங்களில் இருந்து எங்கள் ஆவணங்களை மக்கள் இணைக்கின்றனர். வலைப்பதிவுகள், இணையதளங்கள் மற்றும் பிற ஆவணத் தளங்கள், அவர்கள் ஒருபோதும் புதுப்பிக்காத இணைப்புகளைப் பயன்படுத்தி மக்களை இங்கு வழிநடத்தலாம். வேறொரு தளத்திலிருந்து இணைப்பைப் பின்தொடர்ந்து 404 பக்கத்தில் இறங்குவது ஒரு பயங்கரமான பட்டறிவு, எங்கள் ஆவணத்தில் கைமுறையாகத் தேட வேண்டிய கட்டாயத்தில் உள்ளது.
இதுபோன்ற மோசமான அனுபவத்தைத் தவிர்க்க ரெடிராஃப் என்ற கருவியைப் பயன்படுத்துகிறோம். Rediraffe வழிமாற்று பக்கங்களை உருவாக்குகிறது, இது பழைய, தவறான இணைப்பிலிருந்து புதிய, பயனுள்ள இணைப்பிற்கு பயனரை அனுப்பும். ஒரு பக்கத்தின் பெயரை மாற்றும்போது அல்லது ஆவணத்தின் அடைவு கட்டமைப்பிற்குள் ஒரு பக்கத்தை நகர்த்தும்போது தயவுசெய்து ஒரு வழிமாற்று இணைப்பை உருவாக்கவும். redirects.txt கோப்பில் ஆவணத்தின் மூலத்துடன் தொடர்புடைய பழைய ஆவணத்தின் கோப்புப் பெயரையும் புதிய ஆவணத்தின் கோப்புப் பெயரையும் வைப்பதன் மூலம் வழிமாற்று இணைப்புகள் உருவாக்கப்படுகின்றன.
ரீடிராஃப்பின் செக்டிஃப் பில்டரைப் பயன்படுத்தி, ஆவணத்தில் இருந்து பக்கங்கள் திருப்பிவிடப்படாமல் நீக்கப்படாமல் இருப்பதை உறுதிசெய்கிறோம். இந்த பில்டர் களஞ்சியத்தில் உள்ள build.sh ச்கிரிப்ட்டின் ஒரு பகுதியாகவும், நீங்கள் ஒன்றிணைக்கும் கோரிக்கையை (MR) சமர்ப்பித்தவுடன் எங்களின் தானியங்கு கட்டமைப்பின் ஒரு பகுதியாகவும் இயக்கப்படும்.
பின்வருபவை நீங்கள் வழிமாற்றுகளை உருவாக்க வேண்டிய சூழ்நிலைகளின் சில எடுத்துக்காட்டுகள்.
You are moving systemdev/calendars.rst to appdev/calendars.rst. Add the following to the redirects.txt file:
"systemdev/calendars.txt" "appdev/calendars.txt"
You are moving appdev/clickable.rst into several pages in appdev/clickable/ to give significantly more information about the tool than there was previously. You have created an introduction page, appdev/clickable/introduction.rst. In this case, it would be a good idea to redirect the old page to the new introduction page. This can be done by adding the following to redirects.txt:
"appdev/clickable.rst" "appdev/clickable/introduction.rst"
எச்சரிக்கைகள்¶
உங்கள் திருத்தங்கள் ஆவண உருவாக்கத்தில் எந்த எச்சரிக்கையையும் அறிமுகப்படுத்தக்கூடாது. ஏதேனும் எச்சரிக்கைகள் ஏற்பட்டால், உருவாக்கம் தோல்வியடையும் மற்றும் ஒன்றிணைப்பு கோரிக்கை சிவப்பு 'X' உடன் குறிக்கப்படும். ஒன்றிணைக்கும் கோரிக்கையை உருவாக்கும் முன் உங்கள் RST சரியானது மற்றும் சரியானது என்பதை உறுதிப்படுத்தவும். கீழே உள்ள எங்கள் உருவாக்க வழிமுறைகளை நீங்கள் பின்பற்றினால், இது தானாகவே (ச்பிங்க்ச்-பில்ட் கிராசிங் மூலம் உங்கள் பிழையுடன்) செய்யப்படும்.
வரி நீளம்¶
இந்த களஞ்சியத்தில் வரி நீளத்திற்கு எந்த கட்டுப்பாடும் இல்லை. தயவுசெய்து ஒரு தன்னிச்சையான வரி நீளத்தில் கோடுகளை உடைக்க வேண்டாம். அதற்கு பதிலாக, உங்கள் உரை எடிட்டரில் சொல் மடக்கை இயக்கவும்.
பங்களிப்பு பணிப்பாய்வு¶
இந்த ஆவணத்தில் நீங்கள் எவ்வாறு பங்களிப்பைச் செய்யலாம் என்பதை பின்வரும் படிகள் விளக்குகின்றன.
Note
இந்த படிகளை முடிக்க உங்களுக்கு GitLab கணக்கு தேவைப்படும். உங்களிடம் கணக்கு இல்லையென்றால், ஒன்றை உருவாக்க gitlab.com க்குச் செல்லவும்.
களஞ்சியத்தை கைவிடுதல்¶
GitLab இல் ubports/docs.ubports.com ஐக் குறிப்பதன் மூலம் ஆவணத்தில் மேம்பட்ட திருத்தங்களைச் செய்யலாம்.
ஆவணங்களை உருவாக்குதல்¶
இந்த ஆவணத்தை உருவாக்க, உங்கள் களஞ்சியத்தின் உள்ளூர் நகலில் இந்த வழிமுறைகளைப் பின்பற்றவும்.
இந்த களஞ்சியத்தின் வேரில் ./பில்ட்.சே இயங்குவதன் மூலம் ஆவணங்களை உருவாக்க முடியும். ச்கிரிப்ட் ஒரு மெய்நிகர் உருவாக்க சூழலை உருவாக்கும் ~/ubportsdocsenv எதுவும் இல்லை என்றால்.
எல்லாம் சரியாக நடந்தால், நீங்கள் _build/html கோப்பகத்தை உள்ளிட்டு Ubports ஆவணங்களைக் காண index.html ஐ திறக்கலாம்.
டாக்சை உருவாக்குவதில் சிக்கல் இருந்தால், முதலில் செய்ய வேண்டியது, உருவாக்க சூழலை நீக்குவதாகும். rm -r ~/ubportsdocsenv ஐ இயக்கி மீண்டும் உருவாக்க முயற்சிக்கவும்.
உங்கள் பங்களிப்பின் இறுதி சோதனை¶
GitLab இல் உங்கள் ஒன்றிணைப்பு கோரிக்கையை நீங்கள் உருவாக்கிய பிறகு, தொடர்ச்சியான ஒருங்கிணைப்பு (CI) அமைப்பு உங்கள் பங்களிப்பை (ஒரு "பைப்லைன்") சோதனை செய்யும். இது வெற்றிகரமாக உருவாக்கப்படுகிறதா மற்றும் நீங்கள் விரும்பியபடி முடிவு இருக்கிறதா என்பதை இருமுறை சரிபார்க்கவும்:
கிட்லாப்பில் உங்கள் MR இன் "மேலோட்டப் பார்வை" தாவலின் மேலே நீங்கள் பைப்லைனின் நிலையைக் காண்பீர்கள்
"பைப்லைன் நிலையை சரிபார்க்கிறது" அல்லது "பைப்லைன் இயங்குகிறது" என்று கூறினால், தயவுசெய்து மற்றொரு மணித்துளி காத்திருக்கவும்.
சிவப்பு ஃச் உடன் "பைப்லைன் தோல்வியடைந்தது" என்று குறிப்பிட்டு, ஏதோ தவறு நடந்திருந்தால், விவரங்களைக் கண்டறிய இணைப்பைக் சொடுக்கு செய்யவும்
பச்சை நிற சரிபார்ப்பு அடையாளத்துடன் "பைப்லைன் கடந்து சென்றது" என்று கூறினால், MR வெற்றிகரமாக கட்டமைக்கப்படலாம் மற்றும் முடிவுகளைப் பார்க்க நீங்கள் தொடரலாம்
இப்போது அந்த பைப்லைனின் இணைப்பை சொடுக்கு செய்யவும்
"உருவாக்கு" வேலையை சொடுக்கு செய்யவும்
இது உங்களை பில்ட் லாக்கின் இறுதிக்கு அழைத்துச் செல்கிறது, அங்கு நீங்கள் ஒரு செய்தியைக் காண்பீர்கள்: "உருவாக்கம் வெற்றியடைந்தது, கலைப்பொருளை இங்கே உலாவவும்"
உங்கள் மாற்றங்களுடன் UBports ஆவணப்படுத்தல் தளத்தின் முழுப் பதிப்பைப் பார்க்க, அதற்கு அடுத்துள்ள இணைப்பைக் சொடுக்கு செய்யவும்
உங்கள் மாற்றங்கள் சரியாக உள்ளதா என்பதை இருமுறை சரிபார்க்கவும்
பங்களிக்க மாற்று முறைகள்¶
மொழிபெயர்ப்புகள்¶
இந்த ஆவணத்தின் கூறுகளை அதன் திட்டத்தை UBPORTS Weblate இல் மொழிபெயர்க்க நீங்கள் காணலாம்.
ஆவணங்களை எழுதுதல் rst வடிவத்தில் இல்லை¶
நீங்கள் உபோர்ட்சிற்கான ஆவணங்களை எழுத விரும்பினால், ஆனால் மறுசீரமைப்பு எழுதுவதற்கு வசதியாக இல்லை என்றால், தயவுசெய்து அதை வடிவமைக்காமல் எழுதி, தொடர்புடைய பிரிவில் (சாத்தியமான பொது) Ubports மன்றம் இல் இடுகையிடவும். உங்கள் வரைவைத் திருத்துவதற்கும் தேவையான மறுசீரமைப்பை எழுதுவதற்கும் யாராவது உங்களுக்கு உதவ முடியும்.
அறிவிலி மூலம் சங்கடமாக இருக்கிறது¶
நீங்கள் ஒரு முழுமையான ஆவணத்தை ReStructuredText இல் எழுதியிருந்தாலும் Git அல்லது GitLab ஐப் பயன்படுத்த வசதியாக இல்லை என்றால், அதை தொடர்புடைய பிரிவில் (பொதுவாக இருக்கலாம்) UBports Forum இல் இடுகையிடவும். உங்கள் வரைவைச் சரிபார்த்து, இந்த ஆவணத்தில் சமர்ப்பிக்க யாரோ ஒருவர் உங்களுக்கு உதவ முடியும்.
அனைத்தும்¶
இந்த ஆவணத்தில் சேர்க்கப்பட்டுள்ள TODOக்களை இந்தப் பிரிவு பட்டியலிடுகிறது. ஒன்றைச் சரிசெய்வது எப்படி என்று உங்களுக்குத் தெரிந்தால், அதைச் சிறப்பாகச் செய்ய எங்களுக்கு இணைப்புக் கோரிக்கையை அனுப்பவும்!
To create a todo, add this markup to your page:
.. todo::
My todo text
அனைத்தும்
ஒன்றிணைப்பு கோரிக்கைகளை கையாள்வதற்கான செயல்முறை பற்றிய ஆவணத்தை எழுதவும்.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-ta/checkouts/latest/about/process/issue-tracking.rst, line 36.)
அனைத்தும்
சில நேரங்களில் வலைபயன்பாடு+ அல்லது மாற்றுக் கொள்கலன் என குறிப்பிடப்படும் சற்றே அம்சமான வலைஅப்புகளை உருவாக்க மற்றொரு வழி உள்ளது. இந்த தேவை முறையாக ஆவணப்படுத்தப்பட வேண்டும். இது ஒரு எளிய QML பயன்பாடாகும், இது எளிதாக உள்ளமைக்க முடியும். உருவாக்கம் 'கிளாசிக்' வலைபயன்பாட்டைப் போலவே எளிமையானது, ஆனால் ஒரு நல்ல வழிசெலுத்தல் அம்சத்துடன் முடிவு மிகவும் சக்திவாய்ந்ததாகும். இதற்கு ஒரு மேம்பட்ட எடுத்துக்காட்டு யூடியூப் பயன்பாடு மேடியோ சால்டாவிலிருந்து வார்ப்புருவின் மேல் சில மாற்றங்களைக் கொண்டுள்ளது.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-ta/checkouts/latest/appdev/webapp/index.rst, line 19.)
அனைத்தும்
நெக்சச் 4 (மாகோ) க்கான செயல்முறையை ஆவணப்படுத்தவும்
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-ta/checkouts/latest/systemdev/kernel-hal.rst, line 57.)
ReadTheDocs ஓச்டிங்¶
உண்மையான ஆவணங்கள் இணையதளம் ஆனது Read The கோப்புகள் திட்டத்தால் எங்களுக்காக உருவாக்கப்பட்டு வழங்கப்படுகிறது. எங்கள் RTD அமைப்பில் ஆங்கிலத்திற்கான ஒரு முக்கிய திட்டமும், ஆதரிக்கப்படும் ஒவ்வொரு மொழிக்கும் ஒரு கூடுதல் திட்டமும் முதன்மையான திட்டத்திற்கு மொழிபெயர்ப்பாக சேர்க்கப்பட்டுள்ளது. நீங்கள் பராமரிப்பாளராக இருந்து, மொழியைச் சேர்க்க விரும்பினால், முதலில் கைமுறை இறக்குமதியுடன் புதிய திட்டத்தை உருவாக்கி, மொழியை சரியான முறையில் அமைக்கவும். பின்னர் இதை முதன்மைத் திட்டத்தின் நிர்வாகப் பக்கத்தில் மொழிபெயர்ப்பாகச் சேர்க்கவும்.