Skip to content

Commit f8c5bfd

Browse files
committed
Update the build settings due to the structure update
1 parent 07ede4e commit f8c5bfd

File tree

4 files changed

+12
-11
lines changed

4 files changed

+12
-11
lines changed

.github/workflows/gh-pages.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,16 @@ jobs:
5050
run: git config --global url."https://${{ env.GH_USER }}:${{ secrets.GH_PAT }}@github.com".insteadOf "https://github.com"
5151

5252
- name: Install Dependencies
53-
working-directory: _hugo-site
53+
working-directory: site
5454
run: npm ci
5555

5656
- name: Build Spine
57-
working-directory: _hugo-site
57+
working-directory: site
5858
run: hugo --minify
5959

6060
- name: Deploy
6161
uses: peaceiris/actions-gh-pages@v4
6262
with:
6363
github_token: ${{ secrets.GITHUB_TOKEN }}
6464
publish_branch: gh-pages
65-
publish_dir: ./_hugo-site/public
65+
publish_dir: ./site/public

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ please see the [`_code/EMBEDDING.md`](_code/EMBEDDING.md) file.
2424
4. Get access to the [`site-commons`][site-commons] repository from the admins
2525
to be able to download the theme.
2626
5. Make sure SSH is configured correctly and the passphrase is stored in the keychain.
27-
6. Install project dependencies from the `_hugo-site` directory by running `npm install`.
27+
6. Install project dependencies from the `site` directory by running `npm install`.
2828

2929
## Running the site locally
3030

@@ -54,9 +54,9 @@ Hugo site has been set up for it. All the contents and links in it are working a
5454
It allows making changes to it more convenient for authors.
5555

5656
In terms of building the “main” site, the [Hugo Modules][hugo-modules]
57-
are used to embed the contents.
57+
are used to embed the content.
5858

59-
### Steps to get updates
59+
### Steps to get documentation updates
6060

6161
1. Clean the module cache:
6262

@@ -67,17 +67,18 @@ are used to embed the contents.
6767
2. Get the documentation Hugo Module:
6868

6969
```shell
70-
hugo mod get -u github.com/SpineEventEngine/documentation/_hugo-theme
70+
hugo mod get -u github.com/SpineEventEngine/documentation/docs
7171
```
7272

7373
3. Commit and push changes from `go.mod` and `go.sum` files.
7474
In the `go.sum` file keep only two last records to avoid file cluttering.
7575

7676
## Common theme
7777

78-
This project uses the [`site-commons`][site-commons] Hugo theme.
78+
This project uses the [`site-commons`][site-commons] Hugo theme for general components such
79+
as anchor icons, snackbars, etc.
7980

80-
1. To get theme updates:
81+
1. To get theme updates, run:
8182

8283
```shell
8384
hugo mod get -u github.com/TeamDev-Ltd/site-commons

_script/hugo-build

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,5 @@ elif [ -f ${BASH_RC} ]; then
3737
. ${BASH_RC}
3838
fi
3939

40-
cd _hugo-site
40+
cd site
4141
hugo

_script/hugo-serve

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,5 @@ elif [ -f ${BASH_RC} ]; then
3737
. ${BASH_RC}
3838
fi
3939

40-
cd _hugo-site
40+
cd site
4141
hugo server

0 commit comments

Comments
 (0)