{"id":16314459,"url":"https://github.com/ntno/mkdocs-demo","last_synced_at":"2025-10-20T09:24:54.977Z","repository":{"id":65100125,"uuid":"581948921","full_name":"ntno/mkdocs-demo","owner":"ntno","description":"example MkDocs project with GitHub Action CICD","archived":false,"fork":false,"pushed_at":"2023-07-25T23:41:56.000Z","size":1235,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-10T09:29:32.140Z","etag":null,"topics":["github-actions","github-oidc","mkdocs"],"latest_commit_sha":null,"homepage":"http://factually-settled-boxer.s3-website-us-east-1.amazonaws.com","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ntno.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-25T02:05:10.000Z","updated_at":"2023-01-31T22:37:11.000Z","dependencies_parsed_at":"2024-12-17T13:42:26.210Z","dependency_job_id":"2afec1e7-f9d2-442b-a3a8-7696d32b6832","html_url":"https://github.com/ntno/mkdocs-demo","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/ntno/mkdocs-demo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fmkdocs-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fmkdocs-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fmkdocs-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fmkdocs-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ntno","download_url":"https://codeload.github.com/ntno/mkdocs-demo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fmkdocs-demo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280065749,"owners_count":26265932,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-20T02:00:06.978Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","github-oidc","mkdocs"],"created_at":"2024-10-10T21:54:00.695Z","updated_at":"2025-10-20T09:24:54.929Z","avatar_url":"https://github.com/ntno.png","language":"HCL","readme":"# mkdocs-demo\nExample project for creating/deploying a MkDocs website with GitHub Actions.  \n\n## live environments\n### integration\ntemporary environments are created/destroyed with pull request open/close  \n\nurl: posted to the pull request for review  \nstatus:   \n   [![Test Pull Request](https://github.com/ntno/mkdocs-demo/actions/workflows/test-pr.yml/badge.svg)](https://github.com/ntno/mkdocs-demo/actions/workflows/test-pr.yml)\n\n### development\nurl: [http://factually-settled-boxer-development.s3-website-us-east-1.amazonaws.com](http://factually-settled-boxer-development.s3-website-us-east-1.amazonaws.com)  \nstatus:  \n   [![Deploy MkDocs to Development Environment](https://github.com/ntno/mkdocs-demo/actions/workflows/dev-deploy.yml/badge.svg?branch=main)](https://github.com/ntno/mkdocs-demo/actions/workflows/dev-deploy.yml)\n\n### production\nurl: [http://factually-settled-boxer.s3-website-us-east-1.amazonaws.com](http://factually-settled-boxer.s3-website-us-east-1.amazonaws.com)    \nstatus:  \n   [![Deploy MkDocs to Production Environment](https://github.com/ntno/mkdocs-demo/actions/workflows/prod-deploy.yml/badge.svg)](https://github.com/ntno/mkdocs-demo/actions/workflows/prod-deploy.yml)\n\n## local development\n\nex: run server with ['dev/local'](variables.yml#L9-L12) site variables  \n`make serve env=dev region=local`\n\nex: run server with ['dev/us-east-1'](variables.yml#L15-L17) site variables  \n`make serve env=dev region=us-east-1`    \n\nex: run server with ['prod/us-east-1'](variables.yml#L21-L25) site variables  \n`make serve env=prod region=us-east-1` \n\n## prerequisites\n- install docker and Make (for local development)\n- set up OIDC provider in AWS console\n   - [Use OpenID Connect within your workflows to authenticate with Amazon Web Services.](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services)  \n- create S3 bucket for static website hosting \n- create supporting cicd resources (S3 bucket for site artifacts and IAM roles for GitHub Action workflows to assume)\n\n\n### infrastructure (onetime setup)\n\nsee terraform code in [`infra/`](infra/) for example on how to create required resources.  [`ntno/tf-module-static-site-cicd`](https://github.com/ntno/tf-module-static-site-cicd) is used to create CICD IAM roles and artifact bucket.\n\n```\nmake ubuntu\ncd infra\nmake plan\nmake apply\n```\n\n- creates development and production site buckets  \n- creates IAM roles to support github action workflows\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntno%2Fmkdocs-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fntno%2Fmkdocs-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntno%2Fmkdocs-demo/lists"}