[AAQ-729] Add mkdocs versioning - Githubissues

IDinsight / ask-a-question

Trustworthy question-answering AI plugin for chatbots in the social sector with advanced content performance analysis.

https://ask-a-question.com

BSD 3-Clause "New" or "Revised" License

27 stars 4 forks source link

[AAQ-729] Add mkdocs versioning #353

Closed suzinyou closed 1 month ago

suzinyou commented 1 month ago

Reviewer: @markbotterill Estimate: 30min

Ticket

Fixes: https://idinsight.atlassian.net/browse/AAQ-729

Description

Goal

Add versioning to mkdocs.

Changes

Add mike versioning as per mkdocs' documentation
Update docs github actions so that we only publish docs on release
Update docs actions to
1. fetch existing gh_pages branch
2. run mike to add new version and push the changes
3. Add and commit a CNAME file manually which should contain the custom domain. This is because mike does not handle non-versioned files (see their instructions
Update actions to versions that use Node 20

Future Tasks

[ ] Deploy testing version of docs

How has this been tested?

I created a fake version (v0.1.1-test) instead of using ${{ github.ref_name }} in the docs.yaml. Pushed this.
Went to Github Actions - Deploy Docs -> workflow dispatch at this branch AAQ-729-doc-version
Check that a new version has been added to docs.ask-a-question.com
Check that older versions are still there

To-do before merge

I will

[x] 1. Git fetch origin gh-pages
[x] 2. git swith gh-pages
[x] 3. Remove v0.1.1-test version of docs
[x] 4. update symlink of latest to point to actual latest release tag:
```
    ln -sfn v0.1.0 latest
```

Checklist

Fill with x for completed.

[x] My code follows the style guidelines of this project
[x] I have reviewed my own code to ensure good quality
[x] I have tested the functionality of my code to ensure it works as intended
[x] I have resolved merge conflicts