Skip to content

[Issue 2142] Clarify deployment folder generalized deploying file #2355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

daaimah123
Copy link
Collaborator

@daaimah123 daaimah123 commented May 20, 2025

📝 Description

This PR updates the deploying.md file to be platform-agnostic, removing Heroku-specific content and creating a more general deployment guide. The existing Heroku-specific content remains in deploying-to-heroku.md, while the main deployment document now covers universal deployment concepts applicable across different hosting platforms.

🔂 Changes Made

  • Rewrote deploying.md to focus on platform-agnostic deployment concepts
  • Renamed deploying.md to general-project-deploying.md
  • Removed Heroku-specific references from the main deployment guide
  • Added sections on deployment environments, CI/CD, and configuration management
  • Expanded the "Common Challenges" and "Supplemental Resources" sections
  • Added links to platform-specific guides (including the existing Heroku guide)
  • Updated prerequisites to be more general and applicable to various deployment scenarios

⚙️ Related Issue

Issue Number: #2142

🍏 Type of Change

Topic Outline Update

🎁 Acceptance Criteria

  • Content is platform-agnostic and applicable to various deployment scenarios
  • Clear separation between general deployment concepts and platform-specific instructions
  • Comprehensive coverage of deployment fundamentals (environments, configuration, monitoring)
  • Maintains educational value for participants with different technology stacks
  • Links appropriately to platform-specific guides for detailed implementation steps

🧪 How to test or what to evaluate

  1. Review general-project-deploying.md file to ensure it contains no platform-specific instructions
  2. Verify that all deployment concepts are explained in a general way applicable to various platforms
  3. Check that links to platform-specific guides (including Heroku) are properly referenced
  4. Ensure the content follows the curriculum's standard format (Projected Time, Prerequisites, etc.)
  5. Validate that the learning objectives and specific things to learn align with the updated content

@daaimah123 daaimah123 self-assigned this May 20, 2025
@daaimah123 daaimah123 marked this pull request as ready for review May 20, 2025 23:16
@daaimah123 daaimah123 linked an issue May 20, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Deploying Folder Has Duplicate Deploying Files
1 participant