{"id":18470850,"url":"https://github.com/inria/mooc-accessibility-static","last_synced_at":"2025-05-12T13:34:47.332Z","repository":{"id":97337058,"uuid":"212378848","full_name":"INRIA/mooc-accessibility-static","owner":"INRIA","description":"MOOC Accessibility course static website","archived":false,"fork":false,"pushed_at":"2019-12-13T08:52:27.000Z","size":492,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-16T18:43:54.754Z","etag":null,"topics":["a11y","course","hugo","mooc"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/INRIA.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-10-02T15:39:50.000Z","updated_at":"2023-12-14T12:50:51.000Z","dependencies_parsed_at":"2023-05-05T23:44:44.687Z","dependency_job_id":null,"html_url":"https://github.com/INRIA/mooc-accessibility-static","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/INRIA%2Fmooc-accessibility-static","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/INRIA%2Fmooc-accessibility-static/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/INRIA%2Fmooc-accessibility-static/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/INRIA%2Fmooc-accessibility-static/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/INRIA","download_url":"https://codeload.github.com/INRIA/mooc-accessibility-static/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253748561,"owners_count":21957945,"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","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":["a11y","course","hugo","mooc"],"created_at":"2024-11-06T10:15:01.718Z","updated_at":"2025-05-12T13:34:47.306Z","avatar_url":"https://github.com/INRIA.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Inria Digital Accessibility MOOC Website\n\nInria Digital Accessibility MOOC website is the standalone version of the MOOC\nthat was hosted by [FUN](https://www.fun-mooc.fr/).  \nIt also contains web pages to be embed for 3rd party platforms such as\n[FUN](https://www.fun-mooc.fr).\n\nThis website contains all the course resources (such as media, slides, or\nsubtitles). However, note that users will not be prompted with any survey nor\nquiz.\n\nIt is available at the following url: \u003chttps://mooc-accessibility.inria.fr/\u003e\n\n## How to Consume this MOOC\n\nThere are two ways to consume this MOOC.\n\n### Browsing the Website\n\nAll the MOOC content is served at \u003chttps://mooc-accessibility.inria.fr/\u003e and is\nfree to browse. If you are just looking for plain content consuming, this is\nprobably what you are looking for.\n\n### Embeding the MOOC\n\nIf you host your own website and you want to integrate a MOOC sequence to it,\nthe recommended way to do it is by using an `iframe`.\n\n```html\n\u003ciframe\n  src=\"https://mooc-accessibility.inria.fr/course/w1-s1/embed.html\"\n  class=\"mooc-iframe\"\n  scrolling=\"no\"\n  width=\"800\"\n  height=\"546\"\n/\u003e\n```\n\nThis integration is better suited when you do not want to host any of the player\nfiles on your servers.\n\nThis is how FUN was integreting the MOOC to their platform without having to\nbother about configuration or JavaScript integration to their code.\n\n#### Note About Styles\n\nTo remove the `iframe` borders, you need to explicitely set a CSS rule for it:\n\n```css\n.mooc-iframe {\n  border: 0;\n}\n```\n\n#### Courtesy of Inria\n\nRemember that when you embed this MOOC to your website, it consumes resources\nprovided by Inria.\n\nIf Inria encourages people to spread this MOOC, it does not charge anything for\nthis service. So please use it moderately, and be kind to notify us when you\nembed it in a MOOC platform.\n\n### Service-Level Agreement\n\nInria does not provide any formalized agreements to deliver a particular level\nof service, please consider it as a best-effort model.\n\nUnplanned outages and maintenance may happen without any notice, and Inria\ncannot guarantee [the MOOC website](https://mooc-accessibility.inria.fr/) uptime\nnor performances.\n\nIf you plan on embedding the MOOC, you should keep that in mind.\n\n---\n\n## Development\n\nThis website is generated using [Hugo](https://gohugo.io) `\u003ev0.58.3`, which is\nthe only required software installation.\n[Installing Hugo](https://gohugo.io/getting-started/installing) is required in\norder to build the static HTML files.\n\nTo test the website locally, you will also need to download the\n[MOOC player](https://github.com/INRIA/aiana-player) assets that are not\nincluded to this repository:\n\n1. Download Aiana player release zip archive; it should be the same as the one\n   specified in `PLAYER_VERSION` key in `.travis.yml` file.  \n   Releases are listed on the\n   [repository releases page](https://github.com/INRIA/aiana-player/releases).\n\n2. Unzip the archive.\n\n3. Move the `release/manifest.yml` file to `data/manifest.yml`.\n\n4. Move the player JavaScript files to `static/js/`.\n\n5. Move the `release/locales` folder to `static/`. These files are included in\n   the player release archive since `v2.2.1`. If you target an earlier version,\n   the files can be copy pasted from the player repository depending on\n   targetted player version. For example, if you intend to use `v2.2.0`, you\n   should download all files from\n   [`v2.2.0` tree](https://github.com/INRIA/aiana-player/tree/v2.2.0/public/locales).\n\n6. Run `hugo server`. This command will automatically reload the server when\n   content is modified.\n\n7. Go to `http://localhost:1313`.\n\n## Managing Content\n\nThe [\"Content Management\"](https://gohugo.io/content-management/) section of the\nHugo documentation covers extensively how to manage content.\n\n## How to Create a Release\n\n[Travis CI](https://travis-ci.com) is used as continuous integration platform.\n\nWhenever a Git tag is pushed, Travis will perform all steps mentioned above and\nbuild an archive containing the files for both staging and production\nenvironments.\n\nReleases can be found on\n[the project release page](https://github.com/INRIA/mooc-accessibility-static/releases).\n\nNote that there is a\n[static link to the latest release](https://github.com/INRIA/mooc-accessibility-static/releases/latest)\nwhich is used for website deployment.\n\n### Release Commit\n\n1. Create the release tag using [semantic versioning](https://semver.org/):\n\n   `git tag vX.X.X`\n\n2. Push tags to the repository:\n\n   `git push origin --tags`\n\n3. Update `CHANGELOG.md` by moving the \"Unreleased\" section content to a new\n   section containing the release tag.\n\n4. Commit `CHANGELOG.md` updates.\n\n### Manually Create a Release\n\nIf no continuous environment is provided, creating a release is still possible.\nThe `script` section of the `.travis.yml` file describes how to achieve this.\n\nThe following example will create a `./build` directory containing the files for\nthe production environment:\n\n```sh\n# example assumes `hugo` executable is available.\n#\n# target player tag is v2.2.3.\n\ncd path/to/mooc-accessibility-static\n\n# download player archive\ncurl -LO https://github.com/INRIA/aiana-player/releases/download/v2.2.3/release.zip\n\n# extract player files\nunzip release.zip\n\n# remove existing locales folder\nrm -rf static/locales\n\n# move player release locales to website assets\nmv release/locales static/\n\n# move player release manifest file to website data\nmv release/manifest.yml data/manifest.yml\n\n# move player release JavaScript files to website assets\nmv release/*.js static/js/\n\necho \"url: /api/logs\" \u003e data/logger.yml\necho \"site_id: 100\" \u003e data/matomo.yml\n\nhugo --destination build --gc --baseUrl https://mooc-accessibility.inria.fr/\n\necho \"env: prod\" \u003e build/prod/version.html\necho \"tag: $(git describe --tags)\" \u003e\u003e build/prod/version.html\necho \"player: v2.2.3\" \u003e\u003e build/prod/version.html\n```\n\n---\n\n## MOOC Analytics\n\nTwo kinds of analytics will be measured as a users browse pages and use the MOOC\nplayer. Both are optional, though they may help understanding usages and improve\nthe website, the MOOC content, and the player.\n\n### Audience Analytics\n\nAudience analytics helps understanding global usage of the website and gives\ninsights about users browsing context: screen resolution, browser, operating\nsystem…\n\nInria recommends using [Matomo](https://matomo.org/) (formerly Piwik) to collect\nthe analytics, and this website uses the\n[Inria on-premise instance](https://piwik.inria.fr/).\n\nThe Matomo `script` tag will be integrated on each page if a `data/matomo.yml`\nfile exists and has a `site_id` key.\n\nFor a local development environment, content of the file will be:\n\n```yaml\nsite_id: '101'\n```\n\nThe Matomo identifiers are:\n\n- `100` for production\n- `101` for staging\n\nTo require access to the website analytics, please contact any of the\nadministrators:\n\n- [Pascal Guitton](pascal.guitton@inria.fr)\n- [Julien Lelaurain](julien.lelaurain@inria.fr)\n\n### Web Player Analytics\n\nPlayer events help understand how users are interacting with the MOOC content.\nThey provide extensive details about the player state, but none about the user\ntriggering them.\n\nActions made by users will be pushed to a remote server only if its url is\nprovided. The logging endpoint can be specified within a `data/logger.yml` file\ncontaining a `url` key.\n\nFor example, the `data/logger.yml` file could be:\n\n```yaml\nurl: 'https://domain.com/path/to/write/logs'\n```\n\nTo know more about web player actions, please refer to\n[the player documentation](https://github.com/INRIA/aiana-player).\n\n## Code Status\n\n[![Build Status](https://travis-ci.com/INRIA/mooc-accessibility-static.svg?branch=master)](https://travis-ci.com/INRIA/mooc-accessibility-static)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finria%2Fmooc-accessibility-static","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finria%2Fmooc-accessibility-static","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finria%2Fmooc-accessibility-static/lists"}