From 8fe464d30a610ba89219d8de32fc218c1bb713f6 Mon Sep 17 00:00:00 2001 From: Neeraj Gangwar <553989+neerajgangwar@users.noreply.github.com> Date: Sun, 18 Jul 2021 20:57:16 +0530 Subject: [PATCH] Correct the documentation for personal/organization and manual deployments (#351) --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4a1276a689ae..8871557aba3d 100644 --- a/README.md +++ b/README.md @@ -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. - 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. -- 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. -- Finally, in the **Settings**, in the Pages section, set the branch to `gh-pages` (**NOT** to `master`). +- 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`). 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.
Manual deployment to GitHub Pages: If you need to manually re-deploy your website to GitHub pages, run the deploy script from the root directory of your repository: ```bash -$ ./bin/deploy [--user] +$ ./bin/deploy ``` 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/).