Skip to content

Commit fde13b5

Browse files
aymanaboghonimaymanaboghonim
authored
Merge pull request #3 from aymanaboghonim/refactor/restructure-devops-vision
Restructure repository to align with DevOps Visions standards
2 parents 238814f + bddf508 commit fde13b5

14 files changed

Lines changed: 608 additions & 90 deletions

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: 'bug'
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
A clear and concise description of what the bug is.
11+
12+
## Steps To Reproduce
13+
1. Go to '...'
14+
2. Click on '....'
15+
3. Scroll down to '....'
16+
4. See error
17+
18+
## Expected Behavior
19+
A clear and concise description of what you expected to happen.
20+
21+
## Actual Behavior
22+
A clear and concise description of what actually happened.
23+
24+
## Screenshots
25+
If applicable, add screenshots to help explain your problem.
26+
27+
## Environment
28+
- OS: [e.g. Windows, macOS, Linux]
29+
- Browser: [e.g. Chrome, Safari, Firefox]
30+
- Version: [e.g. 22]
31+
32+
## 🚨 WEBSITE SAFETY CHECK 🚨
33+
Please confirm the following to ensure website functionality is preserved:
34+
35+
- [ ] This bug report DOES NOT suggest changes to the website code in the \src/\ directory
36+
- [ ] This bug report DOES NOT suggest changes to the static assets in \public/\ directory
37+
- [ ] This bug report DOES NOT affect the build configuration
38+
- [ ] This bug report DOES NOT affect deployment scripts
39+
40+
## Additional Context
41+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Documentation improvement
3+
about: Suggest improvements to our documentation
4+
title: '[DOCS] '
5+
labels: 'documentation'
6+
assignees: ''
7+
---
8+
9+
## Documentation Issue
10+
A clear and concise description of what's wrong or missing in the current documentation.
11+
12+
## Suggested Improvement
13+
A clear and concise description of how you think the documentation should be improved.
14+
15+
## Where This Documentation Should Appear
16+
- [ ] README.md
17+
- [ ] CONTRIBUTING.md
18+
- [ ] CODE_OF_CONDUCT.md
19+
- [ ] docs/ directory
20+
- [ ] Other: (please specify)
21+
22+
## 🚨 WEBSITE SAFETY CHECK 🚨
23+
Please confirm the following to ensure website functionality is preserved:
24+
25+
- [ ] This documentation improvement DOES NOT involve modifying website code in the \src/\ directory
26+
- [ ] This documentation improvement DOES NOT involve modifying static assets in \public/\ directory
27+
- [ ] This documentation improvement DOES NOT affect the build configuration
28+
- [ ] This documentation improvement DOES NOT affect deployment scripts
29+
30+
## Additional Context
31+
Add any other context or screenshots about the documentation improvement here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: 'enhancement'
6+
assignees: ''
7+
---
8+
9+
## Problem Statement
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
## Proposed Solution
13+
A clear and concise description of what you want to happen.
14+
15+
## Alternatives Considered
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
## 🚨 WEBSITE SAFETY CHECK 🚨
19+
Please confirm the following to ensure website functionality is preserved:
20+
21+
- [ ] This feature request DOES NOT involve modifying website code in the \src/\ directory
22+
- [ ] This feature request DOES NOT involve modifying static assets in \public/\ directory
23+
- [ ] This feature request DOES NOT affect the build configuration
24+
- [ ] This feature request DOES NOT affect deployment scripts
25+
26+
*If your feature does require website changes, please discuss with maintainers first.*
27+
28+
## Additional Context
29+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Question
3+
about: Ask a question about this project
4+
title: '[QUESTION] '
5+
labels: 'question'
6+
assignees: ''
7+
---
8+
9+
## Question
10+
A clear and concise description of your question.
11+
12+
## Context
13+
Add any context that might help us answer your question.
14+
15+
## What I've Tried Already
16+
Explain what you've already tried or what research you've already done.
17+
18+
## 🚨 WEBSITE SAFETY CHECK 🚨
19+
Please confirm the following to ensure website functionality is preserved:
20+
21+
- [ ] My question is NOT about modifying website code in the \src/\ directory
22+
- [ ] My question is NOT about modifying static assets in \public/\ directory
23+
- [ ] My question is NOT about modifying the build configuration
24+
- [ ] My question is NOT about modifying deployment scripts
25+
26+
*If your question does involve website changes, please add a special note at the beginning of your question.*
27+
28+
## Additional Information
29+
Any additional information that might be helpful.

‎.github/PULL_REQUEST_TEMPLATE/website_changes.md‎

Whitespace-only changes.

‎CODE_OF_CONDUCT.md‎

Whitespace-only changes.

‎CONTRIBUTING.md‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Contributing to Elmentor Landing Page
2+
3+
Thank you for your interest in contributing to the Elmentor Landing Page project! This document outlines the process and guidelines for contributing to this repository.
4+
5+
## 🚨 CRITICAL WEBSITE PROTECTION NOTICE 🚨
6+
7+
**This repository contains the live GitHub Pages website serving as the landing page for our community. The following files/directories are STRICTLY OFF-LIMITS for modification:**
8+
9+
- \src/\ directory (website source code)
10+
- \public/\ directory (static assets)
11+
- \ ite.config.ts\ (build configuration)
12+
- \package.json\ and \package-lock.json\ (dependencies)
13+
- \.github/workflows/deploy.yml\ (deployment configuration)
14+
15+
**Any contribution that modifies these protected files will be rejected unless explicitly approved by maintainers and thoroughly tested.**
16+
17+
## How to Contribute
18+
19+
### Issues
20+
21+
1. **Search** existing issues to avoid creating duplicates.
22+
2. **Create an issue** for bugs, feature requests, or documentation improvements.
23+
3. **Use the appropriate template** when creating issues.
24+
4. **Label your issues** correctly to help with organization.
25+
26+
### Pull Requests
27+
28+
#### For Documentation, Templates, and Non-Website Changes
29+
30+
1. **Fork the repository** and create a branch from \main\ with an appropriate name:
31+
- \ eature/description\ for features
32+
- \ugfix/description\ for bug fixes
33+
- \docs/description\ for documentation
34+
- \efactor/description\ for code refactoring
35+
36+
2. **Make your changes** following coding standards and conventions.
37+
38+
3. **Test your changes** thoroughly.
39+
40+
4. **Submit a pull request** using the appropriate template:
41+
- Include a clear title and description
42+
- Reference any related issues
43+
- Complete the website safety checklist
44+
- Request review from appropriate reviewers
45+
46+
#### For Website Changes (Rare, Requires Special Approval)
47+
48+
1. **First create an issue** detailing why website changes are necessary.
49+
50+
2. **Get maintainer approval** before proceeding.
51+
52+
3. **Create a separate development branch** specifically for website changes.
53+
54+
4. **Test thoroughly** in a local environment.
55+
56+
5. **Submit a pull request** using the website changes template:
57+
- Provide detailed explanation of changes
58+
- Include before/after screenshots
59+
- Document thorough testing performed
60+
- Include a rollback plan
61+
- Request reviews from at least two maintainers
62+
63+
## Development Process
64+
65+
### Setting Up Your Environment
66+
67+
1. Clone the repository:
68+
`ash
69+
git clone https://github.com/DevOpsVisions/elmentor-landing-page-clean.git
70+
cd elmentor-landing-page-clean
71+
`
72+
73+
2. Install dependencies:
74+
`ash
75+
npm install
76+
`
77+
78+
3. Start the development server:
79+
`ash
80+
npm run dev
81+
`
82+
83+
### Testing
84+
85+
- Test all changes locally before submitting PRs
86+
- For website changes, verify on multiple browsers and devices
87+
- Ensure all existing functionality works correctly
88+
89+
## Style Guide
90+
91+
Please follow the DevOps Visions standards and conventions as outlined in:
92+
- [Standards and Conventions](docs/devops-visions-guidance/standards-and-conventions.md)
93+
- [Naming Conventions](docs/devops-visions-guidance/naming-conventions.md)
94+
- [Repository Structure](docs/devops-visions-guidance/repository-structure.md)
95+
96+
## Code of Conduct
97+
98+
Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing to this project.
99+
100+
## Questions?
101+
102+
If you have questions or need help, please:
103+
1. Check the documentation in the \docs\ directory
104+
2. Open an issue with the question template
105+
3. Contact the maintainers through the DevOps Visions community channels
106+
107+
Thank you for contributing to the Elmentor Landing Page project!

‎README.md‎

Lines changed: 0 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +0,0 @@
1-
# Elmentor Landing Page
2-
3-
A clean, maintainable landing page for the Elmentor/DevOps Visions community built with React, TypeScript, and Vite.
4-
5-
## 📋 Quick Start
6-
7-
```bash
8-
# Install dependencies
9-
npm install
10-
11-
# Start development server
12-
npm run dev
13-
14-
# Build for production
15-
npm run build
16-
17-
# Preview production build
18-
npm run serve
19-
```
20-
21-
## 🚀 Deployment
22-
23-
To deploy to GitHub Pages:
24-
25-
1. Update your GitHub username in `github-config.txt`
26-
2. Run the deployment script:
27-
```bash
28-
# PowerShell (recommended)
29-
./deploy.ps1
30-
31-
# Or using npm
32-
npm run deploy
33-
```
34-
35-
## 🛠️ Project Structure
36-
37-
```
38-
elmentor-landing-page-clean/
39-
├── dist/ # Build output
40-
├── docs/ # Documentation
41-
├── public/ # Static assets
42-
├── scripts/ # Utility scripts
43-
│ ├── deployment/ # Deployment scripts
44-
│ ├── maintenance/ # Maintenance scripts
45-
│ └── utils/ # Utility scripts
46-
├── .temp/ # Untracked local development files (not in Git)
47-
└── src/ # Source code
48-
```
49-
50-
## 🧩 Features
51-
52-
- Modern React with TypeScript
53-
- Fast builds with Vite
54-
- Responsive design
55-
- Framer Motion animations
56-
- GitHub Pages deployment
57-
58-
## 🧰 Maintenance
59-
60-
For repository maintenance tasks:
61-
62-
```bash
63-
./maintain.ps1
64-
```
65-
66-
## 🔧 Development Utilities
67-
68-
For local development files that shouldn\'t be committed:
69-
70-
```bash
71-
# Move or copy files to untracked .temp directory
72-
./move-to-temp.ps1
73-
```
74-
75-
The `.temp` directory is ignored by Git and provides a standardized location for:
76-
- Development scripts
77-
- Documentation drafts
78-
- Temporary build outputs
79-
- Work-in-progress files
80-
81-
## 📚 Documentation
82-
83-
For detailed documentation, see the `docs` directory:
84-
85-
- [Deployment Guide](docs/deployment/README.md)
86-
- [Development Maintenance](docs/development/maintenance.md)
87-
88-
## 📄 License
89-
90-
This project is licensed under the MIT License.

‎SECURITY.md‎

Whitespace-only changes.

‎docs/devops-visions-guidance/README.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# DevOps Visions Guidance Documentation
2+
3+
This directory contains reference documentation for DevOps Visions standards and practices. These documents are sourced from the [DevOps Visions common-workspace-hub](https://github.com/DevOpsVisions/common-workspace-hub/tree/main/docs/standards-and-practices) and adapted for the Elmentor Landing Page repository.
4+
5+
## Important Note on Website Content
6+
7+
**The guidance in these documents DOES NOT supersede the critical requirement to preserve the website functionality and content in the \src/\, \public/\, build configuration, and deployment scripts.**
8+
9+
## Included Documentation
10+
11+
- [Standards and Conventions](standards-and-conventions.md) - Coding standards, naming conventions, and best practices
12+
- [Repository Structure](repository-structure.md) - Structure and organization of DevOps Visions repositories
13+
- [Naming Conventions](naming-conventions.md) - File, branch, and commit naming conventions
14+
- [Review Process](review-process.md) - Guidelines for reviewing and merging code
15+
16+
## Attribution
17+
18+
These documents are based on DevOps Visions standards found at:
19+
https://github.com/DevOpsVisions/common-workspace-hub/tree/main/docs/standards-and-practices
20+
21+
The content has been adapted specifically for the Elmentor Landing Page repository with special considerations for preserving website functionality.

0 commit comments

Comments
 (0)