https://github.com/intersectmbo/cardano-updates
Regular updates from the Cardano developer team
https://github.com/intersectmbo/cardano-updates
Last synced: 11 months ago
JSON representation
Regular updates from the Cardano developer team
- Host: GitHub
- URL: https://github.com/intersectmbo/cardano-updates
- Owner: IntersectMBO
- License: apache-2.0
- Created: 2022-08-22T21:33:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T10:59:22.000Z (over 1 year ago)
- Last Synced: 2024-10-29T12:47:44.119Z (over 1 year ago)
- Language: Shell
- Homepage:
- Size: 167 MB
- Stars: 9
- Watchers: 37
- Forks: 16
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# [Cardano Development Updates][cardano-updates]
This repository will host updates from the
[cardano](https://github.com/input-output-hk/cardano-node) development teams.
The generated website containing the updates can be found
[here](https://updates.cardano.intersectmbo.org/).
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern
static website generator.
## Usage
To add an update create a file under `blog` directory which name is:
`yyyy-mm-dd-TEAM.md`. Commit and push. The site will be built and deployed by a
[github-action](https://github.com/input-output-hk/cardano-updates/actions).
The format of the posts is up to each team, but it should include a header
section that looks like:
```
---
title: Networking Team Update
slug: 2022-10-04-db-sync
authors: coot
tags: [network]
hide_table_of_contents: false
---
```
Each post should also start with a `## High level summary` section that will be
used by technical writers to share information with the general public. The
better suited this section is for the technical writers, the less chance there
is for misinformation. It should ideally be one short paragraph.
Note that docusourus accepts headers of level `>= 2`, otherwise the initial
header is lost.
Avoid using links which are not publicly accessible.
### Authors
As 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.
### New post script
There is a script named `newpost` in the root directory that will create a stub for a new post.
See `./scripts/newpost --help` for details.
## Workflow
Each team is welcome to use whatever workflow that they prefer. The options
include:
* Pushing directly to the `main` branch.
* Using pull requests as a way to involve the whole team before publishing.
* Using pull requests to incrementally add to the report each day, and then
merging at the end of a two week period.
Regardless of the workflow chosen, it is important that we strive to keep the
git history clean. This means never force pushing on main, and usually having
one commit per new post.
## Local Development
One needs to install `yarn` and `nodejs`.
:warning: The `yarn` package from Debian has nothing to do with the yarn we use
here!
If using Nix package manager, one can start up a development environment by running:
```
nix develop
just setup
just run
```
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser
window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be
served using any static contents hosting service.
### Deployment
This is normally handled automatically through the [CI
Workflow](.github/workflows/pages.yml) by pushing changes to `gh-pages` branch
but should one need to deploy those pages manually, for example for testing
purpose, follow these instructions:
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER= yarn deploy
```
[cardano-updates]: https://updates.cardano.intersectmbo.org