Bring in the docs repo - CI

[HarelM]

Acceptance criteria:

1. On each CI run the docs build process is ran and checked that there are no errors or warnings
2. When running a release pipeline the docs are build and push to gh-pages branch. note that gh-pages branch is not empty and should be kept that way - we are pushing some build artifact there.

Part of #2150
@cc: @krishnaglodha

[krishnaglodha]

Hi, so once the mkdocs build is done, where should the folder go ?

[HarelM]

In github pages, I don't know if it should be in a docs folder or not though...

[krishnaglodha]

We can use https://squidfunk.github.io/mkdocs-material/publishing-your-site/#material-for-mkdocs to directly push to gh-pages but I believe it'll remove previous content

[HarelM]

There is valuable data there, please check it on a repo you create to make sure other content is not removed.
If the content is removed, then a folder in the gh pages would probably be the right solution.

[krishnaglodha]

ok, I'll test first
and keep you posted

[krishnaglodha]

It replaces everything in `gh-pages`

but after mkdocs build we get site folder which I think we can use to point github pages manually

[HarelM]

What about base-href? base folder? I'll be surprized if this is not supported at all.
But in case it's not, we can copy the site folder to gh-pages as part of the build process, it should be complicated.
I would advise to try that in your repo as well...

[krishnaglodha]

base as in you mean root folder ?

[HarelM]

There is the base-href - where the folders will be relative to the host it will published in.
There is the base folder where the docs will be in the gh-pages.
I expect there should be a configuration for each separately.

[krishnaglodha]

ok, so now I'm working on CI, which will essentially add a site folder to current gh-pages branch

[krishnaglodha]

Hi @HarelM , I'm getting

remote: Permission to krishnaglodha/maplibre-gl-js.git denied to github-actions[bot].
fatal: unable to access 'https://github.com/krishnaglodha/maplibre-gl-js/': The requested URL returned error: 403

in my CI file

[HarelM]

Bounty was removed as I ended implementing this.