اصطلاحات التسمية

أسماء موارد العينات

تستخدم أسماء موارد العينات والعرض التوضيحي البادئة example- بأسلوب kebab-case. يحافظ هذا على الاتساق عبر التوثيق ومواصفات API وعينات الأكواد والإعدادات المُولَّدة في جميع أنحاء المنظومة.

metadata:
  name: example-http-lb
  namespace: example-namespace

استخدم example- — لا my- أو test- أو foo- أو demo- أو sample- أو العناصر النائبة الشبيهة بأسماء الشركات مثل mycompany — لأي اسم مورد في العينات. ينطبق هذا على:

• حقول name الخاصة بالموارد في الأمثلة،
• قيم example: في مواصفات سير العمل والمعاملات،
• قيم الأمثلة في OpenAPI،
• ملفات Terraform النموذجية (.tf).

ما لا يشمله هذا المعيار

ينطبق الاصطلاح على أسماء موارد العينات فحسب. اترك ما يلي دون تغيير:

• أسماء السمات والحقول (مثلاً test_key)،
• كود الاختبار الفعلي وأدلة test/،
• أسماء الحزم والتبعيات،
• النطاقات وعناوين البريد الإلكتروني في الأمثلة، التي تتبع الاصطلاح بالفعل (app.example.com، user@example.com).

أمثلة

بدلاً من	استخدم
my-origin-pool	example-origin-pool
test-namespace	example-namespace
demo-app	example-app
mycompany	example-company