diff --git a/star-docs/docusaurus.config.ts b/star-docs/docusaurus.config.ts index f1ca617..05cd514 100644 --- a/star-docs/docusaurus.config.ts +++ b/star-docs/docusaurus.config.ts @@ -41,10 +41,10 @@ const config: Config = { [ '@docusaurus/plugin-content-docs', { - id: 'onboarding', - path: 'onboarding', - routeBasePath: 'onboarding', - sidebarPath: './sidebarsOnboarding.ts' + id: 'people', + path: 'people', + routeBasePath: 'people', + sidebarPath: './sidebarsPeople.ts' } ], [ @@ -56,6 +56,15 @@ const config: Config = { sidebarPath: './sidebarsDocuments.ts' } ], + [ + '@docusaurus/plugin-content-docs', + { + id: 'engineering', + path: 'engineering', + routeBasePath: 'engineering', + sidebarPath: './sidebarsEngineering.ts' + } + ], ], presets: [ @@ -105,8 +114,12 @@ const config: Config = { to: '/team', }, { - label: 'شروع به کار', - to: '/onboarding/intro', + label: 'منابع انسانی', + to: '/people/intro', + }, + { + label: 'مهندسی', + to: '/engineering/intro', }, { label: 'مستندات', diff --git a/star-docs/engineering/01-intro.md b/star-docs/engineering/01-intro.md new file mode 100644 index 0000000..ae6259b --- /dev/null +++ b/star-docs/engineering/01-intro.md @@ -0,0 +1 @@ +# مهندسی \ No newline at end of file diff --git a/star-docs/engineering/02-checklists/_category_.json b/star-docs/engineering/02-checklists/_category_.json new file mode 100644 index 0000000..a9142f0 --- /dev/null +++ b/star-docs/engineering/02-checklists/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "چک لیست‌ها" +} \ No newline at end of file diff --git a/star-docs/onboarding/checklists/debugging/_category_.json b/star-docs/engineering/02-checklists/debugging/_category_.json similarity index 100% rename from star-docs/onboarding/checklists/debugging/_category_.json rename to star-docs/engineering/02-checklists/debugging/_category_.json diff --git a/star-docs/onboarding/checklists/debugging/backend/_category_.json b/star-docs/engineering/02-checklists/debugging/backend/_category_.json similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/_category_.json rename to star-docs/engineering/02-checklists/debugging/backend/_category_.json diff --git a/star-docs/onboarding/checklists/debugging/backend/dot-trace.md b/star-docs/engineering/02-checklists/debugging/backend/dot-trace.md similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/dot-trace.md rename to star-docs/engineering/02-checklists/debugging/backend/dot-trace.md diff --git a/star-docs/onboarding/checklists/debugging/backend/dotnet-tools/_category_.json b/star-docs/engineering/02-checklists/debugging/backend/dotnet-tools/_category_.json similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/dotnet-tools/_category_.json rename to star-docs/engineering/02-checklists/debugging/backend/dotnet-tools/_category_.json diff --git a/star-docs/onboarding/checklists/debugging/backend/dotnet-tools/dotnet-counters.md b/star-docs/engineering/02-checklists/debugging/backend/dotnet-tools/dotnet-counters.md similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/dotnet-tools/dotnet-counters.md rename to star-docs/engineering/02-checklists/debugging/backend/dotnet-tools/dotnet-counters.md diff --git a/star-docs/onboarding/checklists/debugging/backend/dotnet-tools/dotnet-dump.md b/star-docs/engineering/02-checklists/debugging/backend/dotnet-tools/dotnet-dump.md similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/dotnet-tools/dotnet-dump.md rename to star-docs/engineering/02-checklists/debugging/backend/dotnet-tools/dotnet-dump.md diff --git a/star-docs/onboarding/checklists/debugging/backend/dotnet-tools/dotnet-trace.md b/star-docs/engineering/02-checklists/debugging/backend/dotnet-tools/dotnet-trace.md similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/dotnet-tools/dotnet-trace.md rename to star-docs/engineering/02-checklists/debugging/backend/dotnet-tools/dotnet-trace.md diff --git a/star-docs/onboarding/checklists/debugging/backend/elk.md b/star-docs/engineering/02-checklists/debugging/backend/elk.md similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/elk.md rename to star-docs/engineering/02-checklists/debugging/backend/elk.md diff --git a/star-docs/onboarding/checklists/debugging/backend/error-modal.png b/star-docs/engineering/02-checklists/debugging/backend/error-modal.png similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/error-modal.png rename to star-docs/engineering/02-checklists/debugging/backend/error-modal.png diff --git a/star-docs/onboarding/checklists/debugging/backend/images/bug-in-jira.png b/star-docs/engineering/02-checklists/debugging/backend/images/bug-in-jira.png similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/images/bug-in-jira.png rename to star-docs/engineering/02-checklists/debugging/backend/images/bug-in-jira.png diff --git a/star-docs/onboarding/checklists/debugging/backend/images/dotnet-tools/dotnet-counters-output.png b/star-docs/engineering/02-checklists/debugging/backend/images/dotnet-tools/dotnet-counters-output.png similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/images/dotnet-tools/dotnet-counters-output.png rename to star-docs/engineering/02-checklists/debugging/backend/images/dotnet-tools/dotnet-counters-output.png diff --git a/star-docs/onboarding/checklists/debugging/backend/images/filebeat-is-running.png b/star-docs/engineering/02-checklists/debugging/backend/images/filebeat-is-running.png similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/images/filebeat-is-running.png rename to star-docs/engineering/02-checklists/debugging/backend/images/filebeat-is-running.png diff --git a/star-docs/onboarding/checklists/debugging/backend/images/folder-projects.png b/star-docs/engineering/02-checklists/debugging/backend/images/folder-projects.png similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/images/folder-projects.png rename to star-docs/engineering/02-checklists/debugging/backend/images/folder-projects.png diff --git a/star-docs/onboarding/checklists/debugging/backend/images/issue-code-details.png b/star-docs/engineering/02-checklists/debugging/backend/images/issue-code-details.png similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/images/issue-code-details.png rename to star-docs/engineering/02-checklists/debugging/backend/images/issue-code-details.png diff --git a/star-docs/onboarding/checklists/debugging/backend/images/kibana/columns.png b/star-docs/engineering/02-checklists/debugging/backend/images/kibana/columns.png similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/images/kibana/columns.png rename to star-docs/engineering/02-checklists/debugging/backend/images/kibana/columns.png diff --git a/star-docs/onboarding/checklists/debugging/backend/images/kibana/timeline.png b/star-docs/engineering/02-checklists/debugging/backend/images/kibana/timeline.png similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/images/kibana/timeline.png rename to star-docs/engineering/02-checklists/debugging/backend/images/kibana/timeline.png diff --git a/star-docs/onboarding/checklists/debugging/backend/images/kibana/timestamp.png b/star-docs/engineering/02-checklists/debugging/backend/images/kibana/timestamp.png similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/images/kibana/timestamp.png rename to star-docs/engineering/02-checklists/debugging/backend/images/kibana/timestamp.png diff --git a/star-docs/onboarding/checklists/debugging/backend/simple-backend-bugs.md b/star-docs/engineering/02-checklists/debugging/backend/simple-backend-bugs.md similarity index 100% rename from star-docs/onboarding/checklists/debugging/backend/simple-backend-bugs.md rename to star-docs/engineering/02-checklists/debugging/backend/simple-backend-bugs.md diff --git a/star-docs/onboarding/checklists/documents/_category_.json b/star-docs/engineering/02-checklists/documents/_category_.json similarity index 100% rename from star-docs/onboarding/checklists/documents/_category_.json rename to star-docs/engineering/02-checklists/documents/_category_.json diff --git a/star-docs/onboarding/checklists/documents/docs-contribution.md b/star-docs/engineering/02-checklists/documents/docs-contribution.md similarity index 100% rename from star-docs/onboarding/checklists/documents/docs-contribution.md rename to star-docs/engineering/02-checklists/documents/docs-contribution.md diff --git a/star-docs/onboarding/checklists/elasticsearch/_category_.json b/star-docs/engineering/02-checklists/elasticsearch/_category_.json similarity index 100% rename from star-docs/onboarding/checklists/elasticsearch/_category_.json rename to star-docs/engineering/02-checklists/elasticsearch/_category_.json diff --git a/star-docs/onboarding/checklists/elasticsearch/performance.md b/star-docs/engineering/02-checklists/elasticsearch/performance.md similarity index 97% rename from star-docs/onboarding/checklists/elasticsearch/performance.md rename to star-docs/engineering/02-checklists/elasticsearch/performance.md index 4239f8a..bfddb37 100644 --- a/star-docs/onboarding/checklists/elasticsearch/performance.md +++ b/star-docs/engineering/02-checklists/elasticsearch/performance.md @@ -1,177 +1,177 @@ -# چک لیست بررسی کندی های الستیک‌سرچ - -برای بررسی کندی‌های الستیک‌سرچ ممکن است اشکالاتی در تنظیمات کلاستر باشد یا روی یک داده و ایندکس خاص و یا کوئری مشخص دچار مشکل باشد. - -## بررسی سلامت کلاستر - -* با اجرای کوئری‌های متادیتا در کیبانا و بررسی زمان پاسخ‌گویی هر کدام می‌توان از سلامت کلی کلاستر اطمینان پیدا کرد. - - - * اطمینان از در دسترس بودن نود - برای بررسی در دسترس بودن یک نود درخواست زیر را اجرا کنید. - - ``` - GET / - ``` - خروجی این درخواست نام نودی که به آن درخواست ارسال شده و نسخه‌ی آن را نشان می‌دهد. - - - * بررسی سلامت نودها - - ``` - GET _cat/nodes?v - ``` - توضیحات خروجی این کوئری در - [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html) - آمده است. - زمان پاسخ‌گویی به این کوئری مهم است و در صورتی که طولانی شود نشان‌دهنده‌ی عدم پایداری در کلاستر است. - - * بررسی وضعیت نودها - - ``` - GET _nodes/stats - ``` - توضیحات خروجی این کوئری در - [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html) - آمده است. - زمان پاسخ‌گویی به این کوئری مهم است و در صورتی که طولانی شود نشان‌دهنده‌ی عدم پایداری در کلاستر است. - - * بررسی سلامت ایندکس‌ها - - ``` - GET _cat/indices?v - ``` - توضیحات خروجی این کوئری در - [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html) - آمده است. - - * بررسی سلامت کلی کلاستر - - ``` - GET _cat/health?v - ``` - توضیحات خروجی این کوئری در - [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html) - آمده است. - - * بررسی ساختار نگاشت‌های ایندکس‌ها - - برای دریافت نگاشت برای تمامی ایندکس‌ها از کوئری زیر استفاده می‌شود. - ``` - GET /_mapping - ``` - - برای بررسی نگاشت یک ایندکس خاص می‌توان کوئری زیر را اجرا کرد. - ``` - GET /my-index-000001/_mapping - ``` - - برای بررسی نگاشت چند ایندکس مشخص می‌توان از کاما استفاده کرد. - ``` - GET /my-index-000001,my-index-000002/_mapping - ``` - - توضیحات خروجی این کوئری در - [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-mapping.html) - آمده است. - - * بررسی وضعیت کلی کلاستر - - برای دید کلی نسبت به شرایط کلاستر این کوئری داده‌های مفیدی می‌دهد. - - ``` - GET /_cluster/stats - ``` - - توضیحات خروجی این کوئری در - [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html) - آمده است. - - * بررسی تنظیمات کلاستر - - برای دسترسی به تنظیمات کلی کلاستر از کوئری زیر استفاده می‌شود. - ``` - GET /_cluster/settings - ``` - - - توضیحات خروجی این کوئری در - [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-get-settings.html) - آمده است. - - - * بررسی وضعیت شارد‌ها - - برای دریافت وضعیت شاردها از کوئری زیر استفاده می‌شود. - - ``` - GET _cat/shards?v - ``` - - توضیحات خروجی این کوئری در - [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html) - آمده است. - - - * بررسی وضعیت اندازه‌ی اشاره‌گر‌ها در JVM - - در صورتی که مقدار حافظه‌ی - RAM - که به - JVM - داده می‌شود خیلی زیاد باشد(بیش از 32 گیگابایت) - باعث افزایش اندازه‌ی پوینتر شده و باعث کندی می‌شود. - - ``` - GET /_nodes/jvm?filter_path=nodes.*.jvm.using_compressed_ordinary_object_pointers - ``` - - در صورتی که پاسخ این کوئری - `false` - باشد به معنی عدم بهینه‌بودن اندازه‌ی پوینترها است و باید بررسی بشود و این میزان حافظه باید بهتر است بین چند نود تقسیم بشود به جای اینکه یک نود با - RAM - بسیار زیاد ایجاد شود. - - -## بررسی جزئیات کلاستر در کیبانا - -در رابط کاربری گرافیکی کیبانا امکان مشاهده‌ی وضعیت هر نود کلاستر را مشخص می‌کند. - -### مشاهده‌ی جزئیات هر نود - -برای مشاهده‌ی جزئیات یک نود در کیبانا مسیر زیر را طی می‌کنیم. -+ در ابتدا وارد -Stack Monitoring -در کیبانا می‌شویم. -+ در بخش -Elasticsearch -بخش -Nodes -را انتخاب می‌کنیم -+ پس از آن می‌توانیم -Node -مورد نظر را انتخاب می‌کنیم. -+ در این صفحه موارد مختلفی که نشان‌دهنده‌ی وضعیت سیستم است نشان‌داده شده است. -+ در صورت نیاز می‌توان به بخش -Advanced -برویم و جزئیات بیش‌تر و تفاوت‌های رفتار خاص در کلاستر بین نودها قابل مشاهده است. - - -:::tip -یکی از مواردی که حائذ اهمیت است میزان تاخیر در پاسخ به درخواست‌های -Indexing -و -Search -است. در صورتی که در یک نود خاص رفتار به صورت مشخصی با بقیه‌ی آن‌ها متفاوت باشد قابل تامل و بررسی است. -::: - -## جلسات بررسی تیم فنی -+ [جلسه‌ی اول بررسی روش‌های دیباگ کلاستر الستیک](https://splus.ir/star_learning_dev/286) - - -## لینک‌های مهم سایت الستیک‌سرچ برای بهینه‌سازی کلاستر -+ [Tune for search speed](https://www.elastic.co/guide/en/elasticsearch/reference/current/tune-for-search-speed.html) -+ [Tune for indexing speed](https://www.elastic.co/guide/en/elasticsearch/reference/current/tune-for-indexing-speed.html) -+ [Tune for disk usage](https://www.elastic.co/guide/en/elasticsearch/reference/current/tune-for-disk-usage.html) -+ [Size your shards](https://www.elastic.co/guide/en/elasticsearch/reference/current/size-your-shards.html) +# چک لیست بررسی کندی های الستیک‌سرچ + +برای بررسی کندی‌های الستیک‌سرچ ممکن است اشکالاتی در تنظیمات کلاستر باشد یا روی یک داده و ایندکس خاص و یا کوئری مشخص دچار مشکل باشد. + +## بررسی سلامت کلاستر + +* با اجرای کوئری‌های متادیتا در کیبانا و بررسی زمان پاسخ‌گویی هر کدام می‌توان از سلامت کلی کلاستر اطمینان پیدا کرد. + + + * اطمینان از در دسترس بودن نود + برای بررسی در دسترس بودن یک نود درخواست زیر را اجرا کنید. + + ``` + GET / + ``` + خروجی این درخواست نام نودی که به آن درخواست ارسال شده و نسخه‌ی آن را نشان می‌دهد. + + + * بررسی سلامت نودها + + ``` + GET _cat/nodes?v + ``` + توضیحات خروجی این کوئری در + [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html) + آمده است. + زمان پاسخ‌گویی به این کوئری مهم است و در صورتی که طولانی شود نشان‌دهنده‌ی عدم پایداری در کلاستر است. + + * بررسی وضعیت نودها + + ``` + GET _nodes/stats + ``` + توضیحات خروجی این کوئری در + [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html) + آمده است. + زمان پاسخ‌گویی به این کوئری مهم است و در صورتی که طولانی شود نشان‌دهنده‌ی عدم پایداری در کلاستر است. + + * بررسی سلامت ایندکس‌ها + + ``` + GET _cat/indices?v + ``` + توضیحات خروجی این کوئری در + [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html) + آمده است. + + * بررسی سلامت کلی کلاستر + + ``` + GET _cat/health?v + ``` + توضیحات خروجی این کوئری در + [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html) + آمده است. + + * بررسی ساختار نگاشت‌های ایندکس‌ها + + برای دریافت نگاشت برای تمامی ایندکس‌ها از کوئری زیر استفاده می‌شود. + ``` + GET /_mapping + ``` + + برای بررسی نگاشت یک ایندکس خاص می‌توان کوئری زیر را اجرا کرد. + ``` + GET /my-index-000001/_mapping + ``` + + برای بررسی نگاشت چند ایندکس مشخص می‌توان از کاما استفاده کرد. + ``` + GET /my-index-000001,my-index-000002/_mapping + ``` + + توضیحات خروجی این کوئری در + [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-mapping.html) + آمده است. + + * بررسی وضعیت کلی کلاستر + + برای دید کلی نسبت به شرایط کلاستر این کوئری داده‌های مفیدی می‌دهد. + + ``` + GET /_cluster/stats + ``` + + توضیحات خروجی این کوئری در + [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html) + آمده است. + + * بررسی تنظیمات کلاستر + + برای دسترسی به تنظیمات کلی کلاستر از کوئری زیر استفاده می‌شود. + ``` + GET /_cluster/settings + ``` + + + توضیحات خروجی این کوئری در + [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-get-settings.html) + آمده است. + + + * بررسی وضعیت شارد‌ها + + برای دریافت وضعیت شاردها از کوئری زیر استفاده می‌شود. + + ``` + GET _cat/shards?v + ``` + + توضیحات خروجی این کوئری در + [مستندات الستیک‌سرچ](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html) + آمده است. + + + * بررسی وضعیت اندازه‌ی اشاره‌گر‌ها در JVM + + در صورتی که مقدار حافظه‌ی + RAM + که به + JVM + داده می‌شود خیلی زیاد باشد(بیش از 32 گیگابایت) + باعث افزایش اندازه‌ی پوینتر شده و باعث کندی می‌شود. + + ``` + GET /_nodes/jvm?filter_path=nodes.*.jvm.using_compressed_ordinary_object_pointers + ``` + + در صورتی که پاسخ این کوئری + `false` + باشد به معنی عدم بهینه‌بودن اندازه‌ی پوینترها است و باید بررسی بشود و این میزان حافظه باید بهتر است بین چند نود تقسیم بشود به جای اینکه یک نود با + RAM + بسیار زیاد ایجاد شود. + + +## بررسی جزئیات کلاستر در کیبانا + +در رابط کاربری گرافیکی کیبانا امکان مشاهده‌ی وضعیت هر نود کلاستر را مشخص می‌کند. + +### مشاهده‌ی جزئیات هر نود + +برای مشاهده‌ی جزئیات یک نود در کیبانا مسیر زیر را طی می‌کنیم. ++ در ابتدا وارد +Stack Monitoring +در کیبانا می‌شویم. ++ در بخش +Elasticsearch +بخش +Nodes +را انتخاب می‌کنیم ++ پس از آن می‌توانیم +Node +مورد نظر را انتخاب می‌کنیم. ++ در این صفحه موارد مختلفی که نشان‌دهنده‌ی وضعیت سیستم است نشان‌داده شده است. ++ در صورت نیاز می‌توان به بخش +Advanced +برویم و جزئیات بیش‌تر و تفاوت‌های رفتار خاص در کلاستر بین نودها قابل مشاهده است. + + +:::tip +یکی از مواردی که حائذ اهمیت است میزان تاخیر در پاسخ به درخواست‌های +Indexing +و +Search +است. در صورتی که در یک نود خاص رفتار به صورت مشخصی با بقیه‌ی آن‌ها متفاوت باشد قابل تامل و بررسی است. +::: + +## جلسات بررسی تیم فنی ++ [جلسه‌ی اول بررسی روش‌های دیباگ کلاستر الستیک](https://splus.ir/star_learning_dev/286) + + +## لینک‌های مهم سایت الستیک‌سرچ برای بهینه‌سازی کلاستر ++ [Tune for search speed](https://www.elastic.co/guide/en/elasticsearch/reference/current/tune-for-search-speed.html) ++ [Tune for indexing speed](https://www.elastic.co/guide/en/elasticsearch/reference/current/tune-for-indexing-speed.html) ++ [Tune for disk usage](https://www.elastic.co/guide/en/elasticsearch/reference/current/tune-for-disk-usage.html) ++ [Size your shards](https://www.elastic.co/guide/en/elasticsearch/reference/current/size-your-shards.html) + [Advanced tuning: finding and fixing slow Elasticsearch queries](https://www.elastic.co/blog/advanced-tuning-finding-and-fixing-slow-elasticsearch-queries) \ No newline at end of file diff --git a/star-docs/onboarding/Star Standard Code Styles.md b/star-docs/engineering/03-Code Conventions/Star Standard Code Styles.md similarity index 100% rename from star-docs/onboarding/Star Standard Code Styles.md rename to star-docs/engineering/03-Code Conventions/Star Standard Code Styles.md diff --git a/star-docs/engineering/03-Code Conventions/_category_.json b/star-docs/engineering/03-Code Conventions/_category_.json new file mode 100644 index 0000000..3b9ed77 --- /dev/null +++ b/star-docs/engineering/03-Code Conventions/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "قراردادهای کد" +} \ No newline at end of file diff --git a/star-docs/team/02-roadmap/01-technical-roadmap-1403.md b/star-docs/engineering/04-Enabling Team/01-technical-roadmap-1403.md similarity index 100% rename from star-docs/team/02-roadmap/01-technical-roadmap-1403.md rename to star-docs/engineering/04-Enabling Team/01-technical-roadmap-1403.md diff --git a/star-docs/team/02-roadmap/_category_.json b/star-docs/engineering/04-Enabling Team/_category_.json similarity index 100% rename from star-docs/team/02-roadmap/_category_.json rename to star-docs/engineering/04-Enabling Team/_category_.json diff --git a/star-docs/i18n/fa/code.json b/star-docs/i18n/fa/code.json index 8174467..7e82079 100644 --- a/star-docs/i18n/fa/code.json +++ b/star-docs/i18n/fa/code.json @@ -5,12 +5,15 @@ "websiteTagline": { "message": "مستندات ستاره" }, - "onboarding": { - "message": "شروع به کار" + "people": { + "message": "منابع انسانی" }, "aboutTeam": { "message": "درباره‌ی واحد" }, + "engineering": { + "message": "مهندسی" + }, "documents": { "message": "مستندات" } diff --git a/star-docs/onboarding/checklists/_category_.json b/star-docs/onboarding/checklists/_category_.json deleted file mode 100644 index 09f70cc..0000000 --- a/star-docs/onboarding/checklists/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "چک لیست‌ها", - "position": 0, - "link": { - "type": "generated-index", - "slug": "checklists" - } -} diff --git a/star-docs/people/01-intro.md b/star-docs/people/01-intro.md new file mode 100644 index 0000000..60d2b1b --- /dev/null +++ b/star-docs/people/01-intro.md @@ -0,0 +1 @@ +# منابع انسانی \ No newline at end of file diff --git a/star-docs/onboarding/hr-protocols/monthly-tasks.md b/star-docs/people/02-Protocols/01-monthly-tasks.md similarity index 78% rename from star-docs/onboarding/hr-protocols/monthly-tasks.md rename to star-docs/people/02-Protocols/01-monthly-tasks.md index b4ed169..eaebd27 100644 --- a/star-docs/onboarding/hr-protocols/monthly-tasks.md +++ b/star-docs/people/02-Protocols/01-monthly-tasks.md @@ -1,4 +1,4 @@ -**کارهای ماهانه هر فرد که انتظار می‌رود هر ماه انجام دهد:** +# کارهای ماهانه هر فرد که انتظار می‌رود هر ماه انجام دهد: 1. بررسی سامانه tms (تا آخر هر ماه) diff --git a/star-docs/people/02-Protocols/_category_.json b/star-docs/people/02-Protocols/_category_.json new file mode 100644 index 0000000..4539cf2 --- /dev/null +++ b/star-docs/people/02-Protocols/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "پروتکل‌ها" +} \ No newline at end of file diff --git a/star-docs/people/03-onboarding/_category_.json b/star-docs/people/03-onboarding/_category_.json new file mode 100644 index 0000000..06dd4c7 --- /dev/null +++ b/star-docs/people/03-onboarding/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "شروع به کار" +} \ No newline at end of file diff --git a/star-docs/onboarding/images/10.png b/star-docs/people/03-onboarding/images/10.png similarity index 100% rename from star-docs/onboarding/images/10.png rename to star-docs/people/03-onboarding/images/10.png diff --git a/star-docs/onboarding/images/7.png b/star-docs/people/03-onboarding/images/7.png similarity index 100% rename from star-docs/onboarding/images/7.png rename to star-docs/people/03-onboarding/images/7.png diff --git a/star-docs/onboarding/images/8.png b/star-docs/people/03-onboarding/images/8.png similarity index 100% rename from star-docs/onboarding/images/8.png rename to star-docs/people/03-onboarding/images/8.png diff --git a/star-docs/onboarding/images/9.png b/star-docs/people/03-onboarding/images/9.png similarity index 100% rename from star-docs/onboarding/images/9.png rename to star-docs/people/03-onboarding/images/9.png diff --git a/star-docs/onboarding/images/Comments - Number 01.PNG b/star-docs/people/03-onboarding/images/Comments - Number 01.PNG similarity index 100% rename from star-docs/onboarding/images/Comments - Number 01.PNG rename to star-docs/people/03-onboarding/images/Comments - Number 01.PNG diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-08_204930_jira.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-08_204930_jira.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-08_204930_jira.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-08_204930_jira.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-08_205010_jira.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-08_205010_jira.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-08_205010_jira.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-08_205010_jira.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-08_205058_jira.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-08_205058_jira.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-08_205058_jira.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-08_205058_jira.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-08_213836_jira.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-08_213836_jira.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-08_213836_jira.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-08_213836_jira.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-13_133917_analytics.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-13_133917_analytics.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-13_133917_analytics.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-13_133917_analytics.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-13_133943_analytics.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-13_133943_analytics.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-13_133943_analytics.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-13_133943_analytics.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-13_134009_analytics.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-13_134009_analytics.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-13_134009_analytics.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-13_134009_analytics.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-13_134049_analytics.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-13_134049_analytics.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-13_134049_analytics.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-13_134049_analytics.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-15_151144_analytics.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-15_151144_analytics.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-15_151144_analytics.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-15_151144_analytics.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-15_180111_analytics.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-15_180111_analytics.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-15_180111_analytics.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-15_180111_analytics.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-16_191309_analytics.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-16_191309_analytics.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-16_191309_analytics.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-16_191309_analytics.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-16_191356_analytics.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-16_191356_analytics.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-16_191356_analytics.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-16_191356_analytics.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-21_141040_analytics.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-21_141040_analytics.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-21_141040_analytics.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-21_141040_analytics.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-21_141619_analytics.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-21_141619_analytics.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-21_141619_analytics.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-21_141619_analytics.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-21_145843_analytics.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-21_145843_analytics.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-21_145843_analytics.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-21_145843_analytics.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Opera Snapshot_2021-09-21_145853_analytics.mohaymen.ir.png b/star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-21_145853_analytics.mohaymen.ir.png similarity index 100% rename from star-docs/onboarding/images/Opera Snapshot_2021-09-21_145853_analytics.mohaymen.ir.png rename to star-docs/people/03-onboarding/images/Opera Snapshot_2021-09-21_145853_analytics.mohaymen.ir.png diff --git a/star-docs/onboarding/images/Pipelines - Number 01.PNG b/star-docs/people/03-onboarding/images/Pipelines - Number 01.PNG similarity index 100% rename from star-docs/onboarding/images/Pipelines - Number 01.PNG rename to star-docs/people/03-onboarding/images/Pipelines - Number 01.PNG diff --git a/star-docs/onboarding/images/Pipelines - Number 02.PNG b/star-docs/people/03-onboarding/images/Pipelines - Number 02.PNG similarity index 100% rename from star-docs/onboarding/images/Pipelines - Number 02.PNG rename to star-docs/people/03-onboarding/images/Pipelines - Number 02.PNG diff --git a/star-docs/onboarding/images/Resolve - Number 01.PNG b/star-docs/people/03-onboarding/images/Resolve - Number 01.PNG similarity index 100% rename from star-docs/onboarding/images/Resolve - Number 01.PNG rename to star-docs/people/03-onboarding/images/Resolve - Number 01.PNG diff --git a/star-docs/onboarding/images/Resolve - Number 02.PNG b/star-docs/people/03-onboarding/images/Resolve - Number 02.PNG similarity index 100% rename from star-docs/onboarding/images/Resolve - Number 02.PNG rename to star-docs/people/03-onboarding/images/Resolve - Number 02.PNG diff --git a/star-docs/onboarding/images/Screenshot (102).png b/star-docs/people/03-onboarding/images/Screenshot (102).png similarity index 100% rename from star-docs/onboarding/images/Screenshot (102).png rename to star-docs/people/03-onboarding/images/Screenshot (102).png diff --git a/star-docs/onboarding/images/Screenshot (96).png b/star-docs/people/03-onboarding/images/Screenshot (96).png similarity index 100% rename from star-docs/onboarding/images/Screenshot (96).png rename to star-docs/people/03-onboarding/images/Screenshot (96).png diff --git a/star-docs/onboarding/images/Screenshot (99).png b/star-docs/people/03-onboarding/images/Screenshot (99).png similarity index 100% rename from star-docs/onboarding/images/Screenshot (99).png rename to star-docs/people/03-onboarding/images/Screenshot (99).png diff --git a/star-docs/onboarding/images/Screenshot 2021-09-22 102237.png b/star-docs/people/03-onboarding/images/Screenshot 2021-09-22 102237.png similarity index 100% rename from star-docs/onboarding/images/Screenshot 2021-09-22 102237.png rename to star-docs/people/03-onboarding/images/Screenshot 2021-09-22 102237.png diff --git a/star-docs/onboarding/images/Screenshot 2021-09-22 103056.png b/star-docs/people/03-onboarding/images/Screenshot 2021-09-22 103056.png similarity index 100% rename from star-docs/onboarding/images/Screenshot 2021-09-22 103056.png rename to star-docs/people/03-onboarding/images/Screenshot 2021-09-22 103056.png diff --git a/star-docs/onboarding/images/Screenshot 2021-09-22 104449.png b/star-docs/people/03-onboarding/images/Screenshot 2021-09-22 104449.png similarity index 100% rename from star-docs/onboarding/images/Screenshot 2021-09-22 104449.png rename to star-docs/people/03-onboarding/images/Screenshot 2021-09-22 104449.png diff --git a/star-docs/onboarding/images/Screenshot 2021-09-22 105003.png b/star-docs/people/03-onboarding/images/Screenshot 2021-09-22 105003.png similarity index 100% rename from star-docs/onboarding/images/Screenshot 2021-09-22 105003.png rename to star-docs/people/03-onboarding/images/Screenshot 2021-09-22 105003.png diff --git a/star-docs/onboarding/images/Screenshot 2021-09-22 105112.png b/star-docs/people/03-onboarding/images/Screenshot 2021-09-22 105112.png similarity index 100% rename from star-docs/onboarding/images/Screenshot 2021-09-22 105112.png rename to star-docs/people/03-onboarding/images/Screenshot 2021-09-22 105112.png diff --git a/star-docs/onboarding/images/Screenshot 2021-10-02 150753.png b/star-docs/people/03-onboarding/images/Screenshot 2021-10-02 150753.png similarity index 100% rename from star-docs/onboarding/images/Screenshot 2021-10-02 150753.png rename to star-docs/people/03-onboarding/images/Screenshot 2021-10-02 150753.png diff --git a/star-docs/onboarding/images/Screenshot 2021-10-02 150823.png b/star-docs/people/03-onboarding/images/Screenshot 2021-10-02 150823.png similarity index 100% rename from star-docs/onboarding/images/Screenshot 2021-10-02 150823.png rename to star-docs/people/03-onboarding/images/Screenshot 2021-10-02 150823.png diff --git a/star-docs/onboarding/images/Screenshot 2021-10-02 150851.png b/star-docs/people/03-onboarding/images/Screenshot 2021-10-02 150851.png similarity index 100% rename from star-docs/onboarding/images/Screenshot 2021-10-02 150851.png rename to star-docs/people/03-onboarding/images/Screenshot 2021-10-02 150851.png diff --git a/star-docs/onboarding/images/Screenshot 2021-10-02 150956.png b/star-docs/people/03-onboarding/images/Screenshot 2021-10-02 150956.png similarity index 100% rename from star-docs/onboarding/images/Screenshot 2021-10-02 150956.png rename to star-docs/people/03-onboarding/images/Screenshot 2021-10-02 150956.png diff --git a/star-docs/onboarding/images/Untitled.png b/star-docs/people/03-onboarding/images/Untitled.png similarity index 100% rename from star-docs/onboarding/images/Untitled.png rename to star-docs/people/03-onboarding/images/Untitled.png diff --git a/star-docs/onboarding/images/image2021-9-13_12-44-20.png b/star-docs/people/03-onboarding/images/image2021-9-13_12-44-20.png similarity index 100% rename from star-docs/onboarding/images/image2021-9-13_12-44-20.png rename to star-docs/people/03-onboarding/images/image2021-9-13_12-44-20.png diff --git a/star-docs/onboarding/images/image2021-9-20_13-56-5.png b/star-docs/people/03-onboarding/images/image2021-9-20_13-56-5.png similarity index 100% rename from star-docs/onboarding/images/image2021-9-20_13-56-5.png rename to star-docs/people/03-onboarding/images/image2021-9-20_13-56-5.png diff --git a/star-docs/onboarding/images/image2022-8-20_16-53-15.png b/star-docs/people/03-onboarding/images/image2022-8-20_16-53-15.png similarity index 100% rename from star-docs/onboarding/images/image2022-8-20_16-53-15.png rename to star-docs/people/03-onboarding/images/image2022-8-20_16-53-15.png diff --git a/star-docs/onboarding/images/image2022-8-20_18-30-14.png b/star-docs/people/03-onboarding/images/image2022-8-20_18-30-14.png similarity index 100% rename from star-docs/onboarding/images/image2022-8-20_18-30-14.png rename to star-docs/people/03-onboarding/images/image2022-8-20_18-30-14.png diff --git a/star-docs/onboarding/images/image2022-8-20_18-31-3.png b/star-docs/people/03-onboarding/images/image2022-8-20_18-31-3.png similarity index 100% rename from star-docs/onboarding/images/image2022-8-20_18-31-3.png rename to star-docs/people/03-onboarding/images/image2022-8-20_18-31-3.png diff --git a/star-docs/onboarding/images/image2022-8-2_16-18-18.png b/star-docs/people/03-onboarding/images/image2022-8-2_16-18-18.png similarity index 100% rename from star-docs/onboarding/images/image2022-8-2_16-18-18.png rename to star-docs/people/03-onboarding/images/image2022-8-2_16-18-18.png diff --git a/star-docs/onboarding/images/image2022-8-2_16-25-44.png b/star-docs/people/03-onboarding/images/image2022-8-2_16-25-44.png similarity index 100% rename from star-docs/onboarding/images/image2022-8-2_16-25-44.png rename to star-docs/people/03-onboarding/images/image2022-8-2_16-25-44.png diff --git a/star-docs/onboarding/images/tempsnip.png b/star-docs/people/03-onboarding/images/tempsnip.png similarity index 100% rename from star-docs/onboarding/images/tempsnip.png rename to star-docs/people/03-onboarding/images/tempsnip.png diff --git a/star-docs/onboarding/images/tempsnip1.png b/star-docs/people/03-onboarding/images/tempsnip1.png similarity index 100% rename from star-docs/onboarding/images/tempsnip1.png rename to star-docs/people/03-onboarding/images/tempsnip1.png diff --git a/star-docs/onboarding/images/tempsnip2.png b/star-docs/people/03-onboarding/images/tempsnip2.png similarity index 100% rename from star-docs/onboarding/images/tempsnip2.png rename to star-docs/people/03-onboarding/images/tempsnip2.png diff --git a/star-docs/onboarding/intro.md b/star-docs/people/03-onboarding/intro.md similarity index 100% rename from star-docs/onboarding/intro.md rename to star-docs/people/03-onboarding/intro.md diff --git a/star-docs/sidebarsDocuments.ts b/star-docs/sidebarsDocuments.ts index 795a662..40aa757 100644 --- a/star-docs/sidebarsDocuments.ts +++ b/star-docs/sidebarsDocuments.ts @@ -12,7 +12,7 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; */ const sidebarsDocuments: SidebarsConfig = { // By default, Docusaurus generates a sidebar from the docs folder structure - onboardingSidebar: [{type: 'autogenerated', dirName: '.'}], + documentsSidebar: [{type: 'autogenerated', dirName: '.'}], }; export default sidebarsDocuments; diff --git a/star-docs/sidebarsEngineering.ts b/star-docs/sidebarsEngineering.ts new file mode 100644 index 0000000..fc9ce6a --- /dev/null +++ b/star-docs/sidebarsEngineering.ts @@ -0,0 +1,18 @@ +import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; + +/** + * Creating a sidebar enables you to: + - create an ordered group of docs + - render a sidebar for each doc of that group + - provide next/previous navigation + + The sidebars can be generated from the filesystem, or explicitly defined here. + + Create as many sidebars as you want. + */ +const sidebarsEngineering: SidebarsConfig = { + // By default, Docusaurus generates a sidebar from the docs folder structure + documentsSidebar: [{type: 'autogenerated', dirName: '.'}], +}; + +export default sidebarsEngineering; diff --git a/star-docs/sidebarsOnboarding.ts b/star-docs/sidebarsPeople.ts similarity index 75% rename from star-docs/sidebarsOnboarding.ts rename to star-docs/sidebarsPeople.ts index 6011d2e..c728b63 100644 --- a/star-docs/sidebarsOnboarding.ts +++ b/star-docs/sidebarsPeople.ts @@ -10,9 +10,9 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; Create as many sidebars as you want. */ -const sidebarsOnboarding: SidebarsConfig = { +const sidebarsPeople: SidebarsConfig = { // By default, Docusaurus generates a sidebar from the docs folder structure - onboardingSidebar: [{type: 'autogenerated', dirName: '.'}], + documentsSidebar: [{type: 'autogenerated', dirName: '.'}], }; -export default sidebarsOnboarding; +export default sidebarsPeople; diff --git a/star-docs/sidebarsTeam.ts b/star-docs/sidebarsTeam.ts index f626c59..c4af62b 100644 --- a/star-docs/sidebarsTeam.ts +++ b/star-docs/sidebarsTeam.ts @@ -12,7 +12,7 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; */ const sidebarsTeam: SidebarsConfig = { // By default, Docusaurus generates a sidebar from the docs folder structure - teamSidebar: [{type: 'autogenerated', dirName: '.'}], + documentsSidebar: [{type: 'autogenerated', dirName: '.'}], }; export default sidebarsTeam; diff --git a/star-docs/src/pages/index.tsx b/star-docs/src/pages/index.tsx index 2eb8f9a..ffb6eb0 100644 --- a/star-docs/src/pages/index.tsx +++ b/star-docs/src/pages/index.tsx @@ -43,9 +43,17 @@ export default function Home(): ReactElement {
- onboarding + people + +
+
+ + engineering