گٹ بک کا استعمال کرتے ہوئے ایک سادہ اندرونی وکی کیسے بنائیں

گٹ بک کا استعمال کرتے ہوئے ایک سادہ اندرونی وکی کیسے بنائیں

GitBook ایک ایسا پلیٹ فارم ہے جو آپ کو دستاویزات کی سائٹس یا کمپنی وکی بنانے کی اجازت دیتا ہے۔ آپ اسے کوڈ سے لے کر APIs تک اور کسی سافٹ ویئر پروڈکٹ کو استعمال کرنے کے طریقے تک ہر قسم کی چیزوں کو دستاویز کرنے کے لیے استعمال کر سکتے ہیں۔





سرگوشی پر کسی کو کیسے تلاش کریں۔

GitBook GitHub ذخیروں سے ملتا جلتا عمل استعمال کرتا ہے۔ دستاویزات کی مرکزی کاپی 'ماسٹر' کاپی کے طور پر کام کرتی ہے۔ اس کے بعد آپ 'ڈرافٹس' بنا سکتے ہیں، جو 'شاخوں' سے ملتے جلتے ہیں۔





یہ عمل بہت سے صارفین کو ایک دستاویزی سائٹ پر کام کرنے کی اجازت دیتا ہے جب کہ تنازعات کو سنبھالتے یا روکتے ہیں۔ یہ مختلف شاخوں کی تبدیلیوں کو آپ کے ضم کرنے سے پہلے جائزہ لینے کے عمل سے گزرنے کی بھی اجازت دیتا ہے۔





GitBook کا استعمال کیسے شروع کریں۔

آپ کئی میں سے انتخاب کر سکتے ہیں۔ گٹ بک کی قیمت منصوبے قیمتوں کا انحصار اس بات پر ہوگا کہ آیا آپ GitBook کو اوپن سورس پروجیکٹس، ذاتی استعمال، یا نجی ٹیم کے تعاون کے لیے استعمال کر رہے ہیں۔ اگر آپ اسے اوپن سورس پروجیکٹس کے لیے استعمال کر رہے ہیں تو GitBook استعمال کرنے کے لیے مفت ہے۔

GitBook سپورٹ کرتا ہے۔ مارک ڈاؤن، بہت سے فوائد کے ساتھ ایک مقبول مارک اپ زبان ویب پر لکھنے یا دستاویز کرنے کے لیے۔



GitBook کے ساتھ بھی ضم ہوتا ہے۔ GitHub، کوڈ کی میزبانی، ذخیرہ کرنے اور ترمیم کرنے کا ایک پلیٹ فارم . آپ اپنے GitHub اسناد کا استعمال کرتے ہوئے سائن ان کر کے اپنے GitBook اکاؤنٹ کو براہ راست اپنے GitHub اکاؤنٹ سے لنک کر سکتے ہیں۔

  1. GitBook میں سائن اپ کریں۔ اگر آپ کا اپنا GitHub اکاؤنٹ ہے، تو آپ کلک کر سکتے ہیں۔ GitHub کے ساتھ سائن اپ کریں۔ .
  2. ایک بار جب آپ سائن ان ہو جائیں گے، GitBook آپ کو ایک نئے اندرونی ویکی پر بھیج دے گا۔ یہ آپ کے ویکی کو کچھ نمونے والے مواد کے ساتھ بھی پہلے سے آباد کر دے گا۔

GitBook انٹرفیس کا ایک جائزہ

GitBook میں کئی افعال ہیں جو آپ کو اپنی دستاویزات کی سائٹ بنانے اور اس میں تبدیلیاں کرنے کی اجازت دیتے ہیں۔





ونڈوز 10 2017 کے لیے بہترین میوزک پلیئر۔
  1. اوپر والا پینل آپ کو نئے مسودے بنانے، تبدیلی کی سرگزشت دیکھنے، یا کوئی دوسری بات چیت یا منسلکات دیکھنے کی اجازت دیتا ہے۔
  2. بائیں طرف سب سے زیادہ سائڈبار آپ کو متعدد جگہیں بنانے کی اجازت دیتا ہے۔ آپ مختلف پروجیکٹس کے لیے الگ جگہیں استعمال کر سکتے ہیں تاکہ آپ اپنے دستاویزات کے علاقوں کو الگ اور منظم کر سکیں۔ آپ سائڈبار کو بڑھا یا بند کر سکتے ہیں۔
  3. بائیں پینل دستاویزی سائٹ کے مینو کے طور پر کام کرتا ہے۔ آپ اپنی دستاویزات کی سائٹ کے اندر صفحات دیکھ سکتے ہیں، اور اسے گروپس اور نیسٹڈ پیجز بنانے کے لیے استعمال کر سکتے ہیں۔ آپ فراہم کردہ لنکس کا استعمال کرتے ہوئے پوری سائٹ پر بھی جا سکتے ہیں۔
  4. نیچے والے پینل میں وہ بٹن شامل ہیں جو ورژن کنٹرول کے عمل کے لیے اہم ہیں۔ آپ اپنے مسودے کے لیے ایک نام شامل کر سکتے ہیں، تبدیلی کو ضم کر سکتے ہیں، یا تبدیلی کو جائزہ کے لیے جمع کر سکتے ہیں۔

نیا ڈرافٹ کیسے بنایا جائے۔

آپ ایک نئی تبدیلی کی درخواست بنا کر اور اس میں تبدیلیاں کر کے نیا مسودہ بنا سکتے ہیں۔

  1. اوپر والے پینل میں، پر کلک کریں۔ درخواستیں تبدیل کریں۔ .
  2. نئے پینل پر جو دائیں طرف ظاہر ہوتا ہے، پر کلک کریں۔ مسودہ ٹیب یہ آپ کو آپ کے تمام فعال ڈرافٹ دکھائے گا۔
  3. یہاں سے، آپ اسے کھولنے کے لیے موجودہ مسودے پر کلک کر سکتے ہیں۔ نیا مسودہ بنانے کے لیے، پر کلک کریں۔ تبدیلی کی نئی درخواست ، اور صفحہ کی لوڈنگ مکمل ہونے کا انتظار کریں۔
  4. نیچے والے پینل میں، پر کلک کریں۔ ایک مضمون درج کریں۔ . اس سے ایک ونڈو کھل جائے گی جہاں آپ نئے مسودے کو ایک نام دے سکتے ہیں۔ مثال کے طور پر، نیا صفحہ - کوڈ بیس کو کیسے ترتیب دیا جائے۔ .

پیجز اور گروپس کیسے بنائیں

ایک بار جب آپ کے پاس ایک مسودہ ہے، تو آپ دستاویزات میں تبدیلیاں کرنا شروع کر سکتے ہیں۔ GitBook آپ کی تبدیلیوں کو ڈرافٹ کے اندر محفوظ کرتا ہے، لہذا وہ ماسٹر کاپی کو متاثر نہیں کرتے ہیں۔ آپ صفحات اور صفحہ گروپس کو شامل کرنے کے لیے بائیں طرف کی سائڈبار استعمال کر سکتے ہیں۔





کروم ڈاؤن لوڈ کو تیز کرنے کا طریقہ
  1. پر کلک کرکے ایک نیا صفحہ بنائیں نیا صفحہ سائڈبار کے نیچے لنک، اور منتخب کرنا دستاویز کا نیا صفحہ ڈراپ ڈاؤن سے. متبادل طور پر، آپ موجودہ صفحہ کے نیچے منڈلا سکتے ہیں اور نیلے رنگ پر کلک کر سکتے ہیں۔ پلس بٹن
  2. نیا پیج گروپ بنانے کے لیے، پر کلک کریں۔ نیا صفحہ ، اور منتخب کریں۔ نیا گروپ ڈراپ ڈاؤن سے آپشن۔
  3. آپ صفحہ یا گروپ کے آگے تین نقطوں پر کلک کرکے اور منتخب کرکے صفحہ کا نام تبدیل کرسکتے ہیں۔ نام تبدیل کریں۔ .
  4. اپنے نئے صفحہ کو آباد کرنے کے لیے مواد شامل کرنا شروع کریں۔ آپ سادہ مواد جیسے متن یا عنوانات شامل کر سکتے ہیں۔ GitBook آپ کو دیگر مواد کے بلاکس جیسے تصاویر، فائل اٹیچمنٹ، ٹیبلز، ٹیبز، یا کوڈ کے ٹکڑوں کو شامل کرنے کی بھی اجازت دیتا ہے۔ دوسرے انضمام جیسے یوٹیوب ایمبیڈز یا گوگل ڈاکس مواد شامل کرنے کا اختیار بھی ہے۔
  5. پر کلک کریں اختلاف نظر اپنے ڈرافٹ اور اصل ماسٹر دستاویزی کاپی کے درمیان فرق دیکھنے کے لیے نیچے والے پینل میں بٹن۔
  6. ایک بار جب آپ اپنا مواد لکھنا ختم کر لیتے ہیں، تو آپ کلک کر سکتے ہیں۔ ضم , جمع کروائیں اور ضم کریں۔ ، یا جائزہ لینے کے لیے جمع کرائیں۔ .

آپ GitBook کے اوپری پینل سے شیئر لنک تک رسائی حاصل کر سکتے ہیں۔ لنک کو دیکھنے کے قابل ہونے کے لیے آپ کو مسودہ سے باہر ہونے اور ماسٹر دستاویزات کی کاپی دیکھنے کی ضرورت ہوگی۔

  1. پہلے سے طے شدہ طور پر، آپ کی دستاویزات کی سائٹ کی مرئیت 'غیر فہرست' ہے۔ اس کا مطلب یہ ہے کہ آپ ایک نجی لنک کا استعمال کرتے ہوئے دستاویزات کی سائٹ تک رسائی حاصل کر سکتے ہیں، نہ کہ سرچ انجن کے ذریعے۔ اوپر والے پینل میں، پر کلک کریں۔ غیر فہرست شدہ بٹن
  2. ڈراپ ڈاؤن سے اپنی مطلوبہ مرئیت کی ترتیبات منتخب کریں۔ نوٹ کریں کہ GitBook کچھ مرئیت کی ترتیبات کو مقفل کر سکتا ہے، اور آپ کو ان تک رسائی کے لیے اپ گریڈ کرنے کی ضرورت پڑ سکتی ہے۔
  3. مرئیت کی ترتیبات کی فہرست کے نیچے، ایک لنک ہے جسے آپ دوسرے صارفین کے ساتھ شیئر کر سکتے ہیں جو آپ کی دستاویزات کی سائٹ استعمال کریں گے۔ دوسروں کے ساتھ شیئر کرنے کے لیے اس لنک کو کاپی کریں۔
  4. لنک کے نیچے، پر کلک کریں۔ لنک اور ڈومین کی ترتیبات . یہ وہ جگہ ہے جہاں آپ اپنی مرضی کے مطابق ڈومین نام کو لنک کر سکتے ہیں، یا URL کے کچھ حصے میں ترمیم کر سکتے ہیں۔ اگر آپ اپنی مرضی کے مطابق ڈومین استعمال کر رہے ہیں، تو آپ دیکھ سکتے ہیں۔ گٹ بک کی دستاویزات اپنے DNS کو صحیح طریقے سے کنفیگر کرنے کا طریقہ۔

گٹ بک کا استعمال کرتے ہوئے دستاویزات بنانا

GitBook آپ کو باہمی تعاون کے ساتھ دستاویزات کی سائٹس یا کمپنی وکی پر کام کرنے کی اجازت دیتا ہے۔ GitBook GitHub سے تصورات ادھار لیتا ہے جیسے شاخوں اور ایک ماسٹر کاپی کو کنٹرول کرنے اور کسی بھی تنازعات کو منظم کرنے کے لیے انضمام۔

آپ دستاویزات میں اپنی انفرادی تبدیلیاں شامل کرنے کے لیے ایک نیا مسودہ بنا سکتے ہیں۔ مسودے کے اندر، آپ مواد میں تبدیلیاں کرنے کے ساتھ ساتھ نئے صفحات یا صفحہ گروپس کو شامل کر سکتے ہیں۔ ایک بار جب آپ اپنی تبدیلیاں مکمل کر لیں، تو آپ یا تو انہیں ضم کر سکتے ہیں یا جائزہ کے لیے جمع کر سکتے ہیں۔

اگر آپ اپنے جاوا کوڈ کے لیے اندرونی دستاویزات بنا رہے ہیں، تو آپ Javadoc کو تلاش کرنا چاہیں گے۔ Javadoc آپ کو اپنے جاوا کوڈ کو خود بخود دستاویز کرنے کی اجازت دیتا ہے۔