silva
/
new_site
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Correct the documentation for personal/organization and manual deployments (#351)

This commit is contained in:
Neeraj Gangwar 2021-07-18 20:57:16 +05:30 committed by GitHub
parent 4d5f2dccff
commit 8fe464d30a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -127,18 +127,16 @@ Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0
- 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. - 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.
- Make sure the `url` and `baseurl` fields in `_config.yml` are empty. - Make sure the `url` and `baseurl` fields in `_config.yml` are empty.
- Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action. - Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action.
- 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. - 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 `master` branch, your repository should now have a newly built `gh-pages` branch.
- Finally, in the **Settings**, in the Pages section, set the branch to `gh-pages` (**NOT** to `master`). - Finally, in the **Settings**, in the Pages section, set the branch to `gh-pages` (**NOT** to `master`). See [Configuring a publishing source for your GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source) for more details.
<details><summary><strong>Manual deployment to GitHub Pages:</strong></summary> <details><summary><strong>Manual deployment to GitHub Pages:</strong></summary>
If you need to manually re-deploy your website to GitHub pages, run the deploy script from the root directory of your repository: If you need to manually re-deploy your website to GitHub pages, run the deploy script from the root directory of your repository:
```bash ```bash
$ ./bin/deploy [--user] $ ./bin/deploy
``` ```
uses the `master` branch for the source code and deploys the webpage to `gh-pages`. uses the `master` branch for the source code and deploys the webpage to `gh-pages`.
The optional flag `--user` tells it to deploy to `master` and use `source` for the source code instead.
Using `master` for deployment is a convention for [user and organization pages](https://help.github.com/articles/user-organization-and-project-pages/).
</details> </details>