Skip to content

Commit 2a5aeae

Browse files
notMONGCHAWnotMONGCHAW
authored
Merge pull request #1 from UIU-Developers-Hub/main
Placeholder Content for Further Editing
2 parents 490ce2e + 696bf0c commit 2a5aeae

6 files changed

Lines changed: 149 additions & 4 deletions

File tree

‎_data/topnav.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ topnav:
55
items:
66
- title: GitHub
77
external_url: https://github.com/UIU-Developers-Hub
8+
- title: About Us
9+
url: /about.html
10+
- title: Getting Started
11+
url: /getting-started.html
12+
- title: How to Contribute
13+
url: /how-to-contribute.html
14+
- title: Contributors List
15+
url: /contributorsList.html
816

917
#Topnav dropdowns
1018
topnav_dropdowns:

‎contributorsList.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "Contributors List"
3+
keywords: Contributors, Open Source
4+
tags: [contributors, open_source]
5+
permalink: contributorsList.html
6+
hide_sidebar: true
7+
8+
---
9+
10+
# Contributors List
11+
12+
Below are the members who have contributed to UIU Developers Hub Documentation. To add your name, submit a pull request to this file!
13+
14+
---
15+
16+
*This list will be updated automatically via GitHub Actions in the future.*
17+
18+
## Contributors
19+
20+
<!-- Add your name below this line -->

‎index.md‎

Lines changed: 60 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,65 @@
11
---
2-
title: "Starting your Journey as Developer"
3-
keywords: Homepage
4-
tags: [getting_started]
2+
title: "UIU Developers Hub Documentation"
3+
keywords: Homepage, Getting Started
4+
tags: [getting_started, organization]
55
permalink: index.html
66
hide_sidebar: true
77
---
88

9-
## This is a place holder
9+
# Welcome to UIU Developers Hub
10+
11+
UIU Developers Hub is the official GitHub organization for developers, faculty, and alumni of United International University. This documentation will help you get started, understand our community standards, and make the most of your membership.
12+
13+
## Why This Project Exists: Learning the Development Lifecycle
14+
15+
When you first show interest in becoming a software developer or engineer, understanding the software development lifecycle is essential. The UIU Developers Hub Documentation project is designed to be a practical, hands-on example of how modern development teams work together, communicate, and build real products.
16+
17+
### What You’ll Experience Here
18+
19+
- **Documentation as a Foundation:** Reading and following documentation is a key part of every developer’s journey. This project demonstrates how clear documentation guides contributors and helps teams succeed.
20+
- **Static Site Generators:** We use tools like Jekyll to transform simple markdown files into dynamic, professional websites. This is the same approach used by many open source projects and tech companies to share knowledge and updates.
21+
- **GitHub CI/CD Workflows:** Automated build and deployment pipelines (CI/CD) ensure that changes are reviewed, tested, and published efficiently. You’ll see how your contributions move from code to live website through these workflows.
22+
- **Open Source Collaboration:** By contributing here, you’ll learn how to fork repositories, create branches, submit pull requests, and review code—core skills for any developer.
23+
24+
### Why This Matters for You
25+
26+
Participating in this project helps you:
27+
28+
- Build habits for reading and writing documentation.
29+
- Understand the full development lifecycle, from planning to deployment.
30+
- Gain real-world experience with tools and workflows used by professional teams.
31+
- Prepare to contribute to other open source projects and build your own dynamic web resources, such as news portals or documentation sites.
32+
33+
UIU Developers Hub is your starting point for learning, growing, and making an impact in the world of software development. Every contribution you make here is a step toward mastering the development lifecycle and becoming a confident, collaborative developer.
34+
35+
## About the Organization
36+
37+
UIU Developers Hub is dedicated to fostering collaboration, innovation, and growth among its members. Whether you are a student, faculty, or alumni, you are invited to contribute, mentor, and learn together.
38+
39+
## Getting Started
40+
41+
- **Join the Organization:** Request access via GitHub or contact an admin.
42+
- **Explore Projects:** Browse our repositories and find projects that interest you.
43+
- **Read the Guidelines:** Familiarize yourself with our community standards below.
44+
45+
## Community Guidelines
46+
47+
- **Be Active and Collaborative:** Participate in projects and discussions.
48+
- **Project Transfer Policy:** Transfer ownership of added projects within one week.
49+
- **Discussion Etiquette:** Keep conversations respectful and constructive.
50+
- **Contributing:** Contact main contributors and review project guidelines before contributing.
51+
- **Blogging:** Contribute to our Blog repository after reviewing submission guidelines.
52+
53+
## Member Types
54+
55+
- **Normal Members:** All general guidelines and contribution rules apply.
56+
- **Faculty Members:** Contribution rules are optional; mentoring is encouraged.
57+
- **Alumni Members:** Contribution rules are optional; mentoring is encouraged.
58+
59+
## Welcome Message
60+
61+
> Welcome to UIU Developers Hub! Whether you're a seasoned developer or just starting out, there's a place for you here. We believe in the power of collaboration and innovation. Together, we can tackle challenges, explore new ideas, and create solutions that make a difference. Stay active, engage with your fellow members, and embrace opportunities to learn and share your knowledge.
62+
>
63+
> Thank you for being a part of UIU Developers Hub. We look forward to building great things together!
64+
>
65+
> — [Fatin Shadab](https://github.com/FatinShadab) / UIU Developers Hub Team

‎pages/about.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: "About UIU Developers Hub"
3+
keywords: About, Organization, Mission
4+
tags: []
5+
permalink: about.html
6+
folder: pages
7+
hide_sidebar: true
8+
---
9+
10+
# About UIU Developers Hub
11+
12+
UIU Developers Hub (UIUDH) is the official GitHub organization for developers, faculty, and alumni of United International University. Our mission is to foster collaboration, innovation, and growth among all members interested in software development.
13+
14+
Whether you are a student, faculty, or alumni, you are invited to contribute, mentor, and learn together. Explore our projects, participate in discussions, and help build a vibrant developer community.

‎pages/getting-started.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "Getting Started"
3+
keywords: Getting Started, Onboarding
4+
tags: [getting_started, onboarding]
5+
permalink: getting-started.html
6+
folder: pages
7+
hide_sidebar: true
8+
---
9+
10+
# Getting Started with UIU Developers Hub
11+
12+
To join UIU Developers Hub, you must make at least one contribution to an open source project within our organization. This is a requirement to help you understand the development lifecycle and the importance of documentation and collaboration.
13+
14+
## Why is this Required?
15+
16+
- **Learn by Doing:** Making a contribution helps you experience the workflow of real software projects.
17+
- **Understand Documentation:** Reading and following documentation is a key part of development.
18+
- **Build Good Habits:** You’ll learn how to communicate, collaborate, and work with version control.
19+
20+
## Steps to Get Started
21+
22+
1. Read our [How to Contribute](how-to-contribute.md) guide.
23+
2. Add your name to [contributorsList.md](../contributorsList.md) and submit a pull request.
24+
3. Explore other projects and contribute as you grow.
25+
26+
Welcome to the community!

‎pages/how-to-contribute.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: "How to Contribute"
3+
keywords: Contributing, Open Source
4+
tags: [contributing, open_source]
5+
permalink: how-to-contribute.html
6+
folder: pages
7+
hide_sidebar: true
8+
---
9+
10+
# How to Contribute to Open Source Projects
11+
12+
Contributing to open source is a valuable way to learn, collaborate, and make an impact. At UIU Developers Hub, we encourage every member to make their first contribution by following these steps:
13+
14+
1. **Find a Project:** Explore repositories in our organization and choose one that interests you.
15+
2. **Read the Documentation:** Understand the project's purpose, guidelines, and contribution process.
16+
3. **Fork and Clone:** Fork the repository to your account and clone it locally.
17+
4. **Make Changes:** Add your contribution (e.g., your name to the contributors list, fix a bug, add documentation).
18+
5. **Submit a Pull Request:** Push your changes and open a pull request for review.
19+
6. **Engage:** Respond to feedback and collaborate with maintainers.
20+
21+
By contributing, you build real-world skills and become part of a global community of developers.

0 commit comments

Comments
 (0)