آموزش مستندات را با گردش کار مبتنی بر Git بسازید یا به آن کمک کنید

سرفصل ها و درس ها

بررسی اجمالی دوره Course Overview

• بررسی اجمالی دوره Course Overview

وقت خود را آزاد کنید یا کمی پس دهید: یک مورد برای مستندات Free up Your Time or Give a Little Back: A Case for Documentation

• نمای کلی و ساختار دوره Overview and Course Structure

شروع: پروژه اسناد خود را ایجاد کنید Getting Started: Create Your Documentation Project

• مقدمه Introduction

• نصب پیش‌نمایش Docs Install Read the Docs Prerequisites

• برای ایجاد یک پروژه مستند سازی از CLI استفاده کنید Use the CLI to Create a Documentation Project

• Visual Studio Code و مستندات بررسی اجمالی پروژه Visual Studio Code and Documentation Project Overview

• Read the Docs Theme را اعمال کنید Apply the Read the Docs Theme

• سلام دنیا Hello, World

• خلاصه Summary

استفاده از قدرت نشانه گذاری مجدد ساختار Leveraging the Power of reStructuredText Markup

• مقدمه Introduction

• بخش های TOC Tree and Document The TOC Tree and Document Sections

• قالب بندی متن Text Formatting

• لیست ها: گلوله ای ، شماره دار و چند سطح Lists: Bulleted, Numbered, and Multi-level

• پندها Admonitions

• تصاویر Images

• نمونه کد Code Samples

• جداول: چهار روش Tables: Four Methods

• لینک های پیوندی Hyperlinks

• خلاصه Summary

به روزرسانی خودکار با گردش کار ساده Automating Updates with a Streamlined Workflow

• مقدمه Introduction

• Git و GitHub: معرفی و نصب کنید Git and GitHub: Introduce and Install

• مخزن GitHub را برای کد منبع ایجاد و بارگذاری کنید Create and Load GitHub Repository for the Source Code

• تنظیم میزبان Docs را بخوانید Set up Read the Docs Hosting

• ادغام مداوم/تحویل مداوم توضیح داده شده است Continuous Integration/continuous Delivery Explained

• تنظیم ادغام مداوم/تحویل مداوم توضیح CI/CD در Read Docs Set Continuous Integration/continuous Delivery Explained up CI/CD on Read the Docs

• درخواستهای کشیده توضیح داده شده است Pull Requests Explained

• GitHub را به گونه ای پیکربندی کنید که درخواستهای Pull را به Master نیاز دارد Configure GitHub to Require Pull Requests to Master

• ارسال تغییر از طریق درخواست Pull Submit a Change via Pull Request

• درخواست Pull را تأیید و ادغام کنید Approve and Merge the Pull Request

• خلاصه Summary

محتوایی که فراتر از reStructuredText است Content That Goes Beyond reStructuredText

• مقدمه Introduction

• CSS سفارشی: رویکرد Custom CSS: The Approach

• چرا سفارشی CSS: کنترل پیمایش افقی در جداول Why Custom CSS: Control Horizontal Scroll on Tables

• CSS سفارشی را به پروژه اضافه کنید Add Custom CSS to the Project

• پشتیبانی Markdown و یک سند Markdown را اضافه کنید Add Markdown Support and a Markdown Document

• نسخه ها: مقدمه Versions: Introduction

• نسخه ها را با یک شعبه طولانی مدت فعال کنید Enable Versions with a Long-lived Branch

• با تغییر دادن تغییر در شعب ، رفتار نسخه را تأیید کنید Verify Version Behavior by Rolling a Change Through Branches

• خلاصه Summary

میزبانی از گزینه های مستند و منبع آن Hosting Alternatives for the Documentation and Its Source

• مقدمه Introduction

• گزینه های میزبانی بررسی شده است Hosting Options Explored

• تنظیم Repo در Visual Studio Team Services (VSTS) Set up Repo in Visual Studio Team Services (VSTS)

• VSTS Build Agents: توضیحات و بررسی اجمالی فرآیند VSTS Build Agents: Explanation and Process Overview

• یک عامل ساخت محلی VSTS تنظیم کنید Set up a Local VSTS Build Agent

• ساخت VSTS ساخت تعریف و ساخت اسناد Create VSTS Build Definition and Build the Docs

• تنظیم نمایندگی VSTS Set up VSTS Deploy Agent

• تعریف VSTS Release را ایجاد کرده و آن را اجرا کنید Create VSTS Release Definition and Execute It

• CI/CD را با VSTS تنظیم کنید ، Push Change را برای ویرایش در GitHub فشار دهید Set up CI/CD with VSTS, Push Change for Edit on GitHub

• نتیجه Conclusion