الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

Gov.uk الوثائق الفنية لتسجيل الدخول

يحتوي هذا الريبو على وثائق لمساعدة التقنيين في الإدارات الحكومية على متن حاكم واحد. تم نشره باستخدام قالب الوثائق الفنية.

إجراء تغييرات في المحتوى

يمتلك فريق الكتابة الفنية Gov.uk One Login هذه الوثائق وله مسؤولية الموافقة على تغييرات المحتوى. إنه مكتوب ليكون محور المستخدم وتلبية معايير محتوى GDS ، مما يعني ما يلي:

  • Gov.uk إرشادات حول التخطيط والكتابة وإدارة المحتوى
  • دليل نمط Gov.uk
  • دليل النمط الفني Gov.uk
  • مبادئ الكتابة الواضحة الأخرى

إذا كنت تعمل على تسجيل الدخول إلى Gov.uk واحد ، فيجب عليك الاتصال بفريق كتابة التكنولوجيا للحصول على مساعدة في تغييرات المحتوى ما لم تكن صغيرة ولا تؤثر على سلوك المستخدم.

تشمل تغييرات المحتوى الصغيرة:

  • إضافة توضيحات لتحسين الفهم
  • تصحيح عينات الرمز
  • إصلاح الروابط المكسورة أو الأخطاء المطبعية

يمكنك إجراء هذه التغييرات بنفسك ثم طلب مراجعة كاتب تقني على طلب السحب. إذا لم تكن متأكدًا مما إذا كان التغيير صغيرًا ، فاتصل بنا على قناة Slack #-Di-Technical.

إجراء تغييرات فنية

فريق التزامن مسؤول عن الصيانة والصحة التشغيلية لمنصة مستندات التكنولوجيا. يجب عليك استشارةهم للموافقة على أي تغييرات في هذا المجال.

تشمل الأمثلة:

  • التغييرات في سير عمل عمل جيثب
  • التغييرات في نشر AWS أو بناء البنية التحتية
  • تحديثات التبعية
  • تحديثات روبي التي لا تغير المحتوى

معاينة تغييرات الوثائق الخاصة بك

لمعاينة أي تغييرات وإضافات أجريتها على الوثائق في المتصفح ، استنساخ هذا الريبو واستخدم Dockerfile في هذا الريبو لتشغيل خادم وسيط على جهازك دون الحاجة إلى إعداد Ruby محليًا.

لقد تم تمكين إعادة تحميل هذا الإعداد ، مما يعني أنه سيتم تطبيق التغييرات الخاصة بك عند تحرير الملفات في دليل المصدر. الاستثناء الوحيد لهذا هو إذا قمت بإجراء تغييرات على config/tech-docs.yml ، فيجب عليك إيقاف الخادم وإعادة تشغيله لرؤية التغييرات الخاصة بك في المعاينة. يمكنك إيقاف الخادم باستخدام Ctrl-C .

قم بتشغيل نص المساعد: 

./preview-with-docker.sh

قد يستغرق الأمر بضع دقائق لبناء حاوية Docker ، خاصة إذا كانت المرة الأولى التي تقوم فيها بتشغيل البرنامج النصي. عندما ينتهي الخادم ، يجب عليك رؤية الإخراج التالي في المحطة: 

== View your site at " http://localhost:4567 " , " http://127.0.0.1:4567 "
== Inspect your site configuration at " http://localhost:4567/__middleman " , " http://127.0.0.1:4567/__middleman " /usr/local/bundle/gems/tilt-2.0.11/lib/tilt/redcarpet.

إجراء تغييرات على الرسم البياني

الرسوم البيانية هي محتوى ، لذلك بمجرد إجراء تغيير ، يجب عليك طلب مراجعة من فريق الكتابة الفنية.

يمكنك تحرير ملفات Draw.io في مجلد source/images/originals عن طريق تثبيت واستخدام تطبيق سطح المكتب Draw.io.

استخدم ملف Draw.io لكل رسم بياني.

تثبيت تطبيق Draw.io Desktop

قم بتشغيل الأوامر التالية لاستخدام تطبيق Draw.io Desktop من سطر الأوامر. 

 brew install --cask drawio
alias draw.io='/Applications/draw.io.app/Contents/MacOS/draw.io'

تحرير ونشر مخطط

اتبع هذه الخطوات:

  1. إنشاء وتعديل مخطط باستخدام Draw.io.
  2. احفظ ملف Draw.io إلى المجلد source/images/originals .
  3. نشر الرسم البياني كرسومات متجه قابلة للتطوير (SVG).
  4. احفظ ملف SVG إلى مجلد source/images .

أوامر مفيدة

تحديث مخطط: 

 draw.io source/images/originals/top-level-technical-diagram.drawio

قم بإنشاء إصدارات SVG من المخططات وحفظها إلى المجلد source/images/originals : 

 draw.io -x -o source/images/top-level-technical-diagram.svg source/images/originals/top-level-technical-diagram.drawio

draw.io -x -o source/images/technical-flow-diagram.svg source/images/originals/technical-flow-diagram.drawio

قم بتبني الوثائق الفنية لتسجيل الدخول إلى Gov.uk

يستخدم هذا المستودع Vale و GDS Tech Docs قواعد Linter.

تثبيت linter على جهازك المحلي

تحتاج إلى:

  • تثبيت homebrew
  • تثبيت Vale

قم ببث محرر الرمز الخاص بك

يوفر العديد من محرري التعليمات البرمجية ملحقات أو ملحقات إضافية لـ Vale والتي يمكن أن ترفع الأخطاء أثناء تحديث الوثائق. ستظل بحاجة إلى تثبيت Vale على جهازك المحلي.

linting مع واجهة سطر الأوامر Vale (CLI)

بشكل افتراضي ، يجب تشغيل Vale من نفس الدليل مثل ملف التكوين هذا ، ما لم يتم توفير علامة --config بمسار. لتشغيل Linter باستخدام Vale CLI:

  1. في نافذة محطة ، انتقل إلى الريبو الخاص بك.
  2. قم بتشغيل vale sync لتنزيل أحدث حزمة Tech-Docs-Linter وقم بفك هذا إلى StylesPath المدرجة في ملف التكوين الخاص بك.
  3. تشغيل الأمر vale . لتربط الريبو بأكمله أو توفير طريق إلى دليل للترسيب هذا الدليل فقط على سبيل المثال: vale ./source/go-live

التحديث إلى أحدث مستندات تقنية قواعد linter

إذا تمت إضافة قاعدة جديدة إلى مجموعة قواعد Linter Docs Tech ، فيمكنك رفع الحزمة التي يستخدمها هذا الريبو عندما تكون جاهزًا. يمكن اختبار نسخة لاحقة من مجموعة القواعد وإضافتها بواسطة:

  1. إنشاء فرع.
  2. قم بتحديث رقم إصدار الحزمة في ملف Config Vale.
  3. قم بتشغيل vale sync لتنزيل أحدث حزمة.
  4. تشغيل vale ./source لاختبار Linter.
  5. إصلاح أي تغييرات قواعد جديدة ترفع (يفضل أن تلتزم واحد لكل انتهاك للقاعدة).
  6. ارفع العلاقات العامة مع أحدث رقم إصدار في ملف تكوين Vale.

مدونة لقواعد السلوك

يرجى الرجوع إلى مدونة السلوك alphagov .

رخصة

ما لم ينص على خلاف ذلك ، يتم إصدار قاعدة كود تحت رخصة معهد ماساتشوستس للتكنولوجيا. ويغطي هذا كل من قاعدة الشفرة وأي رمز عينة في الوثائق.

الوثائق هي © Crown Copyright ومتاحة بموجب شروط ترخيص الحكومة المفتوحة 3.0.

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل