Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,49 @@
---
name: Bug report
about: Create a report to help us improve
title: '[BUG] '
labels: 'bug'
assignees: ''
title: "[BUG] "
labels: "bug"
assignees: ""
---

## Bug Description

A clear and concise description of what the bug is.

## Steps To Reproduce

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Expected Behavior

A clear and concise description of what you expected to happen.

## Actual Behavior

A clear and concise description of what actually happened.

## Screenshots

If applicable, add screenshots to help explain your problem.

## Environment

- OS: [e.g. Windows, macOS, Linux]
- Browser: [e.g. Chrome, Safari, Firefox]
- Version: [e.g. 22]

## 🚨 WEBSITE SAFETY CHECK 🚨

Please confirm the following to ensure website functionality is preserved:

- [ ] This bug report DOES NOT suggest changes to the website code in the \src/\ directory
- [ ] This bug report DOES NOT suggest changes to the static assets in \public/\ directory
- [ ] This bug report DOES NOT affect the build configuration
- [ ] This bug report DOES NOT affect deployment scripts
- [ ] This bug report DOES NOT affect deployment scripts

## Additional Context

Add any other context about the problem here.
13 changes: 9 additions & 4 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,36 @@
---
name: Documentation improvement
about: Suggest improvements to our documentation
title: '[DOCS] '
labels: 'documentation'
assignees: ''
title: "[DOCS] "
labels: "documentation"
assignees: ""
---

## Documentation Issue

A clear and concise description of what's wrong or missing in the current documentation.

## Suggested Improvement

A clear and concise description of how you think the documentation should be improved.

## Where This Documentation Should Appear

- [ ] README.md
- [ ] CONTRIBUTING.md
- [ ] CODE_OF_CONDUCT.md
- [ ] docs/ directory
- [ ] Other: (please specify)

## 🚨 WEBSITE SAFETY CHECK 🚨

Please confirm the following to ensure website functionality is preserved:

- [ ] This documentation improvement DOES NOT involve modifying website code in the \src/\ directory
- [ ] This documentation improvement DOES NOT involve modifying static assets in \public/\ directory
- [ ] This documentation improvement DOES NOT involve modifying static assets in \public/\ directory
- [ ] This documentation improvement DOES NOT affect the build configuration
- [ ] This documentation improvement DOES NOT affect deployment scripts

## Additional Context

Add any other context or screenshots about the documentation improvement here.
13 changes: 9 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,34 @@
---
name: Feature request
about: Suggest an idea for this project
title: '[FEATURE] '
labels: 'enhancement'
assignees: ''
title: "[FEATURE] "
labels: "enhancement"
assignees: ""
---

## Problem Statement

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

## Proposed Solution

A clear and concise description of what you want to happen.

## Alternatives Considered

A clear and concise description of any alternative solutions or features you've considered.

## 🚨 WEBSITE SAFETY CHECK 🚨

Please confirm the following to ensure website functionality is preserved:

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

*If your feature does require website changes, please discuss with maintainers first.*
_If your feature does require website changes, please discuss with maintainers first._

## Additional Context

Add any other context or screenshots about the feature request here.
13 changes: 9 additions & 4 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,34 @@
---
name: Question
about: Ask a question about this project
title: '[QUESTION] '
labels: 'question'
assignees: ''
title: "[QUESTION] "
labels: "question"
assignees: ""
---

## Question

A clear and concise description of your question.

## Context

Add any context that might help us answer your question.

## What I've Tried Already

Explain what you've already tried or what research you've already done.

## 🚨 WEBSITE SAFETY CHECK 🚨

Please confirm the following to ensure website functionality is preserved:

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

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

## Additional Information

Any additional information that might be helpful.
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Documentation Reorganization

## Description

This PR reorganizes the project documentation to improve maintainability and clarity.

## Changes Made

- Created structured documentation directories:
- `/docs/deployment/` - Deployment-related documentation
- `/docs/development/` - Development guidelines and standards
Expand All @@ -18,18 +20,23 @@ This PR reorganizes the project documentation to improve maintainability and cla
- Moved legacy/outdated documentation to a separate directory

## Why These Changes Are Needed

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:

1. Find specific documentation
2. Maintain documentation as the project evolves
3. Onboard new developers quickly

## Testing Performed

- Verified all documentation links are working
- Checked for consistent formatting
- Ensured no information was lost in the consolidation

## Screenshots

[If applicable]

## Additional Notes

The `gh-pages` branch remains unchanged as it contains only the compiled website files.
12 changes: 9 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,28 @@
# Pull Request

## Description

[Provide a brief description of the changes made in this PR]

## Changes Made

- [List the major changes made]
-
-
-
-

## Why These Changes Are Needed

[Explain why these changes are necessary]

## Testing Performed

- [Describe the testing performed to verify the changes]
-
-

## Screenshots

[If applicable]

## Additional Notes

[Any additional information that might be helpful for reviewers]
2 changes: 1 addition & 1 deletion .github/workflows/pr-labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
issue_number: context.issue.number,
labels: ['do-not-merge', 'automated-build']
})

github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
Expand Down
18 changes: 9 additions & 9 deletions .github/workflows/pr-validation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@ name: PR Validation

on:
pull_request:
branches: [ master ]
types: [ opened, synchronize, reopened ]
branches: [master]
types: [opened, synchronize, reopened]

jobs:
validate:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Check for prohibited branch merges
run: |
# Check if the PR is from a branch that should not be merged
Expand All @@ -32,17 +32,17 @@ jobs:
fi
done < .github/.mergeignore
fi

- name: Check for merge conflicts
run: |
# Check if there would be merge conflicts with the target branch
git config --global user.email "github-actions@github.com"
git config --global user.name "GitHub Actions"

echo "Checking for potential merge conflicts..."
git checkout ${{ github.base_ref }}
git pull

# Try to merge without committing
if git merge --no-commit --no-ff ${{ github.head_ref }}; then
echo "✅ No merge conflicts detected"
Expand All @@ -60,12 +60,12 @@ jobs:
# Don't fail the build, just warn
exit 0
fi

- name: Validate documentation links
if: success() || failure()
run: |
echo "Validating documentation links..."

# Check for broken relative links in markdown files
find . -name "*.md" -type f -exec grep -l "\[.*\](.*)" {} \; | while read file; do
echo "Checking links in $file"
Expand Down
20 changes: 10 additions & 10 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ We pledge to act and interact in ways that contribute to an open, welcoming, div

Examples of behavior that contributes to creating a positive environment:

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

Examples of unacceptable behavior:

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

## Enforcement

Expand Down
22 changes: 13 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@ Thank you for your interest in contributing to the Elmentor Landing Page project
#### For Documentation, Templates, and Non-Website Changes

1. **Fork the repository** and create a branch from \main\ with an appropriate name:

- \ eature/description\ for features
- \ugfix/description\ for bug fixes
- \docs/description\ for documentation
- \efactor/description\ for code refactoring
- \
efactor/description\ for code refactoring

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

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

1. Clone the repository:
`ash
git clone https://github.com/DevOpsVisions/elmentor-landing-page-clean.git
cd elmentor-landing-page-clean
`
git clone https://github.com/DevOpsVisions/elmentor-landing-page-clean.git
cd elmentor-landing-page-clean
`

2. Install dependencies:
`ash
npm install
`
npm install
`

3. Start the development server:
`ash
npm run dev
`
npm run dev
`

### Testing

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

Please follow the DevOps Visions standards and conventions as outlined in:

- [Standards and Conventions](docs/devops-visions-guidance/standards-and-conventions.md)
- [Naming Conventions](docs/devops-visions-guidance/naming-conventions.md)
- [Repository Structure](docs/devops-visions-guidance/repository-structure.md)
Expand All @@ -100,8 +103,9 @@ Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing to thi
## Questions?

If you have questions or need help, please:

1. Check the documentation in the \docs\ directory
2. Open an issue with the question template
3. Contact the maintainers through the DevOps Visions community channels

Thank you for contributing to the Elmentor Landing Page project!
Thank you for contributing to the Elmentor Landing Page project!
Loading
Loading