Third round of cleaning

- Cleaned up structure, files and content
learning-software-engineering · Feb 28, 2023 · 068843c · 068843c
1 parent 2d0b67b
commit 068843c
Show file tree

Hide file tree

Showing 21 changed files with 64 additions and 89 deletions.
diff --git a/Assignment3/readme.md b/Assignment3/readme.md
diff --git a/README.md b/README.md
@@ -1 +1,63 @@
-Welcome to Learning Software Engineering Repository. This is intended as a resource for students new to software engineering to contribute to the ever growing body of knowledge of software engineering by adding/editing their input to help other students learn better.
+## Intro
+Welcome to Learning Software Engineering Repository. This is intended as a resource for students new to software engineering to contribute to the ever growing body of knowledge of software engineering by adding/editing their input to help other students learn better. 
+Readers are expected to know the foundation of software engineering and computer science (e.g., basics of algorithms, foundations of programming).
+
+Following files are present in this directory. You may contribute to any of these of your choice. If you are contributing by forming multiple pages, consider structuring your files into a new sub-directory within the topic's directory. Contribute to the readme files within each topic directory as appropriate.
+
+-----
+
+Potential Topics--
+
+- Tech stacks
+- Software Engineering
+    1. Methodologies & Frameworks
+        1. Agile
+            1. Scrum
+            2. Kanban
+            3. XP
+        2. Waterfall
+- Task management software
+    1. Linear.app
+    2. Jira
+    3. GitHub Projects
+
+- Development Process
+    1. GitFlow
+    2. Trunk-based Development
+    3. Coding Standards
+    4. Pull-requests
+    5. DevOps
+        1. Automated Testing
+            1. Unit testings
+            2. Integration testing
+        2. Build tools
+            1. Maven
+            2. Gradle
+        3. Build requirements
+            1. requirements.txt
+            2. packages
+        4. Deployment
+            1. Heroku
+            2. AWS
+            3. Firebase
+            4. Digital Ocean
+            5. 6. Software development best practices:
+    1. Designer Patterns
+    2. Clean Coding
+        1. Choose a coding style and stick to it
+    3. SOLID Principles
+    4. Code Smells
+- Professionalism
+    1. Customer engagement
+        1. Meeting best practices
+        2. Progress Updates
+    2. Communication
+        1. Asking questions
+            1.  Hi everyone, I am working on ____, and I am stuck on ____. I tried ____, it didn’t work because _____. I also tried _____, and it didn’t work because ____. I am assuming _____ and ____. Does anyone have any hints as to what might be wrong?
+    3. Presentations
+
+
+- User Experience
+- Product Management
+- Other useful resources
+- Teamwork
diff --git a/Assignment3/Development_Process.md → Topics/Development_Process.md b/Assignment3/Development_Process.md → Topics/Development_Process.md
diff --git a/Assignment3/Other_resources.md → Topics/Other_resources.md b/Assignment3/Other_resources.md → Topics/Other_resources.md
diff --git a/Assignment3/Product_mgmt.md → Topics/Product_mgmt.md b/Assignment3/Product_mgmt.md → Topics/Product_mgmt.md
diff --git a/Assignment3/Professionalism.md → Topics/Professionalism.md b/Assignment3/Professionalism.md → Topics/Professionalism.md
diff --git a/Assignment3/Software_Engineering.md → Topics/Software_Engineering.md b/Assignment3/Software_Engineering.md → Topics/Software_Engineering.md
diff --git a/Assignment3/Software_dev.md → Topics/Software_dev.md b/Assignment3/Software_dev.md → Topics/Software_dev.md
diff --git a/Assignment3/Task_mgmt_software.md → Topics/Task_mgmt_software.md b/Assignment3/Task_mgmt_software.md → Topics/Task_mgmt_software.md
diff --git a/Assignment3/Teamwork.md → Topics/Teamwork.md b/Assignment3/Teamwork.md → Topics/Teamwork.md
diff --git a/Assignment3/TechStacks.md → Topics/TechStacks.md b/Assignment3/TechStacks.md → Topics/TechStacks.md
diff --git a/Assignment3/UserExperience.md → Topics/UserExperience.md b/Assignment3/UserExperience.md → Topics/UserExperience.md
diff --git a/_assg3/_other/ex1.md b/_assg3/_other/ex1.md
diff --git a/_assg3/assg3.md b/_assg3/assg3.md
diff --git a/_config.yml b/_config.yml
@@ -1,9 +1,4 @@
-title: CSC301, Spring 2023 
+title: CSC301, Winter 2023 
 description: Introduction To Software Engineering
 repository: learning-software-engineering/learning-software-engineering.github.io
 theme: jekyll-theme-cayman
-
-collections:
-  assg3:
-    output: true
-    permalink: /assg3/:path/
diff --git a/_includes/_assg3/_other/file1.md b/_includes/_assg3/_other/file1.md
diff --git a/_includes/_assg3/readme-ass3.md b/_includes/_assg3/readme-ass3.md
diff --git a/_includes/_assg3/soft_dev/soft_dev1.md b/_includes/_assg3/soft_dev/soft_dev1.md
diff --git a/_includes/announcements.md b/_includes/announcements.md
diff --git a/_includes/assg3.md b/_includes/assg3.md
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -30,9 +30,6 @@ <h1 class="project-name">Software Engineering Learning Center</h1>
       <footer class="site-footer">
         <span class="site-footer-credits">This page was generated using the <a href="https://github.com/jasonlong/cayman-theme">Cayman theme</a> by <a href="https://twitter.com/jasonlong">Jason Long</a>.</span>
       </footer>
-
     </section>
-
-
   </body>
 </html>