This commit is contained in:
2024-03-25 08:00:59 +05:30
parent 1bde04860d
commit ad6f9222ec
17 changed files with 177 additions and 56 deletions

View File

@@ -7,23 +7,23 @@
"editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/blog/effetive_bug_report.md", "editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/blog/effetive_bug_report.md",
"source": "@site/blog/effetive_bug_report.md", "source": "@site/blog/effetive_bug_report.md",
"title": "Write Effective Bug Report", "title": "Write Effective Bug Report",
"description": "", "description": "Writing an effective bug report is crucial for helping developers understand, reproduce, and ultimately fix the issue. Here's a step-by-step guide on how to write an effective bug report:",
"date": "2024-03-25T02:16:56.380Z", "date": "2024-03-25T02:20:39.000Z",
"formattedDate": "March 25, 2024", "formattedDate": "March 25, 2024",
"tags": [ "tags": [
{ {
"label": "docusaurus", "label": "bug",
"permalink": "/documentation/blog/tags/docusaurus" "permalink": "/documentation/blog/tags/bug"
} }
], ],
"readingTime": 0, "readingTime": 2.15,
"hasTruncateMarker": false, "hasTruncateMarker": false,
"authors": [ "authors": [
{ {
"name": "Eshan Roy", "name": "Eshan Roy",
"title": "Lead Developer & Maintainer", "title": "Lead Developer & Maintainer",
"url": "https://eshan.snigdhaos.org", "url": "https://eshan.snigdhaos.org",
"imageURL": "https://github.com/slorber.png", "imageURL": "https://github.com/eshanized/eshanized/blob/main/eshanized_square.png?raw=true",
"key": "eshanized" "key": "eshanized"
} }
], ],
@@ -34,7 +34,7 @@
"eshanized" "eshanized"
], ],
"tags": [ "tags": [
"docusaurus" "bug"
] ]
}, },
"unlisted": false, "unlisted": false,
@@ -43,7 +43,7 @@
"permalink": "/documentation/blog/welcome" "permalink": "/documentation/blog/welcome"
} }
}, },
"content": "" "content": "Writing an effective bug report is crucial for helping developers understand, reproduce, and ultimately fix the issue. Here's a step-by-step guide on how to write an effective bug report:\n\n1. **Title**: Provide a concise and descriptive title that summarizes the issue. It should give a clear indication of what the problem is without being too lengthy. For example, \"Error message appears when trying to log in.\"\n\n2. **Description**:\n - **Overview**: Begin with a brief overview of the problem, including what you were trying to do and what went wrong.\n - **Steps to Reproduce**: List the specific steps or actions taken that lead to the issue. Provide enough detail so that others can follow the same steps and encounter the same problem.\n - **Expected Behavior**: Describe what you expected to happen after performing the steps mentioned above.\n - **Actual Behavior**: Describe what actually happened or what you observed that indicates the presence of a bug. Include any error messages, unexpected behavior, or deviations from the expected outcome.\n - **Frequency**: Indicate whether the issue occurs consistently or intermittently. If intermittent, specify any patterns or conditions that seem to trigger the problem.\n - **Environment**: Mention the operating system, browser/version, device, or any other relevant environment details where the issue occurred.\n - **Screenshots/Attachments**: If applicable, include screenshots, logs, error messages, or any other relevant files that can help illustrate or reproduce the problem.\n\n3. **Impact**: Explain the impact of the bug on the user experience, system functionality, or any other relevant aspect. Include information about any workarounds or mitigations you've discovered.\n\n4. **Additional Information**:\n - **Related Issues**: If you suspect the bug may be related to other issues or if you've found similar reports, mention them and provide links if possible.\n - **Priority/Severity**: Optionally, suggest a priority or severity level for the bug based on its impact and urgency.\n - **Timeframe**: If applicable, specify any deadlines or time constraints that may affect the resolution of the issue.\n - **Contact Information**: Provide your contact information (email, username, etc.) in case developers need clarification or further details.\n\n5. **Submission**: Submit the bug report through the designated bug tracking system, issue tracker, or communication channel used by the development team. Follow any specific guidelines or templates provided by the project.\n\n6. **Follow-up**: Be prepared to respond to any follow-up questions or requests for clarification from developers. Provide additional information as needed to help troubleshoot and resolve the issue.\n\nBy following these steps and providing detailed, organized information, you can help developers diagnose and address the bug more effectively, ultimately leading to quicker resolution and improved software quality."
}, },
{ {
"id": "welcome", "id": "welcome",

View File

@@ -0,0 +1,9 @@
{
"permalink": "/documentation/blog/tags/bug",
"page": 1,
"postsPerPage": 10,
"totalPages": 1,
"totalCount": 1,
"blogDescription": "Blog",
"blogTitle": "Blog"
}

View File

@@ -0,0 +1,7 @@
{
"label": "bug",
"permalink": "/documentation/blog/tags/bug",
"allTagsPath": "/documentation/blog/tags",
"count": 1,
"unlisted": false
}

View File

@@ -3,7 +3,7 @@
"page": 1, "page": 1,
"postsPerPage": 10, "postsPerPage": 10,
"totalPages": 1, "totalPages": 1,
"totalCount": 5, "totalCount": 4,
"blogDescription": "Blog", "blogDescription": "Blog",
"blogTitle": "Blog" "blogTitle": "Blog"
} }

View File

@@ -2,6 +2,6 @@
"label": "docusaurus", "label": "docusaurus",
"permalink": "/documentation/blog/tags/docusaurus", "permalink": "/documentation/blog/tags/docusaurus",
"allTagsPath": "/documentation/blog/tags", "allTagsPath": "/documentation/blog/tags",
"count": 5, "count": 4,
"unlisted": false "unlisted": false
} }

View File

@@ -1,8 +1,8 @@
[ [
{ {
"label": "docusaurus", "label": "bug",
"permalink": "/documentation/blog/tags/docusaurus", "permalink": "/documentation/blog/tags/bug",
"count": 5 "count": 1
}, },
{ {
"label": "facebook", "label": "facebook",
@@ -14,6 +14,11 @@
"permalink": "/documentation/blog/tags/hello", "permalink": "/documentation/blog/tags/hello",
"count": 2 "count": 2
}, },
{
"label": "docusaurus",
"permalink": "/documentation/blog/tags/docusaurus",
"count": 4
},
{ {
"label": "hola", "label": "hola",
"permalink": "/documentation/blog/tags/hola", "permalink": "/documentation/blog/tags/hola",

View File

@@ -3,23 +3,23 @@
"editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/blog/effetive_bug_report.md", "editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/blog/effetive_bug_report.md",
"source": "@site/blog/effetive_bug_report.md", "source": "@site/blog/effetive_bug_report.md",
"title": "Write Effective Bug Report", "title": "Write Effective Bug Report",
"description": "", "description": "Writing an effective bug report is crucial for helping developers understand, reproduce, and ultimately fix the issue. Here's a step-by-step guide on how to write an effective bug report:",
"date": "2024-03-25T02:16:56.380Z", "date": "2024-03-25T02:20:39.000Z",
"formattedDate": "March 25, 2024", "formattedDate": "March 25, 2024",
"tags": [ "tags": [
{ {
"label": "docusaurus", "label": "bug",
"permalink": "/documentation/blog/tags/docusaurus" "permalink": "/documentation/blog/tags/bug"
} }
], ],
"readingTime": 0, "readingTime": 2.15,
"hasTruncateMarker": false, "hasTruncateMarker": false,
"authors": [ "authors": [
{ {
"name": "Eshan Roy", "name": "Eshan Roy",
"title": "Lead Developer & Maintainer", "title": "Lead Developer & Maintainer",
"url": "https://eshan.snigdhaos.org", "url": "https://eshan.snigdhaos.org",
"imageURL": "https://github.com/slorber.png", "imageURL": "https://github.com/eshanized/eshanized/blob/main/eshanized_square.png?raw=true",
"key": "eshanized" "key": "eshanized"
} }
], ],
@@ -30,7 +30,7 @@
"eshanized" "eshanized"
], ],
"tags": [ "tags": [
"docusaurus" "bug"
] ]
}, },
"unlisted": false, "unlisted": false,

View File

@@ -1,7 +1,7 @@
{ {
"id": "introduction/faqs", "id": "introduction/faqs",
"title": "Frequently Asked", "title": "Frequently Asked",
"description": "", "description": "Here are some frequently asked questions (FAQs) about Snigdha OS (penetration distribution):",
"source": "@site/docs/introduction/faqs.md", "source": "@site/docs/introduction/faqs.md",
"sourceDirName": "introduction", "sourceDirName": "introduction",
"slug": "/introduction/faqs", "slug": "/introduction/faqs",

View File

@@ -443,7 +443,7 @@
"introduction/faqs": { "introduction/faqs": {
"id": "introduction/faqs", "id": "introduction/faqs",
"title": "Frequently Asked", "title": "Frequently Asked",
"description": "", "description": "Here are some frequently asked questions (FAQs) about Snigdha OS (penetration distribution):",
"sidebar": "tutorialSidebar" "sidebar": "tutorialSidebar"
}, },
"introduction/inspiration": { "introduction/inspiration": {

View File

@@ -481,7 +481,7 @@
{ {
"id": "introduction/faqs", "id": "introduction/faqs",
"title": "Frequently Asked", "title": "Frequently Asked",
"description": "", "description": "Here are some frequently asked questions (FAQs) about Snigdha OS (penetration distribution):",
"source": "@site/docs/introduction/faqs.md", "source": "@site/docs/introduction/faqs.md",
"sourceDirName": "introduction", "sourceDirName": "introduction",
"slug": "/introduction/faqs", "slug": "/introduction/faqs",
@@ -1248,23 +1248,23 @@
"editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/blog/effetive_bug_report.md", "editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/blog/effetive_bug_report.md",
"source": "@site/blog/effetive_bug_report.md", "source": "@site/blog/effetive_bug_report.md",
"title": "Write Effective Bug Report", "title": "Write Effective Bug Report",
"description": "", "description": "Writing an effective bug report is crucial for helping developers understand, reproduce, and ultimately fix the issue. Here's a step-by-step guide on how to write an effective bug report:",
"date": "2024-03-25T02:16:56.380Z", "date": "2024-03-25T02:20:39.000Z",
"formattedDate": "March 25, 2024", "formattedDate": "March 25, 2024",
"tags": [ "tags": [
{ {
"label": "docusaurus", "label": "bug",
"permalink": "/documentation/blog/tags/docusaurus" "permalink": "/documentation/blog/tags/bug"
} }
], ],
"readingTime": 0, "readingTime": 2.15,
"hasTruncateMarker": false, "hasTruncateMarker": false,
"authors": [ "authors": [
{ {
"name": "Eshan Roy", "name": "Eshan Roy",
"title": "Lead Developer & Maintainer", "title": "Lead Developer & Maintainer",
"url": "https://eshan.snigdhaos.org", "url": "https://eshan.snigdhaos.org",
"imageURL": "https://github.com/slorber.png", "imageURL": "https://github.com/eshanized/eshanized/blob/main/eshanized_square.png?raw=true",
"key": "eshanized" "key": "eshanized"
} }
], ],
@@ -1275,7 +1275,7 @@
"eshanized" "eshanized"
], ],
"tags": [ "tags": [
"docusaurus" "bug"
] ]
}, },
"unlisted": false, "unlisted": false,
@@ -1284,7 +1284,7 @@
"permalink": "/documentation/blog/welcome" "permalink": "/documentation/blog/welcome"
} }
}, },
"content": "" "content": "Writing an effective bug report is crucial for helping developers understand, reproduce, and ultimately fix the issue. Here's a step-by-step guide on how to write an effective bug report:\n\n1. **Title**: Provide a concise and descriptive title that summarizes the issue. It should give a clear indication of what the problem is without being too lengthy. For example, \"Error message appears when trying to log in.\"\n\n2. **Description**:\n - **Overview**: Begin with a brief overview of the problem, including what you were trying to do and what went wrong.\n - **Steps to Reproduce**: List the specific steps or actions taken that lead to the issue. Provide enough detail so that others can follow the same steps and encounter the same problem.\n - **Expected Behavior**: Describe what you expected to happen after performing the steps mentioned above.\n - **Actual Behavior**: Describe what actually happened or what you observed that indicates the presence of a bug. Include any error messages, unexpected behavior, or deviations from the expected outcome.\n - **Frequency**: Indicate whether the issue occurs consistently or intermittently. If intermittent, specify any patterns or conditions that seem to trigger the problem.\n - **Environment**: Mention the operating system, browser/version, device, or any other relevant environment details where the issue occurred.\n - **Screenshots/Attachments**: If applicable, include screenshots, logs, error messages, or any other relevant files that can help illustrate or reproduce the problem.\n\n3. **Impact**: Explain the impact of the bug on the user experience, system functionality, or any other relevant aspect. Include information about any workarounds or mitigations you've discovered.\n\n4. **Additional Information**:\n - **Related Issues**: If you suspect the bug may be related to other issues or if you've found similar reports, mention them and provide links if possible.\n - **Priority/Severity**: Optionally, suggest a priority or severity level for the bug based on its impact and urgency.\n - **Timeframe**: If applicable, specify any deadlines or time constraints that may affect the resolution of the issue.\n - **Contact Information**: Provide your contact information (email, username, etc.) in case developers need clarification or further details.\n\n5. **Submission**: Submit the bug report through the designated bug tracking system, issue tracker, or communication channel used by the development team. Follow any specific guidelines or templates provided by the project.\n\n6. **Follow-up**: Be prepared to respond to any follow-up questions or requests for clarification from developers. Provide additional information as needed to help troubleshoot and resolve the issue.\n\nBy following these steps and providing detailed, organized information, you can help developers diagnose and address the bug more effectively, ultimately leading to quicker resolution and improved software quality."
}, },
{ {
"id": "welcome", "id": "welcome",
@@ -1530,31 +1530,23 @@
} }
], ],
"blogTags": { "blogTags": {
"/documentation/blog/tags/docusaurus": { "/documentation/blog/tags/bug": {
"label": "docusaurus", "label": "bug",
"items": [ "items": [
"/effective_bug_report", "/effective_bug_report"
"welcome",
"mdx-blog-post",
"long-blog-post",
"first-blog-post"
], ],
"permalink": "/documentation/blog/tags/docusaurus", "permalink": "/documentation/blog/tags/bug",
"pages": [ "pages": [
{ {
"items": [ "items": [
"/effective_bug_report", "/effective_bug_report"
"welcome",
"mdx-blog-post",
"long-blog-post",
"first-blog-post"
], ],
"metadata": { "metadata": {
"permalink": "/documentation/blog/tags/docusaurus", "permalink": "/documentation/blog/tags/bug",
"page": 1, "page": 1,
"postsPerPage": 10, "postsPerPage": 10,
"totalPages": 1, "totalPages": 1,
"totalCount": 5, "totalCount": 1,
"blogDescription": "Blog", "blogDescription": "Blog",
"blogTitle": "Blog" "blogTitle": "Blog"
} }
@@ -1612,6 +1604,36 @@
], ],
"unlisted": false "unlisted": false
}, },
"/documentation/blog/tags/docusaurus": {
"label": "docusaurus",
"items": [
"welcome",
"mdx-blog-post",
"long-blog-post",
"first-blog-post"
],
"permalink": "/documentation/blog/tags/docusaurus",
"pages": [
{
"items": [
"welcome",
"mdx-blog-post",
"long-blog-post",
"first-blog-post"
],
"metadata": {
"permalink": "/documentation/blog/tags/docusaurus",
"page": 1,
"postsPerPage": 10,
"totalPages": 1,
"totalCount": 4,
"blogDescription": "Blog",
"blogTitle": "Blog"
}
}
],
"unlisted": false
},
"/documentation/blog/tags/hola": { "/documentation/blog/tags/hola": {
"label": "hola", "label": "hola",
"items": [ "items": [

View File

@@ -73,6 +73,7 @@ export default {
"content---documentation-troubleshoot-wifi-367-035": [() => import(/* webpackChunkName: "content---documentation-troubleshoot-wifi-367-035" */ "@site/docs/troubleshoot/wifi.md"), "@site/docs/troubleshoot/wifi.md", require.resolveWeak("@site/docs/troubleshoot/wifi.md")], "content---documentation-troubleshoot-wifi-367-035": [() => import(/* webpackChunkName: "content---documentation-troubleshoot-wifi-367-035" */ "@site/docs/troubleshoot/wifi.md"), "@site/docs/troubleshoot/wifi.md", require.resolveWeak("@site/docs/troubleshoot/wifi.md")],
"content---documentation-user-guide-aurd-68-18b": [() => import(/* webpackChunkName: "content---documentation-user-guide-aurd-68-18b" */ "@site/docs/user_guide/aur.md"), "@site/docs/user_guide/aur.md", require.resolveWeak("@site/docs/user_guide/aur.md")], "content---documentation-user-guide-aurd-68-18b": [() => import(/* webpackChunkName: "content---documentation-user-guide-aurd-68-18b" */ "@site/docs/user_guide/aur.md"), "@site/docs/user_guide/aur.md", require.resolveWeak("@site/docs/user_guide/aur.md")],
"content---documentation-user-guide-cheetsheetf-7-a-048": [() => import(/* webpackChunkName: "content---documentation-user-guide-cheetsheetf-7-a-048" */ "@site/docs/user_guide/cheetsheet.md"), "@site/docs/user_guide/cheetsheet.md", require.resolveWeak("@site/docs/user_guide/cheetsheet.md")], "content---documentation-user-guide-cheetsheetf-7-a-048": [() => import(/* webpackChunkName: "content---documentation-user-guide-cheetsheetf-7-a-048" */ "@site/docs/user_guide/cheetsheet.md"), "@site/docs/user_guide/cheetsheet.md", require.resolveWeak("@site/docs/user_guide/cheetsheet.md")],
"listMetadata---documentation-blog-tags-bug-1-c-0-91c": [() => import(/* webpackChunkName: "listMetadata---documentation-blog-tags-bug-1-c-0-91c" */ "~blog/default/documentation-blog-tags-bug-b05-list.json"), "~blog/default/documentation-blog-tags-bug-b05-list.json", require.resolveWeak("~blog/default/documentation-blog-tags-bug-b05-list.json")],
"listMetadata---documentation-blog-tags-docusaurusb-53-274": [() => import(/* webpackChunkName: "listMetadata---documentation-blog-tags-docusaurusb-53-274" */ "~blog/default/documentation-blog-tags-docusaurus-a11-list.json"), "~blog/default/documentation-blog-tags-docusaurus-a11-list.json", require.resolveWeak("~blog/default/documentation-blog-tags-docusaurus-a11-list.json")], "listMetadata---documentation-blog-tags-docusaurusb-53-274": [() => import(/* webpackChunkName: "listMetadata---documentation-blog-tags-docusaurusb-53-274" */ "~blog/default/documentation-blog-tags-docusaurus-a11-list.json"), "~blog/default/documentation-blog-tags-docusaurus-a11-list.json", require.resolveWeak("~blog/default/documentation-blog-tags-docusaurus-a11-list.json")],
"listMetadata---documentation-blog-tags-facebook-84-f-518": [() => import(/* webpackChunkName: "listMetadata---documentation-blog-tags-facebook-84-f-518" */ "~blog/default/documentation-blog-tags-facebook-5c9-list.json"), "~blog/default/documentation-blog-tags-facebook-5c9-list.json", require.resolveWeak("~blog/default/documentation-blog-tags-facebook-5c9-list.json")], "listMetadata---documentation-blog-tags-facebook-84-f-518": [() => import(/* webpackChunkName: "listMetadata---documentation-blog-tags-facebook-84-f-518" */ "~blog/default/documentation-blog-tags-facebook-5c9-list.json"), "~blog/default/documentation-blog-tags-facebook-5c9-list.json", require.resolveWeak("~blog/default/documentation-blog-tags-facebook-5c9-list.json")],
"listMetadata---documentation-blog-tags-hello-3-c-8-390": [() => import(/* webpackChunkName: "listMetadata---documentation-blog-tags-hello-3-c-8-390" */ "~blog/default/documentation-blog-tags-hello-5be-list.json"), "~blog/default/documentation-blog-tags-hello-5be-list.json", require.resolveWeak("~blog/default/documentation-blog-tags-hello-5be-list.json")], "listMetadata---documentation-blog-tags-hello-3-c-8-390": [() => import(/* webpackChunkName: "listMetadata---documentation-blog-tags-hello-3-c-8-390" */ "~blog/default/documentation-blog-tags-hello-5be-list.json"), "~blog/default/documentation-blog-tags-hello-5be-list.json", require.resolveWeak("~blog/default/documentation-blog-tags-hello-5be-list.json")],
@@ -83,6 +84,7 @@ export default {
"plugin---documentation-docusaurus-debuge-3-a-69b": [() => import(/* webpackChunkName: "plugin---documentation-docusaurus-debuge-3-a-69b" */ "/home/whoami/Documents/GitHub/documentation/.docusaurus/docusaurus-plugin-debug/default/plugin-route-context-module-100.json"), "/home/whoami/Documents/GitHub/documentation/.docusaurus/docusaurus-plugin-debug/default/plugin-route-context-module-100.json", require.resolveWeak("/home/whoami/Documents/GitHub/documentation/.docusaurus/docusaurus-plugin-debug/default/plugin-route-context-module-100.json")], "plugin---documentation-docusaurus-debuge-3-a-69b": [() => import(/* webpackChunkName: "plugin---documentation-docusaurus-debuge-3-a-69b" */ "/home/whoami/Documents/GitHub/documentation/.docusaurus/docusaurus-plugin-debug/default/plugin-route-context-module-100.json"), "/home/whoami/Documents/GitHub/documentation/.docusaurus/docusaurus-plugin-debug/default/plugin-route-context-module-100.json", require.resolveWeak("/home/whoami/Documents/GitHub/documentation/.docusaurus/docusaurus-plugin-debug/default/plugin-route-context-module-100.json")],
"plugin---documentation-markdown-pagec-52-df3": [() => import(/* webpackChunkName: "plugin---documentation-markdown-pagec-52-df3" */ "/home/whoami/Documents/GitHub/documentation/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json"), "/home/whoami/Documents/GitHub/documentation/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json", require.resolveWeak("/home/whoami/Documents/GitHub/documentation/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json")], "plugin---documentation-markdown-pagec-52-df3": [() => import(/* webpackChunkName: "plugin---documentation-markdown-pagec-52-df3" */ "/home/whoami/Documents/GitHub/documentation/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json"), "/home/whoami/Documents/GitHub/documentation/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json", require.resolveWeak("/home/whoami/Documents/GitHub/documentation/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json")],
"sidebar---documentation-blog-814-bc6": [() => import(/* webpackChunkName: "sidebar---documentation-blog-814-bc6" */ "~blog/default/blog-post-list-prop-default.json"), "~blog/default/blog-post-list-prop-default.json", require.resolveWeak("~blog/default/blog-post-list-prop-default.json")], "sidebar---documentation-blog-814-bc6": [() => import(/* webpackChunkName: "sidebar---documentation-blog-814-bc6" */ "~blog/default/blog-post-list-prop-default.json"), "~blog/default/blog-post-list-prop-default.json", require.resolveWeak("~blog/default/blog-post-list-prop-default.json")],
"tag---documentation-blog-tags-bug-790-80d": [() => import(/* webpackChunkName: "tag---documentation-blog-tags-bug-790-80d" */ "~blog/default/documentation-blog-tags-bug-b05.json"), "~blog/default/documentation-blog-tags-bug-b05.json", require.resolveWeak("~blog/default/documentation-blog-tags-bug-b05.json")],
"tag---documentation-blog-tags-docusaurus-911-3a9": [() => import(/* webpackChunkName: "tag---documentation-blog-tags-docusaurus-911-3a9" */ "~blog/default/documentation-blog-tags-docusaurus-a11.json"), "~blog/default/documentation-blog-tags-docusaurus-a11.json", require.resolveWeak("~blog/default/documentation-blog-tags-docusaurus-a11.json")], "tag---documentation-blog-tags-docusaurus-911-3a9": [() => import(/* webpackChunkName: "tag---documentation-blog-tags-docusaurus-911-3a9" */ "~blog/default/documentation-blog-tags-docusaurus-a11.json"), "~blog/default/documentation-blog-tags-docusaurus-a11.json", require.resolveWeak("~blog/default/documentation-blog-tags-docusaurus-a11.json")],
"tag---documentation-blog-tags-facebookde-8-e67": [() => import(/* webpackChunkName: "tag---documentation-blog-tags-facebookde-8-e67" */ "~blog/default/documentation-blog-tags-facebook-5c9.json"), "~blog/default/documentation-blog-tags-facebook-5c9.json", require.resolveWeak("~blog/default/documentation-blog-tags-facebook-5c9.json")], "tag---documentation-blog-tags-facebookde-8-e67": [() => import(/* webpackChunkName: "tag---documentation-blog-tags-facebookde-8-e67" */ "~blog/default/documentation-blog-tags-facebook-5c9.json"), "~blog/default/documentation-blog-tags-facebook-5c9.json", require.resolveWeak("~blog/default/documentation-blog-tags-facebook-5c9.json")],
"tag---documentation-blog-tags-hello-6-a-7-056": [() => import(/* webpackChunkName: "tag---documentation-blog-tags-hello-6-a-7-056" */ "~blog/default/documentation-blog-tags-hello-5be.json"), "~blog/default/documentation-blog-tags-hello-5be.json", require.resolveWeak("~blog/default/documentation-blog-tags-hello-5be.json")], "tag---documentation-blog-tags-hello-6-a-7-056": [() => import(/* webpackChunkName: "tag---documentation-blog-tags-hello-6-a-7-056" */ "~blog/default/documentation-blog-tags-hello-5be.json"), "~blog/default/documentation-blog-tags-hello-5be.json", require.resolveWeak("~blog/default/documentation-blog-tags-hello-5be.json")],

View File

@@ -72,9 +72,14 @@ export default [
component: ComponentCreator('/documentation/blog/tags', 'e85'), component: ComponentCreator('/documentation/blog/tags', 'e85'),
exact: true exact: true
}, },
{
path: '/documentation/blog/tags/bug',
component: ComponentCreator('/documentation/blog/tags/bug', 'cf7'),
exact: true
},
{ {
path: '/documentation/blog/tags/docusaurus', path: '/documentation/blog/tags/docusaurus',
component: ComponentCreator('/documentation/blog/tags/docusaurus', '0fa'), component: ComponentCreator('/documentation/blog/tags/docusaurus', 'ad1'),
exact: true exact: true
}, },
{ {

View File

@@ -114,7 +114,7 @@
"sidebar": "sidebar---documentation-blog-814-bc6", "sidebar": "sidebar---documentation-blog-814-bc6",
"tags": "tags---documentation-blog-tags-673-362" "tags": "tags---documentation-blog-tags-673-362"
}, },
"/documentation/blog/tags/docusaurus-0fa": { "/documentation/blog/tags/bug-cf7": {
"__comp": "__comp---theme-blog-tags-posts-page-687-b6c", "__comp": "__comp---theme-blog-tags-posts-page-687-b6c",
"__context": { "__context": {
"plugin": "plugin---documentation-blog-490-fb4" "plugin": "plugin---documentation-blog-490-fb4"
@@ -123,7 +123,18 @@
"items": [ "items": [
{ {
"content": "content---documentation-blogec-4-500" "content": "content---documentation-blogec-4-500"
}, }
],
"tag": "tag---documentation-blog-tags-bug-790-80d",
"listMetadata": "listMetadata---documentation-blog-tags-bug-1-c-0-91c"
},
"/documentation/blog/tags/docusaurus-ad1": {
"__comp": "__comp---theme-blog-tags-posts-page-687-b6c",
"__context": {
"plugin": "plugin---documentation-blog-490-fb4"
},
"sidebar": "sidebar---documentation-blog-814-bc6",
"items": [
{ {
"content": "content---documentation-blog-766-b7c" "content": "content---documentation-blog-766-b7c"
}, },

View File

@@ -20,4 +20,4 @@ eshanized:
name: Eshan Roy name: Eshan Roy
title: Lead Developer & Maintainer title: Lead Developer & Maintainer
url: https://eshan.snigdhaos.org url: https://eshan.snigdhaos.org
image_url: https://github.com/slorber.png image_url: https://github.com/eshanized/eshanized/blob/main/eshanized_square.png?raw=true

View File

@@ -2,5 +2,34 @@
slug: /effective_bug_report slug: /effective_bug_report
title: Write Effective Bug Report title: Write Effective Bug Report
authors: [eshanized] authors: [eshanized]
tags: [docusaurus] tags: [bug]
--- ---
# Write Effective Bug Report
Writing an effective bug report is crucial for helping developers understand, reproduce, and ultimately fix the issue. Here's a step-by-step guide on how to write an effective bug report:
1. **Title**: Provide a concise and descriptive title that summarizes the issue. It should give a clear indication of what the problem is without being too lengthy. For example, "Error message appears when trying to log in."
2. **Description**:
- **Overview**: Begin with a brief overview of the problem, including what you were trying to do and what went wrong.
- **Steps to Reproduce**: List the specific steps or actions taken that lead to the issue. Provide enough detail so that others can follow the same steps and encounter the same problem.
- **Expected Behavior**: Describe what you expected to happen after performing the steps mentioned above.
- **Actual Behavior**: Describe what actually happened or what you observed that indicates the presence of a bug. Include any error messages, unexpected behavior, or deviations from the expected outcome.
- **Frequency**: Indicate whether the issue occurs consistently or intermittently. If intermittent, specify any patterns or conditions that seem to trigger the problem.
- **Environment**: Mention the operating system, browser/version, device, or any other relevant environment details where the issue occurred.
- **Screenshots/Attachments**: If applicable, include screenshots, logs, error messages, or any other relevant files that can help illustrate or reproduce the problem.
3. **Impact**: Explain the impact of the bug on the user experience, system functionality, or any other relevant aspect. Include information about any workarounds or mitigations you've discovered.
4. **Additional Information**:
- **Related Issues**: If you suspect the bug may be related to other issues or if you've found similar reports, mention them and provide links if possible.
- **Priority/Severity**: Optionally, suggest a priority or severity level for the bug based on its impact and urgency.
- **Timeframe**: If applicable, specify any deadlines or time constraints that may affect the resolution of the issue.
- **Contact Information**: Provide your contact information (email, username, etc.) in case developers need clarification or further details.
5. **Submission**: Submit the bug report through the designated bug tracking system, issue tracker, or communication channel used by the development team. Follow any specific guidelines or templates provided by the project.
6. **Follow-up**: Be prepared to respond to any follow-up questions or requests for clarification from developers. Provide additional information as needed to help troubleshoot and resolve the issue.
By following these steps and providing detailed, organized information, you can help developers diagnose and address the bug more effectively, ultimately leading to quicker resolution and improved software quality.

View File

@@ -2,3 +2,34 @@
sidebar_position: 6 sidebar_position: 6
--- ---
# Frequently Asked # Frequently Asked
Here are some frequently asked questions (FAQs) about Snigdha OS (penetration distribution):
1. **What is penetration distribution?**
- Penetration distribution refers to the process of distributing penetration testing tools and techniques across different areas of a network or system to identify vulnerabilities and potential entry points for attackers.
2. **Why is penetration distribution important?**
- Penetration distribution is important because it helps security professionals identify and address vulnerabilities before attackers can exploit them. By thoroughly testing various aspects of a network or system, organizations can better protect their assets and data from cyber threats.
3. **What are some common penetration distribution techniques?**
- Common penetration distribution techniques include network scanning, vulnerability assessment, exploitation of known vulnerabilities, social engineering, phishing attacks, and physical security testing. These techniques aim to identify weaknesses in different layers of a network or system.
4. **How does penetration distribution differ from traditional security testing?**
- Penetration distribution goes beyond traditional security testing by employing a broader range of techniques and tools to assess the security posture of an organization's infrastructure. It involves simulating real-world attack scenarios to uncover vulnerabilities that may not be detected by standard security measures.
5. **What are the benefits of using penetration distribution services?**
- The benefits of penetration distribution services include improved security posture, reduced risk of data breaches, compliance with regulatory requirements, enhanced incident response capabilities, and increased confidence in the effectiveness of security controls.
6. **How often should penetration distribution be conducted?**
- Penetration distribution should be conducted regularly, ideally as part of a comprehensive security testing program. The frequency of testing may vary depending on factors such as the organization's risk profile, industry regulations, and changes to the IT environment.
7. **What are some best practices for conducting penetration distribution?**
- Best practices for conducting penetration distribution include defining clear objectives and scope, obtaining appropriate permissions and approvals, using the latest tools and techniques, documenting findings thoroughly, prioritizing remediation efforts based on risk, and conducting post-test debriefings to identify lessons learned.
8. **How can organizations ensure the confidentiality and integrity of penetration distribution results?**
- Organizations can ensure the confidentiality and integrity of penetration distribution results by restricting access to sensitive information, encrypting data in transit and at rest, using secure communication channels, and implementing proper access controls and authentication mechanisms.
9. **What are the limitations of penetration distribution?**
- Limitations of penetration distribution include the inability to guarantee the absence of all vulnerabilities, the potential for disruption to normal business operations, the reliance on assumptions and estimations, and the need for ongoing monitoring and maintenance to address emerging threats.
10. **How can organizations measure the effectiveness of penetration distribution efforts?**
- Organizations can measure the effectiveness of penetration distribution efforts by tracking key performance indicators (KPIs) such as the number of vulnerabilities identified and remediated, the time to detect and respond to incidents, the cost-effectiveness of security controls, and improvements in overall security posture over time.

View File

@@ -4,7 +4,7 @@ sidebar_position: 5
# Reporting Bugs # Reporting Bugs
:::danger Security Vulnerabilities :::danger Vulnerabilities
If you discover a security vulnerability within Snigdha OS as well as any packages and tools, please follow our [security policy](https://github.com/Snigdha-OS/snigdhaos-arctic/security/policy) so we can address it promptly. If you discover a security vulnerability within Snigdha OS as well as any packages and tools, please follow our [security policy](https://github.com/Snigdha-OS/snigdhaos-arctic/security/policy) so we can address it promptly.
@@ -27,6 +27,6 @@ We track issues on GitHub. Make sure you open your issue in the [correct reposit
If you can, check if the issue is reproducible with the latest version of Snigdha OS. If you are using a pre-release or development version, please indicate the specific version you are using. If you can, check if the issue is reproducible with the latest version of Snigdha OS. If you are using a pre-release or development version, please indicate the specific version you are using.
Remember: the goal of a bug report is to make it easy for us to replicate the bug and fix it. You might want to read [this article](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html) for some useful tips on how to write an effective bug report. It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Issues with no clear reproduction steps will not be triaged. If an issue labeled "needs verification" receives no further input from the issue author for more than 5 days, it will be closed. Remember: the goal of a bug report is to make it easy for us to replicate the bug and fix it. You might want to read [this article](/blog/effective_bug_report) for some useful tips on how to write an effective bug report. It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Issues with no clear reproduction steps will not be triaged. If an issue labeled "needs verification" receives no further input from the issue author for more than 5 days, it will be closed.
Once you've posted your report, we'd ask that you please *follow the discussion* and wait patiently. We may need to ask for further details or clarification; but we've always got plenty to do, and it could be a while before we can give your report the time it deserves. > Once you've posted your report, we'd ask that you please *follow the discussion* and wait patiently. We may need to ask for further details or clarification; but we've always got plenty to do, and it could be a while before we can give your report the time it deserves.