{"id":19783676,"url":"https://github.com/intersectmbo/cardano-updates","last_synced_at":"2025-04-30T22:31:46.266Z","repository":{"id":59897243,"uuid":"527739062","full_name":"IntersectMBO/cardano-updates","owner":"IntersectMBO","description":"Regular updates from the Cardano developer team","archived":false,"fork":false,"pushed_at":"2024-10-29T10:59:22.000Z","size":174724,"stargazers_count":9,"open_issues_count":4,"forks_count":16,"subscribers_count":37,"default_branch":"main","last_synced_at":"2024-10-29T12:47:44.119Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","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/IntersectMBO.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-22T21:33:50.000Z","updated_at":"2024-10-29T10:56:54.000Z","dependencies_parsed_at":"2024-01-26T16:24:03.599Z","dependency_job_id":"553cf2e1-7fba-4615-97b6-2f9ba2eac1c8","html_url":"https://github.com/IntersectMBO/cardano-updates","commit_stats":null,"previous_names":["intersectmbo/cardano-updates"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fcardano-updates","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fcardano-updates/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fcardano-updates/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fcardano-updates/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IntersectMBO","download_url":"https://codeload.github.com/IntersectMBO/cardano-updates/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224225212,"owners_count":17276435,"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":[],"created_at":"2024-11-12T06:08:58.249Z","updated_at":"2024-11-12T06:08:58.889Z","avatar_url":"https://github.com/IntersectMBO.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Cardano Development Updates][cardano-updates]\n\nThis repository will host updates from the\n[cardano](https://github.com/input-output-hk/cardano-node) development teams.\nThe generated website containing the updates can be found\n[here](https://updates.cardano.intersectmbo.org/).\n\nThis website is built using [Docusaurus 2](https://docusaurus.io/), a modern\nstatic website generator.\n\n## Usage\n\nTo add an update create a file under `blog` directory which name is:\n`yyyy-mm-dd-TEAM.md`. Commit and push.  The site will be built and deployed by a\n[github-action](https://github.com/input-output-hk/cardano-updates/actions).\n\nThe format of the posts is up to each team, but it should include a header\nsection that looks like:\n\n```\n---\ntitle: Networking Team Update\nslug: 2022-10-04-db-sync\nauthors: coot\ntags: [network]\nhide_table_of_contents: false\n---\n```\n\nEach post should also start with a `## High level summary` section that will be\nused by technical writers to share information with the general public.  The\nbetter suited this section is for the technical writers, the less chance there\nis for misinformation. It should ideally be one short paragraph.\n\nNote that docusourus accepts headers of level `\u003e= 2`, otherwise the initial\nheader is lost.\n\nAvoid using links which are not publicly accessible.\n\n### Authors\n\nAs per the [docusaurus blog](https://docusaurus.io/docs/blog#blog-post-authors) documentation, authors for a given blog post are provided as a YAML structure defining various properties. This can become cumbersome over time so there's a builtin mechanism to have an author's properties been defined once and then reused everywhere. Check the [blog/authors.yml](./blog/authors.yml) for examples.\n\n### New post script\n\nThere is a script named `newpost` in the root directory that will create a stub for a new post.\nSee `./scripts/newpost --help` for details.\n\n## Workflow\n\nEach team is welcome to use whatever workflow that they prefer.  The options\ninclude:\n\n* Pushing directly to the `main` branch.\n* Using pull requests as a way to involve the whole team before publishing.\n* Using pull requests to incrementally add to the report each day, and then\n  merging at the end of a two week period.\n\nRegardless of the workflow chosen, it is important that we strive to keep the\ngit history clean.  This means never force pushing on main, and usually having\none commit per new post.\n\n## Local Development\n\nOne needs to install `yarn` and `nodejs`.\n\n:warning: The `yarn` package from Debian has nothing to do with the yarn we use\nhere!\n\nIf using Nix package manager, one can start up a development environment by running:\n\n```\nnix develop\njust setup\njust run\n```\n\n### Installation\n\n```\n$ yarn\n```\n\n### Local Development\n\n```\n$ yarn start\n```\n\nThis command starts a local development server and opens up a browser\nwindow. Most changes are reflected live without having to restart the server.\n\n### Build\n\n```\n$ yarn build\n```\n\nThis command generates static content into the `build` directory and can be\nserved using any static contents hosting service.\n\n### Deployment\n\nThis is normally handled automatically through the [CI\nWorkflow](.github/workflows/pages.yml) by pushing changes to `gh-pages` branch\nbut should one need to deploy those pages manually, for example for testing\npurpose, follow these instructions:\n\nUsing SSH:\n\n```\n$ USE_SSH=true yarn deploy\n```\n\nNot using SSH:\n\n```\n$ GIT_USER=\u003cYour GitHub username\u003e yarn deploy\n```\n\n[cardano-updates]: https://updates.cardano.intersectmbo.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersectmbo%2Fcardano-updates","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintersectmbo%2Fcardano-updates","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersectmbo%2Fcardano-updates/lists"}