Skip to content

Commit 3f270e7

Browse files
authored
Docs site build fixes (#50)
* update workflow * update build workflow * docs build error fixes * workflow update * Trigger GitHub Actions
1 parent bf8596d commit 3f270e7

File tree

7 files changed

+19
-11
lines changed

7 files changed

+19
-11
lines changed

.github/workflows/BuildMKDocsAndPublishToGithubPages.yml

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 📖 Build MKDocs And Publish To Github Pages.yml
1+
name: BuildMKDocsAndPublishToGithubPages.yml
22
on:
33
push:
44
branches:
@@ -11,12 +11,16 @@ jobs:
1111
name: Deploy docs
1212
runs-on: ubuntu-latest
1313
steps:
14-
- name: Install dependencies
15-
uses: BSFishy/pip-action@v1
16-
with:
17-
packages: |
18-
mkdocs-material
19-
qrcode
14+
- name: Upgrade pip and install dependencies
15+
run: |
16+
python -m pip install --upgrade pip
17+
pip install -r requirements.txt
18+
# - name: Install dependencies
19+
# uses: BSFishy/pip-action@v1
20+
# with:
21+
# packages: |
22+
# mkdocs-material
23+
# qrcode
2024
- name: Checkout main from github
2125
uses: actions/checkout@v1
2226
- name: Create Mkdocs Config 🚀

docs/mkdocs-base.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,10 @@ nav:
8787
- Source Reference: user/manual/source-reference-page.md
8888
- User Profile: user/manual/user-profile.md
8989
- Feedback Form: user/manual/feedback-form.md
90+
- Add Biodiversity Data: user/manual/add-biodiversity-data.md
91+
- Biodiversity Dashboard: user/manual/biodiversity-dashboard.md
92+
- Pesticide Dashboard: user/manual/pesticide-dashboard.md
93+
- Map Interface: user/manual/map.md
9094
- Administrators:
9195
- administrator/index.md
9296
- Biodiversity Data:
File renamed without changes.

docs/src/user/manual/landing-page.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ FBIS collaborates with various organisations to advance its platform and achieve
157157

158158
3. **Map:** The `Map` link navigates to the [map page](./map.md).
159159

160-
4. **Documents & Reports:** `Documents & Reports` link navigates to the [Source References page](./source-references.md).
160+
4. **Documents & Reports:** `Documents & Reports` link navigates to the [Source References page](./source-reference-page.md).
161161

162162
5. **Contact:** The `CONTACT` navigation link navigates to the [contact page](contact.md) where the BIMS team is ready to assist with any inquiries or issues.
163163

@@ -191,7 +191,7 @@ After logging in, the users will see the following window with a notice.
191191

192192
5. **Citation:** The `CITATION` navigation link provides access to the [citation page](citation.md).
193193

194-
6. **Source References:** The `Source References` link navigates to the [source references page](./source-references-page.md).
194+
6. **Source References:** The `Source References` link navigates to the [source references page](./source-reference-page.md).
195195

196196
7. **User Profile:** The `User Profile` link navigates to the [user profile page](./user-profile.md).
197197

docs/src/user/manual/map.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ license: This program is free software; you can redistribute it and/or modify it
106106

107107
- **Add:** This button allows users to add new biodiversity data to the site for the corresponding species. This will redirect the users to the new page where they can add the data. For more information on how to add the biodiversity data click [here](./add-biodiversity-data.md).
108108

109-
- **Dashboard:** This button provides users with access to the species dashboard for detailed insights. For more information about how to access the dashboard click [here](./dashboard.md).
109+
- **Biodiversity Dashboard:** This button provides users with access to the species dashboard for detailed insights. For more information about how to access the dashboard click [here](./biodiversity-dashboard.md).
110110

111111
- **SASS Dashboard:** Allows users to access the sass dashboard.
112112

File renamed without changes.

docs/src/user/manual/source-reference-page.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ The arrows indicate that the results include the applied filter.
140140

141141
9. **Add new author:** Users can add a new author by clicking on the Add New Author button. Upon clicking, a new input field will appear where users can enter the author's name. Simply type the name and press Enter to add the author.
142142

143-
* When adding a new author, users must follow this format for the author's name: [First Name] [Space] [Last Name] (e.g., John Smith).
143+
* When adding a new author, users must follow this format for the author's name: [First Name] `"Space"` [Last Name] (e.g., John Smith).
144144

145145
[![Add New Author](./img/source-ref-img-17.png)](./img/source-ref-img-17.png)
146146

0 commit comments

Comments
 (0)