এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- লিনাক্স ফাউন্ডেশন
- কৌশলী লেখক:
- বোরন
- প্রকল্পের নাম:
- ডকুমেন্টেশন হোস্টিং এবং জেনারেশন এবং পুনর্গঠন শুরু করার পৃষ্ঠাগুলি এবং বিকাশকারী নির্দেশিকাগুলি পুনরায় কাজ করুন৷
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
বিমূর্ত:
একটি ডকুমেন্টেশন শেষ ব্যবহারকারী এবং বিকাশকারীদের একটি পণ্য বা পরিষেবা ব্যবহার করতে সহায়তা করার জন্য ডিজাইন করা হয়েছে। ভাল ডকুমেন্টেশন খুবই গুরুত্বপূর্ণ কারণ এটি ব্যবহারকারীদের একটি সফ্টওয়্যার, এর বৈশিষ্ট্য, টিপস, কৌশল এবং সফ্টওয়্যার ব্যবহার করার সময় যে সাধারণ সমস্যার সম্মুখীন হয় তা কীভাবে ব্যবহার করতে হয় তা শিখতে একটি উপায় প্রদান করে৷ এটি সমর্থন খরচও হ্রাস করে এবং পণ্যটির কর্পোরেট এবং ওপেন সোর্স পরিচয়ের অংশ: একটি ভাল ডকুমেন্টেশন পণ্য এবং বিকাশকারী দলের সুস্থতার লক্ষণ।
একটি ভাল ডকুমেন্টেশন ছাড়া, একজন ব্যবহারকারী উপরের জিনিসগুলি কীভাবে কার্যকরভাবে এবং দক্ষতার সাথে করতে হয় তা জানেন না। একটি পণ্যের সাফল্য নিশ্চিত করতে ডকুমেন্টেশন একটি গুরুত্বপূর্ণ ভূমিকা পালন করতে পারে কারণ মহান যোগাযোগ সর্বদা যেকোনো ব্যবসা বা পণ্যের কেন্দ্রবিন্দুতে থাকে এবং একটি দুর্দান্ত ডকুমেন্টেশন কেবল সেই যোগাযোগকে গ্রহণ করে এবং এটিকে একটি পরিচালনাযোগ্য কাঠামোতে রাখে যা প্রত্যেকে সাফল্যের জন্য অ্যাক্সেস করতে পারে।
প্রতিটি ডকুমেন্টেশন সাইটের জন্য একটি ভাল বিল্ডিং এবং হোস্টিং ওয়ার্কফ্লো পাইপলাইন প্রয়োজন, AGL-এর মতো একটি সংস্থায়, একাধিক সংস্করণ এবং প্রচুর বিশদ ডকুমেন্টেশন সহ, ডকুমেন্টেশন ফাইলগুলি (মার্কডাউন) একাধিক রিপোজিটরি জুড়ে ছড়িয়ে রয়েছে, যা তাদের বজায় রাখা এবং আপডেট করার কাজটিকে অবিশ্বাস্যভাবে জটিল করে তোলে। এবং সময় নিবিড়।
বর্তমান অবস্থা :
- AGL ডক ওয়েবসাইটটি বিভিন্ন রিপোজিটরি থেকে আনা মার্কডাউন ফাইলের সংগ্রহের উপর ভিত্তি করে।
- ডক পৃষ্ঠাগুলি বর্তমানে কর্ডোভা প্রকল্পের ইঞ্জিন ব্যবহার করে মার্কডাউন হিসাবে পৃথক উত্সের মধ্যে হোস্ট করা হয়েছে৷
- এটি ডকুমেন্টেশন তৈরি এবং হোস্টিং প্রক্রিয়ার জন্য একটি চারটি সংগ্রহস্থল সেটআপের দিকে নিয়ে যায়:
- ডক্স-ওয়েবটেমপ্লেট [https://github.com/automotive-grade-linux/docs-webtemplate] : জেকিল ওয়েবসাইট টেমপ্লেট রয়েছে।
- ডক্স-টুলস [https://github.com/automotive-grade-linux/docs-tools] : মার্কডাউন ফাইল থেকে স্বয়ংক্রিয়ভাবে একটি প্রযুক্তিগত ওয়েবসাইট তৈরি করার জন্য টুল রয়েছে।
- ডক্স-সোর্স [https://github.com/automotive-grade-linux/docs-sources] : উৎস (মার্কডাউনস [https://github.com/automotive-grade-linux/docs-sources/tree/master/docs ]) সাধারণ নথি, গাইডের জন্য।
- ডক্স-ঘ-পৃষ্ঠাগুলি [https://github.com/automotive-grade-linux/docs-gh-pages] : ডকুমেন্টেশন সাইটের জন্য GitHub পৃষ্ঠাগুলির ভাণ্ডার স্থাপন করা হয়েছে [https://gist.github.com/growupboron/docs। automotivelinux.org]।
- ডক্স-টুলগুলিতে উপলব্ধ একটি টুল (স্ক্রিপ্ট) [https://github.com/automotive-grade-linux/docs-tools] ডক্স-ওয়েবটেমপ্লেটে অবস্থিত fetched_files.yml অনুযায়ী সমস্ত মার্কডাউন ফাইল সংগ্রহ এবং টেমপ্লেট করার যত্ন নেয় [ https://github.com/automotive-grade-linux/docs-webtemplate]।
- agl ডকুমেন্টেশন ওয়েবসাইট তৈরির বর্তমান কর্মপ্রবাহ : current_workflow [https://drive.google.com/file/d/1OSwkVWFcsajgCOjbtdPf42EIfpidUJ0U/view?usp=sharing]
- section_version.yml-এ সমস্ত বইয়ের yaml ফাইলের লিঙ্ক রয়েছে, এটি রিমোট রিপোজিটরি থেকে ডক্স-ওয়েবটেমপ্লেটে [https://github.com/automotive-grade-linux/docs-webtemplate]-এ সমস্ত বইয়ের yaml ফাইল আনার জন্য এগিয়ে যায়। বই yaml ফাইলগুলি রিমোট রিপোজিটরি থেকে আপনার মার্কডাউন ফাইলগুলির সমস্ত url ধারণ করে৷
- সমস্ত মার্কডাউন ফাইল আনার সাথে সাথে, ডক্স-ঘ-পৃষ্ঠাগুলিতে AGL ডক ওয়েবসাইট তৈরি করার জন্য টুল প্রক্রিয়া [https://github.com/automotive-grade-linux/docs-gh-pages] যা অনুরূপভাবে মোতায়েন
- পাইপলাইন রক্ষণাবেক্ষণের বর্তমান প্রক্রিয়া ব্যবহারকারী এবং বিকাশকারী বন্ধুত্বপূর্ণ নয়, বিশেষ করে নতুন অবদানকারীদের জন্য। এই ওয়ার্কফ্লো পাইপলাইন (বিল্ডিং এবং হোস্টিং) আরও সরলীকৃত এবং স্ট্রিমলাইন করা যেতে পারে ডেভেলপারদের জন্য ডকুমেন্টেশন জেনারেশন এবং ডিপ্লয়মেন্ট ওয়ার্কফ্লো বজায় রাখার পরিবর্তে ডকুমেন্টেশন অংশে ফোকাস করার জন্য।