mirror of
https://github.com/olehomelchenko/stat230-2025-portfolio-template.git
synced 2025-12-21 21:22:28 +00:00
move pages around
This commit is contained in:
113
docs/PUBLISHING.md
Normal file
113
docs/PUBLISHING.md
Normal file
@@ -0,0 +1,113 @@
|
||||
# Publishing Your Portfolio Online (Optional)
|
||||
|
||||
This guide shows you how to enable **GitHub Pages** to publish your portfolio online for free.
|
||||
|
||||
⚠️ **Remember:** Publishing online is **NOT required** and **NOT graded** for the course. You can get full points by submitting the ZIP archive. This is completely optional!
|
||||
|
||||
---
|
||||
|
||||
## Why Publish Online?
|
||||
|
||||
Once your portfolio is live on GitHub Pages, you can:
|
||||
- ✅ Share it with potential employers
|
||||
- ✅ Add the link to your CV/resume
|
||||
- ✅ Include it on your LinkedIn profile
|
||||
- ✅ Show it during job interviews
|
||||
- ✅ Share with friends and classmates
|
||||
|
||||
**Your portfolio will be available at:**
|
||||
```
|
||||
https://your-username.github.io/repository-name/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before enabling GitHub Pages:
|
||||
- ✅ Create a GitHub repository with your portfolio by copying this repository
|
||||
- ✅ Complete your portfolio (`index.html` and all assets)
|
||||
- ✅ Commit and push your changes to GitHub
|
||||
- ✅ Your repository must be **Public** (required for free GitHub Pages)
|
||||
|
||||
---
|
||||
|
||||
## Enabling GitHub Pages
|
||||
|
||||
**Time needed:** 2-3 minutes
|
||||
|
||||
### Step 1: Go to Your Repository Settings
|
||||
|
||||
1. **Go to GitHub** and navigate to your forked repository:
|
||||
```
|
||||
https://github.com/your-username/repository-name
|
||||
```
|
||||
|
||||
2. **Click** the "Settings" tab (top menu bar)
|
||||
|
||||
---
|
||||
|
||||
### Step 2: Configure GitHub Pages
|
||||
|
||||
1. **In the left sidebar**, click **"Pages"**
|
||||
- Look under the "Code and automation" section
|
||||
|
||||
2. **Under "Source":**
|
||||
- Select **"Deploy from a branch"**
|
||||
|
||||
3. **Under "Branch":**
|
||||
- Select **`main`** from the dropdown
|
||||
- Select **`/ (root)`** from the folder dropdown
|
||||
|
||||
4. **Click "Save"**
|
||||
|
||||
---
|
||||
|
||||
### Step 3: Wait for Deployment
|
||||
|
||||
1. **Wait 1-2 minutes** for GitHub to build and deploy your site
|
||||
|
||||
2. **Refresh the page**
|
||||
|
||||
3. You'll see a message at the top:
|
||||
```
|
||||
Your site is live at https://your-username.github.io/repository-name/
|
||||
```
|
||||
|
||||
4. **Click the link** to view your live portfolio!
|
||||
|
||||
---
|
||||
|
||||
## That's It!
|
||||
|
||||
Your portfolio is now published online. Every time you push changes to GitHub, your site will automatically update in 1-2 minutes.
|
||||
|
||||
---
|
||||
|
||||
## Updating Your Published Portfolio
|
||||
|
||||
After you make changes locally:
|
||||
|
||||
1. **Commit your changes** in GitHub Desktop or via command line
|
||||
2. **Push to GitHub**
|
||||
3. **Wait 1-2 minutes** - GitHub Pages will automatically rebuild
|
||||
4. **Refresh your portfolio URL** to see the updates
|
||||
|
||||
**No need to touch the Pages settings again!** It's all automatic after the initial setup.
|
||||
|
||||
---
|
||||
|
||||
## ❓ Questions?
|
||||
|
||||
If you're having trouble with GitHub Pages:
|
||||
|
||||
1. **Ask in course Slack channel** - classmates might have solved the same issue
|
||||
2. **Contact instructor:** Oleh Omelchenko
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 📚 Additional Resources
|
||||
|
||||
- [GitHub Pages Documentation](https://docs.github.com/en/pages)
|
||||
- [GitHub Pages Deployment Guide](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)
|
||||
Reference in New Issue
Block a user