Skip to content

Commit

Permalink
Move from mkdocs to docusaurus (#80)
Browse files Browse the repository at this point in the history
* Trial update

* Adding initial .txt files of technologies

Proposing to change terminology from climate adaptation to climate resilience

* Delete docs/climate-adaptation/Mobile-tools.txt

* renaming and reformatting AI.txt to ai.md

* rename and reformat RMIS.txt to rmis-cres.md

* rename and reformat IoT.txt to iot.md

* rename and reformat EoT.txt to eot.md

* rename and reformat Digital-twins.txt to digital-twins.md

* rename and reformat Data-sources.txt to data-sources.md

* reformat and rename Communication-collaboration.txt to communication.md

* Update structure in  ai.md

* Update structure in communication.md

* Update structure in data-sources.md

* Update structure in digital-twins.md

* Update structure in eot.md

* Update structure in iot.md

* Update structure in mobile-tools.md

* Update structure in rmis-cres.md

* New subfolder for introductory texts

* Create subfolder for cres fact sheets

* moving bim.md

* moving bim.md

* moving ai.md

* moving communication.md

* moving data-sources.md

* moving digital-twins.md

* moving eot.md

* moving iot.md

* moving mobile-tools.md

* moving rmis-cres.md

* Creating solutions-resilience.md

* Creating opportunities.md

* Creating challenges.md

* Updating main index.md in climate adaptation folder

* Correcting folder dependency in main index.md of climate-adaptation folder

* Updating dependencies in main index.md of climate-adaptation folder

* Correcting file naming in index.md

* Adding licence to Index.md

* Adding license to challenges.md

* Adding license to opportunities.md

* Adding license to solutions-resilience.md

* Adding license to Index.md

* moving bim.md

* Updating mkdocs.yml to include subfolders of climate-adaptation

* Updating index.md

* Remove comments in main index.md of climate adaptation folder

* Update ai.md to add integration section

* Update communication.md with integration section

* Update data-sources.md with integration section

* Update digital-twins.md with integration section

* Update eot.md with integration section

* Update iot.md with integration section

* Update mobile-tools.md with integration section

* Update rmis-cres.md with integration section

* Update communication.md with integration section

* removing intro text from ai.md

* removing intro text from communication.md

* removing intro text from data-sources.md

* removing intro text from digital-twins.md

* remove intro text from eot.md

* remove intro text from iot.md

* remove intro text from mobile-tools.md

* remove intro text from rmis-cres.md

* checking branch location

* Changing folder name to climate-resilience, updating mkdocs to page structure, updatind climate-resilience intro text and adding integration subpage.

* Updating intro to climate resilience

* First step to set-up docusaurus

* More cleaning on docusaurus

* Make it work relatively well.

* Ready for deployment

* Update index.tsx

* No yarn

* Make it possible to compile

* Get the icons on the index right

* Use the proper links

* Update the admonition syntax

* A bit of cleaning for the PR

---------

Co-authored-by: Lionel Muñoz Rosas <[email protected]>
Co-authored-by: fredgeo23 <[email protected]>
Co-authored-by: Lionel Antonio Muñoz Rosas <[email protected]>
  • Loading branch information
4 people authored Jan 9, 2025
1 parent d5042cc commit e637b10
Show file tree
Hide file tree
Showing 94 changed files with 19,518 additions and 1,229 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ A clear and concise description of what you want to happen.
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
Add any other context or screenshots about the feature request here.
51 changes: 51 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
build:
name: Build Docusaurus
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
cache: npm

- name: Install dependencies
run: npm install
- name: Build website
run: npm run build

- name: Upload Build Artifact
uses: actions/upload-pages-artifact@v3
with:
path: build

deploy:
name: Deploy to GitHub Pages
needs: build

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
19 changes: 0 additions & 19 deletions .github/workflows/mkdocs.yml

This file was deleted.

26 changes: 26 additions & 0 deletions .github/workflows/test_deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Test deployment

on:
pull_request:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
test-deploy:
name: Test deployment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
cache: npm

- name: Install dependencies
run: npm install
- name: Test build website
run: npm run build
24 changes: 0 additions & 24 deletions .github/workflows/valid_mkdocs.yml

This file was deleted.

23 changes: 22 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,22 @@
*.DS_Store
*.DS_Store

# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
6 changes: 4 additions & 2 deletions docs/climate-resilience/Introduction/challenges.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ comments: true

# Challenges and limitations of urban digital solutions

!!! info inline end "Work in progress"
:::info[Work in progress]

This fact sheet is still being finalized. Soon you will will be able to read about the challenges and limitations of urban digital solutions.
This section is still being finalized. Soon you will will be able to read more about the use of digital tools for urban resilience.
:::

***Text in progress***

## Licence

![](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)

This work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0)](https://creativecommons.org/licenses/by-nc-sa/4.0/).
Expand Down
8 changes: 5 additions & 3 deletions docs/climate-resilience/Introduction/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ comments: true

# Introduction to urban resilience

!!! info inline end "Work in progress"
:::info[Work in progress]

This page is still being finalized. Soon you will will be able to read about urban resilience.
This section is still being finalized. Soon you will will be able to read more about the use of digital tools for urban resilience.
:::

***Text in progress***

Expand All @@ -15,8 +16,9 @@ comments: true
***Text in progress***

## Licence

![](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)

This work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0)](https://creativecommons.org/licenses/by-nc-sa/4.0/).

[Disclaimer](../../disclaimer.md)
[Disclaimer](../../disclaimer.md)
8 changes: 5 additions & 3 deletions docs/climate-resilience/Introduction/opportunities.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@
comments: true
---

# Opportunities
# Opportunities

!!! info inline end "Work in progress"
:::info[Work in progress]

This fact sheet is still being finalized. Soon you will will be able to read about the opportunities of digital tools for urban resilience.
This section is still being finalized. Soon you will will be able to read more about the use of digital tools for urban resilience.

:::

***Text in progress***

Expand Down
7 changes: 5 additions & 2 deletions docs/climate-resilience/Introduction/solutions-resilience.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ comments: true

# Digital solutions for building urban resilience

!!! info inline end "Work in progress"
:::info[Work in progress]

This fact sheet is still being finalized. Soon you will will be able to read about Digital solutions for building urban resilience.
This section is still being finalized. Soon you will will be able to read more about the use of digital tools for urban resilience.

:::

***Text in progress***

Expand All @@ -15,6 +17,7 @@ comments: true
***Text in progress***

## Licence

![](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)

This work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0)](https://creativecommons.org/licenses/by-nc-sa/4.0/).
Expand Down
12 changes: 10 additions & 2 deletions docs/climate-resilience/fact-sheets-cres/ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ comments: true

# Artificial Intelligence (AI)

!!! info inline end "Work in progress"
:::info[Work in progress]

This fact sheet is still being finalized. Soon you will will be able to read about the use of AI for urban resilience.
This section is still being finalized. Soon you will will be able to read more about the use of digital tools for urban resilience.

:::

## Short overview

Expand Down Expand Up @@ -82,6 +84,11 @@ comments: true

***Text in progress***

### Requirements

***Text in progress***

### Integration with other technologies
## Legal Aspects

***Text in progress***
Expand All @@ -104,6 +111,7 @@ comments: true

***Text in progress***

## Legal Aspects
## Project Examples/ Use Cases

***Text in progress***
Expand Down
15 changes: 11 additions & 4 deletions docs/climate-resilience/fact-sheets-cres/communication.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ comments: true

# Communication and collaboration tools

!!! info inline end "Work in progress"
:::info[Work in progress]

This fact sheet is still being finalized. Soon you will will be able to read about the use of Communication and collaboration tools for urban resilience.
This section is still being finalized. Soon you will will be able to read more about the use of digital tools for urban resilience.

:::

## Short overview

Expand Down Expand Up @@ -58,7 +60,7 @@ comments: true

## Application in DRM/ CCA measures

### Nature-based Solutions
### Nature-based solutions

***Text in progress***

Expand All @@ -82,6 +84,11 @@ comments: true

***Text in progress***

### Requirements

***Text in progress***

### Integration with other technologies
## Legal Aspects

***Text in progress***
Expand Down Expand Up @@ -115,7 +122,7 @@ comments: true
## Linkages to other Tool Types

***Text in progress***

## Licence

![](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)
Expand Down
14 changes: 11 additions & 3 deletions docs/climate-resilience/fact-sheets-cres/data-sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ comments: true

# Data sources

!!! info inline end "Work in progress"
:::info[Work in progress]

This fact sheet is still being finalized. Soon you will will be able to read about the use of Data sources for urban resilience.
This section is still being finalized. Soon you will will be able to read more about the use of digital tools for urban resilience.

:::

## Short overview

Expand Down Expand Up @@ -58,7 +60,7 @@ comments: true

## Application in DRM/ CCA measures

### Nature-based Solutions
### Nature-based solutions

***Text in progress***

Expand All @@ -82,6 +84,11 @@ comments: true

***Text in progress***

### Requirements

***Text in progress***

### Integration with other technologies
## Legal Aspects

***Text in progress***
Expand Down Expand Up @@ -117,6 +124,7 @@ comments: true
***Text in progress***

## Licence

![](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)

This work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0)](https://creativecommons.org/licenses/by-nc-sa/4.0/).
Expand Down
12 changes: 10 additions & 2 deletions docs/climate-resilience/fact-sheets-cres/digital-twins.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ comments: true

# Digital Twins

!!! info inline end "Work in progress"

This fact sheet is still being finalized. Soon you will will be able to read about the use of Digital twins for urban resilience.
:::info[Work in progress]

This section is still being finalized. Soon you will will be able to read more about the use of digital tools for urban resilience.
:::

## Short overview

Expand Down Expand Up @@ -82,6 +84,11 @@ comments: true

***Text in progress***

### Requirements

***Text in progress***

### Integration with other technologies
## Legal Aspects

***Text in progress***
Expand Down Expand Up @@ -117,6 +124,7 @@ comments: true
***Text in progress***

## Licence

![](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)

This work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0)](https://creativecommons.org/licenses/by-nc-sa/4.0/).
Expand Down
Loading

0 comments on commit e637b10

Please sign in to comment.