From 71e52cb237d516e294d2654880bb225815ce1036 Mon Sep 17 00:00:00 2001 From: SYED Date: Mon, 18 Nov 2024 14:31:40 +0000 Subject: [PATCH 1/3] testing layout of readme --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index fa135ab3dbd..479e7afbfa6 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,13 @@ This site is powered by [Jekyll](https://jekyllrb.com/). Check out our [contribu Content is released under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). See [notices](notices.md) for complete details, including attribution guidelines, contribution terms, and software and third-party licenses and permissions. +## Folder Structure + +```.devcontainer``` This folder contains configuration files (like devcontainer.json) that define a developement environment for the project. +It helps set up a consistent workspace for developers, ensuring everyone works with the same tools, settings and dependencies, regardless +of their local set up. + + ## Acknowledgments The initial release of these guides were authored by **[@nayafia][1], [@bkeepers][2], [@stephbwills][3],** and **[@mlinksva][4]**. From 4d9ebeb8bbfa44fe4f2c98bef79d462a0aaae903 Mon Sep 17 00:00:00 2001 From: SYED Date: Mon, 18 Nov 2024 17:01:37 +0000 Subject: [PATCH 2/3] complete 60% of Folder Structure section --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 479e7afbfa6..d6d2ab12b35 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,36 @@ Content is released under [CC-BY-4.0](https://creativecommons.org/licenses/by/4. It helps set up a consistent workspace for developers, ensuring everyone works with the same tools, settings and dependencies, regardless of their local set up. +```.github``` This folder is used to store GitHub-specifc configuration files for the repository. It helps manage automation, workflows, and guidelines +for contribtors. + +```_articles``` This folder contains all the written content (articles) for this project, organized by language and topic. These articles provide +helpful guidance, best practices, and insights about contributing to open source projects. + +```_data``` This folder contains data files (in formats like YAML) used to store structured information, like site settings, translations, +or metadata. The repository reads these files to dynamically generate parts of the website, such as menus, translations or lists. The folder is important +because it seperates content from code, making it easier to update data without changing the code itself + +```_includes``` This folder contains reusable chunks of HTML code, like headers, footers, or components that appear on multiple pages. +The files within this folder are inserted into larger templates or pages, reducing repetition and keeping the code organized. This folder +ensures consistency across the site and makes it easy to update shared elements in one place instead of multiple files. + +```_layouts``` This folder contains layouts templates (files) for the site, each file in the folder is a template for a page on the application. +The layout templates in this folder act like blueprints, they determing where certain parts of the page goes and storing all the templates in this folder allows +for components to be reused across multiple pages this helps to keep the site consistent and easier to maintain. + +```assets``` This folder contains static files like images, CSS (styles), and JavaScript (scripts) used to style and add functionality to the website. +These files are served to users when they visit the site, making it look nice and interactive. Storing all the designs and functionality-related files in one place, +keeps the repository organized. + +```docs``` This folder holds documentation files related to the project. It provides extra information for developers or contributors, +like how to set up or use the project. This extra information gives developers the opportunity to contribute to this repository beyond just the README file. + +```node_modules``` This folder contains all the dependencies (external libraries and tools) managed by Node.js, which are needed to build or run the project. +It provides the code libraries the project relies on, such as tools for building the website and running workflows. + + + ## Acknowledgments From 8c4dc56c466b15af0ab08c4d2beb3b42a1d41bd1 Mon Sep 17 00:00:00 2001 From: SYED Date: Mon, 18 Nov 2024 17:28:54 +0000 Subject: [PATCH 3/3] complete the folder section of readme --- README.md | 54 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 31 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index d6d2ab12b35..29e0989fbfd 100644 --- a/README.md +++ b/README.md @@ -18,40 +18,48 @@ Content is released under [CC-BY-4.0](https://creativecommons.org/licenses/by/4. ## Folder Structure -```.devcontainer``` This folder contains configuration files (like devcontainer.json) that define a developement environment for the project. -It helps set up a consistent workspace for developers, ensuring everyone works with the same tools, settings and dependencies, regardless -of their local set up. +```.devcontainer``` This folder contains configuration files (like devcontainer.json) that define a development environment for the project. +It helps set up a consistent workspace for developers, ensuring everyone works with the same tools, settings, and dependencies, regardless +of their local setup. -```.github``` This folder is used to store GitHub-specifc configuration files for the repository. It helps manage automation, workflows, and guidelines -for contribtors. +```.github``` This folder is used to store GitHub-specific configuration files for the repository. It helps manage automation, workflows, and guidelines +for contributors. -```_articles``` This folder contains all the written content (articles) for this project, organized by language and topic. These articles provide -helpful guidance, best practices, and insights about contributing to open source projects. +```_articles``` This folder contains all the written content (articles) for this project, organized by language and topic. These articles provide +helpful guidance, best practices, and insights about contributing to open source projects. -```_data``` This folder contains data files (in formats like YAML) used to store structured information, like site settings, translations, -or metadata. The repository reads these files to dynamically generate parts of the website, such as menus, translations or lists. The folder is important -because it seperates content from code, making it easier to update data without changing the code itself +```_data``` This folder contains data files (in formats like YAML) used to store structured information, such as site settings, translations, +or metadata. The repository reads these files to dynamically generate parts of the website, such as menus, translations, or lists. The folder is important +because it separates content from code, making it easier to update data without changing the code itself. -```_includes``` This folder contains reusable chunks of HTML code, like headers, footers, or components that appear on multiple pages. -The files within this folder are inserted into larger templates or pages, reducing repetition and keeping the code organized. This folder -ensures consistency across the site and makes it easy to update shared elements in one place instead of multiple files. +```_includes``` +This folder contains reusable chunks of HTML code, like headers, footers, or components that appear on multiple pages. +The files within this folder are inserted into larger templates or pages, reducing repetition and keeping the code organized. This folder +ensures consistency across the site and makes it easy to update shared elements in one place instead of multiple files. -```_layouts``` This folder contains layouts templates (files) for the site, each file in the folder is a template for a page on the application. -The layout templates in this folder act like blueprints, they determing where certain parts of the page goes and storing all the templates in this folder allows -for components to be reused across multiple pages this helps to keep the site consistent and easier to maintain. +```_layouts``` +This folder contains layout templates (files) for the site. Each file in the folder is a template for a page on the application. +The layout templates in this folder act like blueprints: they determine where certain parts of the page go. Storing all the templates in this folder allows +for components to be reused across multiple pages, which helps keep the site consistent and easier to maintain. -```assets``` This folder contains static files like images, CSS (styles), and JavaScript (scripts) used to style and add functionality to the website. -These files are served to users when they visit the site, making it look nice and interactive. Storing all the designs and functionality-related files in one place, -keeps the repository organized. +```assets``` This folder contains static files like images, CSS (styles), and JavaScript (scripts) used to style and add functionality to the website. +These files are served to users when they visit the site, making it look nice and interactive. Storing all the design and functionality-related files in one place +keeps the repository organized. -```docs``` This folder holds documentation files related to the project. It provides extra information for developers or contributors, -like how to set up or use the project. This extra information gives developers the opportunity to contribute to this repository beyond just the README file. +```docs``` This folder holds documentation files related to the project. It provides extra information for developers or contributors, +such as how to set up or use the project. This extra information gives developers the opportunity to contribute to this repository beyond just the README file. ```node_modules``` This folder contains all the dependencies (external libraries and tools) managed by Node.js, which are needed to build or run the project. -It provides the code libraries the project relies on, such as tools for building the website and running workflows. - +It provides the code libraries the project relies on, such as tools for building the website and running workflows. It ensures the project works as expected without +requiring developers to manually install every dependency. +```script``` This folder stores automation scripts used for specific tasks, like testing, building, or deploying the project. It runs the commands or tools +to streamline workflows, such as running tests or ignoring specific URLs during builds. This folder automates repetitive tasks, saving time +and reducing human error. +```test``` This folder contains test files and configurations to ensure the project works as expected. It runs checks (tests) on the code, workflows, or site functionality +to catch bugs or issues before changes are merged. The files in this folder maintain the quality of the project by verifying everything works correctly, which is especially important +for collaborative projects. ## Acknowledgments