From 968a9806879508b0a9b24a8c95dfb02299fe1276 Mon Sep 17 00:00:00 2001 From: Ger Teck Date: Tue, 2 Jul 2024 13:20:49 +0800 Subject: [PATCH 1/2] Update sample work flow file in UG (#2556) * Add minute documentation changes * Update docs * Add info box * Reposition info box * Undo list autoformat * Add info Add notice to enable github pages on first deployment * Reposition enable github pages --- docs/userGuide/deployingTheSite.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/userGuide/deployingTheSite.md b/docs/userGuide/deployingTheSite.md index 4e7a3a65d0..c90cfb76b1 100644 --- a/docs/userGuide/deployingTheSite.md +++ b/docs/userGuide/deployingTheSite.md @@ -38,12 +38,15 @@ **MarkBind can easily deploy a site to [GitHub pages](https://help.github.com/categories/github-pages-basics/)** if the project root directory is also a GitHub repo. + + +This documentation currently uses `master` as the default branch name. If your repository uses `main` as the default branch, you will need to update the references to `master` accordingly. For instance, when specifying the branch for deployment, replace instances of `master` with `main` to match your repository's configuration. + + ### Using the `markbind deploy` command Running the **`markbind deploy`** command will deploy the most recent build of your site to the `gh-pages` branch of the repo `origin` and will be available. -Then, navigate to the `Settings > Pages` section on GitHub for that repository and set the source to the root of the `gh-pages` branch. You can read [this source](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site) on GitHub Pages for more details. - Your site will be online at `http://.github.io/` (e.g., http://se-edu.github.io/se-book).
@@ -102,6 +105,8 @@ jobs: build: runs-on: ubuntu-latest name: test + permissions: + contents: write env: GITHUB_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} steps: @@ -118,7 +123,11 @@ jobs: The sample `deploy.yml` workflow above uses the [default GitHub Token secret](https://docs.github.com/en/actions/reference/authentication-in-a-workflow) that is generated automatically for each GitHub Actions workflow. You may also use a [GitHub Personal Access Token](#generating-a-github-personal-access-token) in place of the default GitHub Token. -Once you have created the file, commit and push the file to your repo. GitHub Actions should start to build and deploy your MarkBind site. You can verify this by visiting `www.github.com///actions`. +Once you have created the file, commit and push the file to your repo. + +Then, navigate to the `Settings > Pages` section on GitHub for that repository and set the source to the root of the `gh-pages` branch. You can read [this source](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site) on GitHub Pages for more details. + +GitHub Actions should start to build and deploy your MarkBind site. You can verify this by visiting `www.github.com///actions`. From 6654e37f914312efd2350f974c0c94a7d4862b7b Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Wed, 3 Jul 2024 22:26:52 +0800 Subject: [PATCH 2/2] add gerteck as a contributor for code, and doc (#2560) --- .all-contributorsrc | 10 ++++++++++ README.md | 1 + docs/about.md | 1 + 3 files changed, 12 insertions(+) diff --git a/.all-contributorsrc b/.all-contributorsrc index 1aff82b44f..8c179935b1 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -744,6 +744,16 @@ "contributions": [ "code" ] + }, + { + "login": "gerteck", + "name": "Ger Teck", + "avatar_url": "https://avatars.githubusercontent.com/u/111064611?v=4", + "profile": "http://www.linkedin.com/in/gerteck", + "contributions": [ + "code", + "doc" + ] } ], "contributorsPerLine": 7, diff --git a/README.md b/README.md index 7780b308e0..12a5c1d124 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d Lam Jiu Fong
Lam Jiu Fong
💻 Wang Yiwen
Wang Yiwen
📖 💻 Ashleeey1224
Ashleeey1224
💻 + Ger Teck
Ger Teck
💻 📖 diff --git a/docs/about.md b/docs/about.md index 2d30dd73aa..07b90a59b1 100644 --- a/docs/about.md +++ b/docs/about.md @@ -138,6 +138,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d Lam Jiu Fong
Lam Jiu Fong
💻 Wang Yiwen
Wang Yiwen
📖 💻 Ashleeey1224
Ashleeey1224
💻 + Ger Teck
Ger Teck
💻 📖