Skip to content

Commit 0c5ff2c

Browse files
Add temporary manual deployment section to README.md
Co-authored-by: aymanaboghonim <62246708+aymanaboghonim@users.noreply.github.com>
1 parent 5f61d90 commit 0c5ff2c

145 files changed

Lines changed: 23735 additions & 1887 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,49 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
title: '[BUG] '
5-
labels: 'bug'
6-
assignees: ''
4+
title: "[BUG] "
5+
labels: "bug"
6+
assignees: ""
77
---
88

99
## Bug Description
10+
1011
A clear and concise description of what the bug is.
1112

1213
## Steps To Reproduce
14+
1315
1. Go to '...'
1416
2. Click on '....'
1517
3. Scroll down to '....'
1618
4. See error
1719

1820
## Expected Behavior
21+
1922
A clear and concise description of what you expected to happen.
2023

2124
## Actual Behavior
25+
2226
A clear and concise description of what actually happened.
2327

2428
## Screenshots
29+
2530
If applicable, add screenshots to help explain your problem.
2631

2732
## Environment
33+
2834
- OS: [e.g. Windows, macOS, Linux]
2935
- Browser: [e.g. Chrome, Safari, Firefox]
3036
- Version: [e.g. 22]
3137

3238
## 🚨 WEBSITE SAFETY CHECK 🚨
39+
3340
Please confirm the following to ensure website functionality is preserved:
3441

3542
- [ ] This bug report DOES NOT suggest changes to the website code in the \src/\ directory
3643
- [ ] This bug report DOES NOT suggest changes to the static assets in \public/\ directory
3744
- [ ] This bug report DOES NOT affect the build configuration
38-
- [ ] This bug report DOES NOT affect deployment scripts
45+
- [ ] This bug report DOES NOT affect deployment scripts
3946

4047
## Additional Context
48+
4149
Add any other context about the problem here.
Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,36 @@
11
---
22
name: Documentation improvement
33
about: Suggest improvements to our documentation
4-
title: '[DOCS] '
5-
labels: 'documentation'
6-
assignees: ''
4+
title: "[DOCS] "
5+
labels: "documentation"
6+
assignees: ""
77
---
88

99
## Documentation Issue
10+
1011
A clear and concise description of what's wrong or missing in the current documentation.
1112

1213
## Suggested Improvement
14+
1315
A clear and concise description of how you think the documentation should be improved.
1416

1517
## Where This Documentation Should Appear
18+
1619
- [ ] README.md
1720
- [ ] CONTRIBUTING.md
1821
- [ ] CODE_OF_CONDUCT.md
1922
- [ ] docs/ directory
2023
- [ ] Other: (please specify)
2124

2225
## 🚨 WEBSITE SAFETY CHECK 🚨
26+
2327
Please confirm the following to ensure website functionality is preserved:
2428

2529
- [ ] 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
30+
- [ ] This documentation improvement DOES NOT involve modifying static assets in \public/\ directory
2731
- [ ] This documentation improvement DOES NOT affect the build configuration
2832
- [ ] This documentation improvement DOES NOT affect deployment scripts
2933

3034
## Additional Context
35+
3136
Add any other context or screenshots about the documentation improvement here.
Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,34 @@
11
---
22
name: Feature request
33
about: Suggest an idea for this project
4-
title: '[FEATURE] '
5-
labels: 'enhancement'
6-
assignees: ''
4+
title: "[FEATURE] "
5+
labels: "enhancement"
6+
assignees: ""
77
---
88

99
## Problem Statement
10+
1011
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1112

1213
## Proposed Solution
14+
1315
A clear and concise description of what you want to happen.
1416

1517
## Alternatives Considered
18+
1619
A clear and concise description of any alternative solutions or features you've considered.
1720

1821
## 🚨 WEBSITE SAFETY CHECK 🚨
22+
1923
Please confirm the following to ensure website functionality is preserved:
2024

2125
- [ ] This feature request DOES NOT involve modifying website code in the \src/\ directory
2226
- [ ] This feature request DOES NOT involve modifying static assets in \public/\ directory
2327
- [ ] This feature request DOES NOT affect the build configuration
2428
- [ ] This feature request DOES NOT affect deployment scripts
2529

26-
*If your feature does require website changes, please discuss with maintainers first.*
30+
_If your feature does require website changes, please discuss with maintainers first._
2731

2832
## Additional Context
33+
2934
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,34 @@
11
---
22
name: Question
33
about: Ask a question about this project
4-
title: '[QUESTION] '
5-
labels: 'question'
6-
assignees: ''
4+
title: "[QUESTION] "
5+
labels: "question"
6+
assignees: ""
77
---
88

99
## Question
10+
1011
A clear and concise description of your question.
1112

1213
## Context
14+
1315
Add any context that might help us answer your question.
1416

1517
## What I've Tried Already
18+
1619
Explain what you've already tried or what research you've already done.
1720

1821
## 🚨 WEBSITE SAFETY CHECK 🚨
22+
1923
Please confirm the following to ensure website functionality is preserved:
2024

2125
- [ ] My question is NOT about modifying website code in the \src/\ directory
2226
- [ ] My question is NOT about modifying static assets in \public/\ directory
2327
- [ ] My question is NOT about modifying the build configuration
2428
- [ ] My question is NOT about modifying deployment scripts
2529

26-
*If your question does involve website changes, please add a special note at the beginning of your question.*
30+
_If your question does involve website changes, please add a special note at the beginning of your question._
2731

2832
## Additional Information
33+
2934
Any additional information that might be helpful.

.github/PULL_REQUEST_TEMPLATE/documentation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Documentation Reorganization
22

33
## Description
4+
45
This PR reorganizes the project documentation to improve maintainability and clarity.
56

67
## Changes Made
8+
79
- Created structured documentation directories:
810
- `/docs/deployment/` - Deployment-related documentation
911
- `/docs/development/` - Development guidelines and standards
@@ -18,18 +20,23 @@ This PR reorganizes the project documentation to improve maintainability and cla
1820
- Moved legacy/outdated documentation to a separate directory
1921

2022
## Why These Changes Are Needed
23+
2124
The previous documentation structure had many overlapping files and lacked clear organization, making it difficult to find specific information. This reorganization makes it easier to:
25+
2226
1. Find specific documentation
2327
2. Maintain documentation as the project evolves
2428
3. Onboard new developers quickly
2529

2630
## Testing Performed
31+
2732
- Verified all documentation links are working
2833
- Checked for consistent formatting
2934
- Ensured no information was lost in the consolidation
3035

3136
## Screenshots
37+
3238
[If applicable]
3339

3440
## Additional Notes
41+
3542
The `gh-pages` branch remains unchanged as it contains only the compiled website files.

.github/pull_request_template.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
11
# Pull Request
22

33
## Description
4+
45
[Provide a brief description of the changes made in this PR]
56

67
## Changes Made
8+
79
- [List the major changes made]
8-
-
9-
-
10+
-
11+
-
1012

1113
## Why These Changes Are Needed
14+
1215
[Explain why these changes are necessary]
1316

1417
## Testing Performed
18+
1519
- [Describe the testing performed to verify the changes]
16-
-
20+
-
1721

1822
## Screenshots
23+
1924
[If applicable]
2025

2126
## Additional Notes
27+
2228
[Any additional information that might be helpful for reviewers]

.github/workflows/pr-labeler.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
issue_number: context.issue.number,
2424
labels: ['do-not-merge', 'automated-build']
2525
})
26-
26+
2727
github.rest.issues.createComment({
2828
owner: context.repo.owner,
2929
repo: context.repo.repo,

.github/workflows/pr-validation.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@ name: PR Validation
22

33
on:
44
pull_request:
5-
branches: [ master ]
6-
types: [ opened, synchronize, reopened ]
5+
branches: [master]
6+
types: [opened, synchronize, reopened]
77

88
jobs:
99
validate:
1010
runs-on: ubuntu-latest
11-
11+
1212
steps:
1313
- uses: actions/checkout@v3
1414
with:
1515
fetch-depth: 0
16-
16+
1717
- name: Check for prohibited branch merges
1818
run: |
1919
# Check if the PR is from a branch that should not be merged
@@ -32,17 +32,17 @@ jobs:
3232
fi
3333
done < .github/.mergeignore
3434
fi
35-
35+
3636
- name: Check for merge conflicts
3737
run: |
3838
# Check if there would be merge conflicts with the target branch
3939
git config --global user.email "github-actions@github.com"
4040
git config --global user.name "GitHub Actions"
41-
41+
4242
echo "Checking for potential merge conflicts..."
4343
git checkout ${{ github.base_ref }}
4444
git pull
45-
45+
4646
# Try to merge without committing
4747
if git merge --no-commit --no-ff ${{ github.head_ref }}; then
4848
echo "✅ No merge conflicts detected"
@@ -60,12 +60,12 @@ jobs:
6060
# Don't fail the build, just warn
6161
exit 0
6262
fi
63-
63+
6464
- name: Validate documentation links
6565
if: success() || failure()
6666
run: |
6767
echo "Validating documentation links..."
68-
68+
6969
# Check for broken relative links in markdown files
7070
find . -name "*.md" -type f -exec grep -l "\[.*\](.*)" {} \; | while read file; do
7171
echo "Checking links in $file"

CODE_OF_CONDUCT.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ We pledge to act and interact in ways that contribute to an open, welcoming, div
1010

1111
Examples of behavior that contributes to creating a positive environment:
1212

13-
* Using welcoming and inclusive language
14-
* Being respectful of differing viewpoints and experiences
15-
* Gracefully accepting constructive criticism
16-
* Focusing on what is best for the community
17-
* Showing empathy towards other community members
13+
- Using welcoming and inclusive language
14+
- Being respectful of differing viewpoints and experiences
15+
- Gracefully accepting constructive criticism
16+
- Focusing on what is best for the community
17+
- Showing empathy towards other community members
1818

1919
Examples of unacceptable behavior:
2020

21-
* The use of sexualized language or imagery and unwelcome sexual attention or advances
22-
* Trolling, insulting/derogatory comments, and personal or political attacks
23-
* Public or private harassment
24-
* Publishing others' private information, such as a physical or email address, without explicit permission
25-
* Other conduct which could reasonably be considered inappropriate in a professional setting
21+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
22+
- Trolling, insulting/derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or email address, without explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
2626

2727
## Enforcement
2828

CONTRIBUTING.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,12 @@ Thank you for your interest in contributing to the Elmentor Landing Page project
2828
#### For Documentation, Templates, and Non-Website Changes
2929

3030
1. **Fork the repository** and create a branch from \main\ with an appropriate name:
31+
3132
- \ eature/description\ for features
3233
- \ugfix/description\ for bug fixes
3334
- \docs/description\ for documentation
34-
- \efactor/description\ for code refactoring
35+
- \
36+
efactor/description\ for code refactoring
3537

3638
2. **Make your changes** following coding standards and conventions.
3739

@@ -66,19 +68,19 @@ Thank you for your interest in contributing to the Elmentor Landing Page project
6668

6769
1. Clone the repository:
6870
`ash
69-
git clone https://github.com/DevOpsVisions/elmentor-landing-page-clean.git
70-
cd elmentor-landing-page-clean
71-
`
71+
git clone https://github.com/DevOpsVisions/elmentor-landing-page-clean.git
72+
cd elmentor-landing-page-clean
73+
`
7274

7375
2. Install dependencies:
7476
`ash
75-
npm install
76-
`
77+
npm install
78+
`
7779

7880
3. Start the development server:
7981
`ash
80-
npm run dev
81-
`
82+
npm run dev
83+
`
8284

8385
### Testing
8486

@@ -89,6 +91,7 @@ Thank you for your interest in contributing to the Elmentor Landing Page project
8991
## Style Guide
9092

9193
Please follow the DevOps Visions standards and conventions as outlined in:
94+
9295
- [Standards and Conventions](docs/devops-visions-guidance/standards-and-conventions.md)
9396
- [Naming Conventions](docs/devops-visions-guidance/naming-conventions.md)
9497
- [Repository Structure](docs/devops-visions-guidance/repository-structure.md)
@@ -100,8 +103,9 @@ Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing to thi
100103
## Questions?
101104

102105
If you have questions or need help, please:
106+
103107
1. Check the documentation in the \docs\ directory
104108
2. Open an issue with the question template
105109
3. Contact the maintainers through the DevOps Visions community channels
106110

107-
Thank you for contributing to the Elmentor Landing Page project!
111+
Thank you for contributing to the Elmentor Landing Page project!

0 commit comments

Comments
 (0)