You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Added proper instructions in personal webpages (alshedivat#261)
* Added proper instructions in personal webpages
Changed "For personal and organization webpages" part, tried to be as concise as possible, in accordance with: alshedivat#209 (comment)
* Update README.md
* Update README.md
Co-authored-by: Maruan <alshedivat@users.noreply.github.com>
Copy file name to clipboardExpand all lines: README.md
+10-3
Original file line number
Diff line number
Diff line change
@@ -123,10 +123,15 @@ Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0
123
123
- The `master` branch should be used for the source code of your webpage and `gh-pages` branch (will be created on the first deployment) will be used for deployment.
124
124
125
125
**For personal and organization webpages:**
126
-
- Make sure you correctly named your repository as `<your-github-username>.github.io` or `<your-github-orgname>.github.io`.
127
-
- After cloning this repository, [rename the branch](https://docs.github.com/en/github/administering-a-repository/renaming-a-branch) with the source code from `master` to `source`.
126
+
- Rename your repository to `<your-github-username>.github.io` or `<your-github-orgname>.github.io`.
127
+
- Click on **Actions** tab and **Enable GitHub Actions**; you no need to worry about creating any workflows as everything has already been set for you.
128
+
- In the **Settings**, select **Branches** and [rename the branch](https://docs.github.com/en/github/administering-a-repository/renaming-a-branch) with the source code from `master` to `source`. From now on, this will be your default branch. Any changes you make should be committed and pushed to this branch.
128
129
- Make sure the `url` and `baseurl` fields in `_config.yml` are empty.
129
-
- Make changes, commit, and push!
130
+
- Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action.
131
+
- Wait for a few minutes and let the action complete. You can see the progress in the **Actions** tab. If completed successfully, in addition to the `source` branch, your repository should now have a newly built `master` branch.
132
+
- Finally, again in the **Settings**, in the Pages section, set the branch to `master` (**NOT** to `source`).
133
+
134
+
**NOTE**: you **must** do all your changes in the `source` branch (the one you used to push) **NOT the master** one; this last one is used for **deploying** by Github Pages and it is not suitable for pushing changes.
130
135
131
136
<details><summary><strong>Manual deployment to GitHub Pages:</strong></summary>
132
137
@@ -211,6 +216,8 @@ If you have a different question, please ask using [Discussions](https://github.
211
216
Isn't the website supposed to correctly deploy automatically? <br>
212
217
**A:** Yes, if you are using release `v0.3.5` or later, the website will automatically and correctly re-deploy right after your first commit.
213
218
Please make some changes (e.g., change your website info in `_config.yml`), commit, and push.
219
+
Make sure to follow [deployment instructions](https://github.com/alshedivat/al-folio#deployment) in the previous section.
0 commit comments