{"id":32564011,"url":"https://github.com/euroargodev/online_documentation","last_synced_at":"2025-10-29T03:54:08.639Z","repository":{"id":246217609,"uuid":"820431435","full_name":"euroargodev/online_documentation","owner":"euroargodev","description":"A template for online documentation","archived":false,"fork":false,"pushed_at":"2025-02-05T12:21:09.000Z","size":2325,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-02-05T13:23:07.230Z","etag":null,"topics":["argo-floats","documentation","template"],"latest_commit_sha":null,"homepage":"https://euroargodev.github.io/online_documentation/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/euroargodev.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":"2024-06-26T13:02:24.000Z","updated_at":"2025-02-05T12:21:12.000Z","dependencies_parsed_at":"2025-02-05T13:20:55.917Z","dependency_job_id":"3ec7285f-6b49-4a78-bd83-2549daa17b2c","html_url":"https://github.com/euroargodev/online_documentation","commit_stats":null,"previous_names":["euroargodev/ghpages_doc_template","euroargodev/online_documentation"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/euroargodev/online_documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/euroargodev%2Fonline_documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/euroargodev%2Fonline_documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/euroargodev%2Fonline_documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/euroargodev%2Fonline_documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/euroargodev","download_url":"https://codeload.github.com/euroargodev/online_documentation/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/euroargodev%2Fonline_documentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281556916,"owners_count":26521571,"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-29T02:00:06.901Z","response_time":59,"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":["argo-floats","documentation","template"],"created_at":"2025-10-29T03:54:04.485Z","updated_at":"2025-10-29T03:54:08.631Z","avatar_url":"https://github.com/euroargodev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003c!-- TOC --\u003e\u003ca name=\"a-template-for-your-online-documentation\"\u003e\u003c/a\u003e\n# A template for your online documentation\n\nThis repository is a template to get you started with building an online documentation.\n\nYou see how this documentation is rendered online here: https://euroargodev.github.io/online_documentation\n\nThe documentation is built using [Jupyter book](https://jupyterbook.org/en/stable/intro.html) and is hosted/deployed on Github Pages.\n\n\u003c!-- TOC start (generated with https://github.com/derlin/bitdowntoc) --\u003e\n\n* [Usage](#usage)\n  + [Create your own repository](#create-your-own-repository)\n  + [Enable doc online rendering](#enable-doc-online-rendering)\n  + [Update doc configuration parameters](#update-doc-configuration-parameters)\n* [☘ Use Green-Coding energy/CO2e measurements](#-use-green-coding-energyco2e-measurements)\n  + [Add your documentation IDs in repository secrets](#add-your-documentation-ids-in-repository-secrets)\n     - [Identify your project (repository)](#identify-your-project-repository)\n  + [Edit the `content/_config.yml` ](#edit-the-content_configyml)\n\n\u003c!-- TOC end --\u003e\n\n\u003c!-- TOC --\u003e\u003ca name=\"usage\"\u003e\u003c/a\u003e\n## Usage\n\nYou can use this check list to keep track of the procedure. All steps are explained in details below.\n\n- [ ] Create your own repository using this template\n- [ ] Enable documentation online rendering (Github Pages)\n- [ ] Update documentation content configuration with your own repository data\n\n\n\u003c!-- TOC --\u003e\u003ca name=\"create-your-own-repository\"\u003e\u003c/a\u003e\n### Create your own repository\n\nTo create your own documentation using this template, you have to clone this repository using the [green button \"Use this template\" above](https://github.com/new?template_name=online_documentation\u0026template_owner=euroargodev).\n\nMore details here:\nhttps://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template\n\n\n\u003c!-- TOC --\u003e\u003ca name=\"enable-doc-online-rendering\"\u003e\u003c/a\u003e\n### Enable doc online rendering\n\nIn the repository you created using this template, go to \"Settings\", then \"Pages\" and change the \"Source\" parameter to \"Github Actions\".\n\n\n\u003c!-- TOC --\u003e\u003ca name=\"update-doc-configuration-parameters\"\u003e\u003c/a\u003e\n### Update doc configuration parameters\n\nEdit the `content/_config.yml` file to update parameters with the new repository data.\n\n2 parameters must be updated:\n\n- replace any template ``euroargodev`` occurrences with your own `OWNER` name,\n- replace any template ``online_documentation`` occurences with your `\u003cREPO\u003e` name.\n\n```yml\nrepository:\n  url: https://github.com/\u003cOWNER\u003e/\u003cREPO\u003e\n\n  extra_footer: |\n    \u003cdiv\u003e ️\n      \u003ca href=\"https://github.com/\u003cOWNER\u003e/\u003cREPO\u003e/issues/new?labels=doc-edit\u0026template=doc_edit_template.md\" target=\"_blank\"\u003e✏ Click here to make a suggestion about this page\u003c/a\u003e\n      | \u003ca href=\"https://github.com/\u003cOWNER\u003e/\u003cREPO\u003e/issues/new?labels=doc-error\u0026template=doc_error_template.md\" target=\"_blank\"\u003e🚨 Report an error on this page\u003c/a\u003e\n    \u003c/div\u003e\n    \u003chr\u003e\n    \u003cp\u003e  By the Euro-Argo Dev community using\n      \u003ca href=\"https://jupyterbook.org/intro.html\" target=\"_blank\"\u003eJupyter Book\u003c/a\u003e.\n      \n      This work is licensed under a \n      \u003ca href=\"https://creativecommons.org/licenses/by/4.0/\" target=\"_blank\"\u003e Creative Commons Attribution 4.0 Generic License.\u003c/a\u003e \n    \n    \u003cdiv\u003e\n      \u003ca href=\"https://metrics.green-coding.io/ci.html?repo=\u003cOWNER\u003e%2F\u003cREPO\u003e\u0026amp;branch=main\u0026amp;workflow=\u003cWORKFLOW_ID\u003e\"\u003e\u003cimg src=\"https://api.green-coding.io/v1/ci/badge/get?repo=\u003cOWNER\u003e/\u003cREPO\u003e\u0026amp;branch=main\u0026amp;workflow=\u003cWORKFLOW_ID\u003e\"\u003e\u003c/a\u003e   \n    \u003c/div\u003e\n    \u003c/p\u003e\n```\n\n\n\n\u003c!-- TOC --\u003e\u003ca name=\"-use-green-coding-energyco2e-measurements\"\u003e\u003c/a\u003e\n## ☘ Use Green-Coding energy/CO2e measurements\n\nInterested in monitoring the energy consumption and CO2e emission associated with the building and deployment of your documentation ?\n\nThe documentation template is equiped to do this, but some parameters must be updated first. Follow these steps:\n\n\u003c!-- TOC --\u003e\u003ca name=\"add-your-documentation-ids-in-repository-secrets\"\u003e\u003c/a\u003e\n### Add your documentation IDs in repository secrets\n\nIn order to identify your documentation within the [📊 euroargodev overall energy \u0026 CO2e metrics](https://metrics.green-coding.io/carbondb-lists.html?company_uuid=4f42f511-4d8d-4d30-9c5e-8490f2c68811), you need to create specific IDs for your project and the Github Action machines.\n\n\u003c!-- TOC --\u003e\u003ca name=\"identify-your-project-repository\"\u003e\u003c/a\u003e\n#### Identify your project (repository)\n1. Get a unique ID from https://www.uuidgenerator.net. Copy the generated ID (it should be a string looking like this example: `4374ec28-7bca-4893-9c69-13e638cda063`)\n1. On your repository, go to \"Settings\", then \"Secrets and Variables\" and click on the green button \"New repository secret\"\n1. Name it `CARBONDB_PROJECT_UUID` and paste the ID you generated in the previous step in the *secret* field, finalize by clicking on the \"Add secret\" green button.\n\n\u003c!-- TOC --\u003e\u003ca name=\"edit-the-content_configyml\"\u003e\u003c/a\u003e\n### Edit the `content/_config.yml` \n\nOnce you created you secrets, build the documentation manually by executing the Github action:\n\n\u003cimg width=\"1369\" alt=\"Screenshot 2024-07-02 at 10 38 12\" src=\"https://github.com/euroargodev/online_documentation/assets/1956032/816c4a91-c5dc-4464-a3ed-53ff55ac07c1\"\u003e\n\nOnce the documentation is built and deployed, look at the action summary and look for the workflow parameter in the url:\n\n\u003cimg width=\"1353\" alt=\"Screenshot 2024-07-02 at 10 39 49\" src=\"https://github.com/euroargodev/online_documentation/assets/1956032/f706ccef-4068-48a4-9a94-c653adfd3126\"\u003e\n\nThis workflow id must be used in the repository `content/_config.yml` file: replace any template `104534311` occurences with your own `\u003cWORKFLOW_ID\u003e` value:\n\n```yml\n    \u003cdiv\u003e\n      \u003ca href=\"https://metrics.green-coding.io/ci.html?repo=\u003cOWNER\u003e%2F\u003cREPO\u003e\u0026amp;branch=main\u0026amp;workflow=\u003cWORKFLOW_ID\u003e\"\u003e\u003cimg src=\"https://api.green-coding.io/v1/ci/badge/get?repo=\u003cOWNER\u003e/\u003cREPO\u003e\u0026amp;branch=main\u0026amp;workflow=\u003cWORKFLOW_ID\u003e\"\u003e\u003c/a\u003e   \n    \u003c/div\u003e\n    \u003c/p\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feuroargodev%2Fonline_documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feuroargodev%2Fonline_documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feuroargodev%2Fonline_documentation/lists"}