Skip to content
This repository has been archived by the owner on Feb 1, 2024. It is now read-only.

Update README.md to reflect project transition #212

Merged
merged 7 commits into from
Feb 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Build

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
schedule:
- cron: "0 5 * * *"

concurrency:
group: "${{ github.ref }}-${{ github.workflow }}"
cancel-in-progress: true

jobs:
lint:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: ruby/setup-ruby@v1
with:
ruby-version: '3.1.3'
bundler-cache: true
- name: Install Just
run: sudo snap install --edge --classic just
- name: Install mdl
run: gem install mdl
- name: Lint
run: just lint

build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: ruby/setup-ruby@v1
with:
ruby-version: '3.1.3'
bundler-cache: true
- name: Install Just
run: sudo snap install --edge --classic just
- name: Build
run: just build
44 changes: 44 additions & 0 deletions .github/workflows/deploy_prod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Deploy-to-splinter.splinter.dev

on:
workflow_dispatch:

concurrency:
group: "${{ github.ref }}-${{ github.workflow }}"
cancel-in-progress: true

env:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
AWS_DEFAULT_REGION: ${{ vars.AWS_DEFAULT_REGION }}
AWS_ROLE_ARN: ${{ vars.AWS_ROLE_ARN }}
JEKYLL_ENV: 'production'

jobs:
build:
runs-on: ubuntu-latest
environment: Production
steps:
- uses: actions/checkout@v3
- uses: ruby/setup-ruby@v1
with:
ruby-version: '3.1.3'
bundler-cache: true
- name: Install Just
run: sudo snap install --edge --classic just
- name: Build
run: just build
- name: "Deploy to AWS S3"
shell: bash
run: |
export $(printf "AWS_ACCESS_KEY_ID=%s AWS_SECRET_ACCESS_KEY=%s AWS_SESSION_TOKEN=%s" \
$(aws sts assume-role \
--role-arn ${{ vars.AWS_ROLE_ARN }} \
--role-session-name GithubActions \
--query "Credentials.[AccessKeyId,SecretAccessKey,SessionToken]" \
--output text))
aws s3 sync ./_site/ s3://${{ vars.AWS_S3_BUCKET_NAME }} \
--delete --cache-control max-age=604800
aws cloudfront create-invalidation \
--distribution-id ${{ vars.AWS_CLOUDFRONT_DISTRIBUTION_ID }} \
--paths "/*"
26 changes: 0 additions & 26 deletions .github/workflows/lint-website.yaml

This file was deleted.

68 changes: 0 additions & 68 deletions .github/workflows/merge.yaml

This file was deleted.

26 changes: 0 additions & 26 deletions .github/workflows/test-docker-build.yaml

This file was deleted.

13 changes: 13 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
source "https://rubygems.org"

gem "jekyll", "~> 4.3.1"

group :jekyll_plugins do
gem "jekyll-default-layout"
gem "jekyll-optional-front-matter"
gem "jekyll-readme-index"
gem "jekyll-redirect-from"
gem "jekyll-seo-tag"
gem "jekyll-target-blank"
gem "jekyll-titles-from-headings"
end
89 changes: 11 additions & 78 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,18 @@
# sawtooth-website
# Hyperledger Sawtooth

## Preview and Review
This project has moved (see below).

You'll need to install
[Docker and Compose](https://docs.docker.com/compose/install/)
Hyperledger Sawtooth was a project to provide an enterprise solution for
building, deploying, and running distributed ledgers (also called blockchains).

From a local clone of
[the repository](https://github.com/hyperledger/sawtooth-website), run
# Project Status

```
docker-compose up
```
This Hyperledger project, Hyperledger Sawtooth, has been archived and is no
longer active within Hyperledger.

Pay attention to the output for markdown syntax errors. Errors will appear on
lines beginning with `linter_1`.

The site will be available at [`http://localhost:8000`](http://localhost:8000)

To stop the site, type `[Ctrl]+C` then run

```
docker-compose down -v
```

## Adding a Post

To create a post, add a [markdown](https://kramdown.gettalong.org/quickref.html)
or [reStructuredText](http://docutils.sourceforge.net/rst.html) file
to the `generator/source/_posts` directory with the following format:

```
YEAR-MONTH-DAY-title.MARKUP
```

Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit
numbers, and `MARKUP` is the file extension representing the format used in the
file. For example, the following are examples of valid post filenames:

```
2019-04-23-hyperledger-is-awesome.md
2019-09-12-how-to-write-a-how-to.rst
```

All post files must begin with front matter which is typically used to set a
layout or other meta data.

```
---
layout: post
title: Hyperledger Sawtooth, Seth and Truffle 101
categories: [certification, hyperledger]
tags: [cert, calendar]
---

Excerpt from [hyperledger.org](https://www.hyperledger.org/blog/2018/07/24
/hyperledger-sawtooth-seth-and-truffle-101)

I develop on both Hyperledger Fabric/Sawtooth and Ethereum (to be specified,
Quorum) so I am familiar with the languages available on both platform —
chaincode (Go) and smart contract (Solidity). Often I am asked this question:
“Which platform is better?” To which I will answer, this question is a false
choice as with Hyperledger Sawtooth Seth, you can build your smart contracts in
Solidity and deploy the same smart contract in Hyperledger Sawtooth — Pretty
cool isn’t it? ...
```

## Editing Site Content

Change the content of `/`, `/contact/`, `/about/`,
etc., by editing the files in `/generator/source/`.

E.g., `/generator/source/index.md`, `/generator/source/contact.md` and
`/generator/source/about.md`

## LICENSE

* This documentation and the content herein is covered by [
Creative Commons Attribution 4.0 International License](
http://creativecommons.org/licenses/by/4.0/ "license") unless otherwise stated.
* Jekyll (docker-compose.yaml) is used under LICENSE-MIT
* The Jekyll Type theme is used under generator/source/LICENSE (MIT)
* Markdown lint tool (docker-compose.yaml) is used under LICENSE-MIT
Sawtooth is now maintained by the Splinter community. For more information,
visit: https://github.com/splintercommunity/sawtooth-core/

# License

Hyperledger Sawtooth software is licensed under the [Apache License Version 2.0](LICENSE) software license.
Loading
Loading