Skip to content

Commit

Permalink
Update Doc and website deployment documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MattiSG committed May 22, 2024
1 parent 7b458a0 commit 91b4d79
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions guides/Operate-production-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,23 @@ Some redirections are done at the DNS level. See the "Web Forwarding" tab of Gan
## Services

### Documentation
### Website

Source code available on <https://github.com/openfisca/openfisca-doc/>
Source code available on <https://github.com/openfisca/openfisca.org/>

It is deployed to <https://openfisca.org/doc/>.
It is deployed to <https://openfisca.org/> by continuous deployment provided by CircleCI.

It is hosted by GitHub Pages.

It is hosted by [Netlify](https://www.netlify.com/).
The [settings](https://github.com/openfisca/openfisca.org/settings/pages) of the GitHub repository defines a custom domain name (`openfisca.org`), and the registrar has been set up to point the `A` and `AAAA` DNS records to GitHub Pages' servers.

The CI on this repository generates the HTML from the documentation and pushes it to the `doc-html` branch through [`.circleci/config.yml`](https://github.com/openfisca/openfisca-doc/blob/master/.circleci/config.yml) and [`publish.sh`](https://github.com/openfisca/openfisca-doc/blob/master/publish.sh).
### Documentation

Source code available on <https://github.com/openfisca/openfisca-doc/>

Then the CI of [openfisca.org](https://github.com/openfisca/openfisca.org) fetches that branch and includes its contents in the build, then updates the published version on GitHub Pages through [`publish-doc.sh`](https://github.com/openfisca/openfisca.org/blob/master/publish-doc.sh).
It is deployed to <https://openfisca.org/doc/>.

The [settings](https://github.com/openfisca/openfisca.org/settings/pages) of this GitHub Pages instance defines a custom domain name (`openfisca.org`), and the `/doc` base path targets a directory in the static build.
The CD on this repository generates the HTML from the documentation and adds the built content to the `doc` directory of the `gh-pages` branch through the `deploy` GitHub Actions workflow.

### API - demo

Expand Down

0 comments on commit 91b4d79

Please sign in to comment.