چگونه می توان با اتصال Gitlab به Mkdocs مستندات نرم افزاری خود را بهبود بخشید

عکس پروفایل نویسنده

@hatembentayebحاتم بن طیب

کاربر Archlinux | مهندس Devops | نویسنده فنی | علاقه مندان اتوماسیون | IaaC | CaaC | GitOps

تهیه مستندات ممکن است دردناک باشد و برای نوشتن و کار به زمان زیادی نیاز دارد. در این داستان ، من نحوه تولید اسناد با استفاده از رویکرد devops را با شما به اشتراک می گذارم. برای سهولت زندگی ، هنر اتوماسیون را کشف خواهیم کرد.

بیا بریم مردمی

یک repo Gitlab ایجاد کنید

این ساده است ، این مراحل را دنبال کنید:

  • وارد GitLab خود شوید
  • روی پروژه جدید کلیک کنید
  • یک اسم بگذارید: auto_docs
  • آن را با یک فایل README.md شروع کنید
  • آن را عمومی یا خصوصی کنید

اکنون پروژه را با کپی کردن URL شبیه سازی کنید و این دستور را اجرا کنید:

$ git clone https://gitlab.com/auto_docs.git

من از یک محیط لینوکس استفاده می کنم اما امکان تولید مراحل مشابه در دستگاه ویندوز وجود دارد.

برای دنبال کردن من ، شما به مجموعه ای از ابزارها نیاز دارید که باید در دستگاه شما موجود باشد … مطمئن شوید که python3 را نصب کرده اید ، من پایتون 3.8 (جدیدترین) را دارم.

ایجاد یک فضای مجازی

ساده ترین راه برای تنظیم یک محیط مجازی نصب بسته پایتون virtualenv با اجرای آن است

pip install virtualenv

.

به مخزن محلی GitLab خود بروید و یک فضای مجازی جدید ایجاد کنید.

$ cd auto_docs/
$ virtualenv autodocs
$ source autodocs/bin/acivate

نصب Mkdocs Material

اطمینان حاصل کنید که …

Leave a reply

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>