Skip to content
Draft
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
8 changes: 8 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# See http://editorconfig.org

root = true

[*.{md,xml,org}]
charset = utf-8
insert_final_newline = true
trim_trailing_whitespace = true
73 changes: 73 additions & 0 deletions .github/workflows/internet-draft.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: Build Internet Draft

on:
push:
branches: ["main"]
paths: ["draft-*"]
workflow_dispatch:

permissions:
contents: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: "Checkout"
uses: actions/checkout@v4
- name: "Setup"
id: setup
run: date -u "+date=%FT%T" >>"$GITHUB_OUTPUT"
- name: "Caching"
uses: actions/cache@v4
with:
path: |
.refcache
.venv
.gems
node_modules
.targets.mk
key: i-d-${{ steps.setup.outputs.date }}
restore-keys: i-d-
- name: "Build Drafts"
uses: martinthomson/i-d-template@v1
with:
token: ${{ github.token }}
- name: Upload
uses: actions/upload-artifact@v4
with:
name: internet-draft
path: draft-*.html
overwrite: true

push:
runs-on: ubuntu-latest
needs: build
steps:
- name: Checkout
uses: actions/checkout@v4
with:
ref: gh-pages
- name: Delete
run : rm -rf /tmp/internet-draft
- name: Download
uses: actions/download-artifact@v4
with:
name: internet-draft
path: /tmp/internet-draft
- name: Sync
run: |
rm -rf internet-draft
mv /tmp/internet-draft .
- name: Push
run: |
git status
git add .
git config --global user.name 'Deploy Bot'
git config --global user.email '[email protected]'
git commit --allow-empty -m 'Automated Internet Draft Deployment'
git push
13 changes: 9 additions & 4 deletions .github/workflows/jekyll.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
paths: ["site/**"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand All @@ -22,6 +23,9 @@ concurrency:
jobs:
# Build job
build:
defaults:
run:
working-directory: ./site
runs-on: ubuntu-latest
steps:
- name: Checkout
Expand All @@ -32,6 +36,7 @@ jobs:
ruby-version: '3.3.5'
bundler-cache: true
cache-version: 0
working-directory: ./site
- name: Build
run: bundle exec jekyll build
env:
Expand All @@ -40,7 +45,7 @@ jobs:
uses: actions/upload-artifact@v4
with:
name: site
path: _site
path: site/_site
overwrite: true

# Push job
Expand All @@ -60,12 +65,12 @@ jobs:
name: site
path: /tmp/site
- name: Sync
run: rsync -avh --delete --exclude .git /tmp/site/ .
run: rsync -avh --delete --exclude .git --exclude internet-draft /tmp/site/ .
- name: Push
run: |
git status
git add .
git config --global user.name 'Deploy Bot'
git config --global user.email '[email protected]'
git commit --allow-empty -m 'Automated Deployment'
git push
git commit --allow-empty -m 'Automated Site Deployment'
git push
26 changes: 26 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,29 @@ _site
.sass-cache/
.jekyll-cache/
.jekyll-metadata

# Internet Draft Setup
*.html
*.pdf
*.redxml
*.swp
*.txt
*.upload
*~
.tags
/*-[0-9][0-9].xml
/.*.mk
/.gems/
/.idea/
/.refcache
/.venv/
/.vscode/
/lib
/node_modules/
/versioned/
Gemfile.lock
archive.json
draft-jsonlines-standard-content-type.xml
package-lock.json
report.xml
!requirements.txt
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing

This repository relates to activities in the Internet Engineering Task Force
([IETF](https://www.ietf.org/)). All material in this repository is considered
Contributions to the IETF Standards Process, as defined in the intellectual
property policies of IETF currently designated as
[BCP 78](https://www.rfc-editor.org/info/bcp78),
[BCP 79](https://www.rfc-editor.org/info/bcp79) and the
[IETF Trust Legal Provisions (TLP) Relating to IETF Documents](http://trustee.ietf.org/trust-legal-provisions.html).

Any edit, commit, pull request, issue, comment or other change made to this
repository constitutes Contributions to the IETF Standards Process
(https://www.ietf.org/).

You agree to comply with all applicable IETF policies and procedures, including,
BCP 78, 79, the TLP, and the TLP rules regarding code components (e.g. being
subject to a Simplified BSD License) in Contributions.
4 changes: 4 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# License

See the
[guidelines for contributions](https://github.com/sp4ce/jsonlines/blob/main/CONTRIBUTING.md).
15 changes: 15 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
LIBDIR := lib
include $(LIBDIR)/main.mk

$(LIBDIR)/main.mk:
ifneq (,$(shell grep "path *= *$(LIBDIR)" .gitmodules 2>/dev/null))
git submodule sync
git submodule update --init
else
ifneq (,$(wildcard $(ID_TEMPLATE_HOME)))
ln -s "$(ID_TEMPLATE_HOME)" $(LIBDIR)
else
git clone -q --depth 10 -b main \
https://github.com/martinthomson/i-d-template $(LIBDIR)
endif
endif
43 changes: 40 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# jsonlines
<!-- regenerate: off (set to off if you edit this file) -->

# JSON Lines
Documentation for the JSON Lines text file format

Visit https://jsonlines.org

## Development
## Website Development

### Jekyll installation

Expand All @@ -14,16 +16,51 @@ Follow steps:
### Bundle installation

```shell
cd site
bundle config set --local path 'vendor/bundle'
bundle install
```

### Build and serve the site

```shell
# change directory to site
cd site

# just build the website
bundle exec jekyll build

# build and serve the website on default port
bundle exec jekyll serve
```
```

## JSON Lines Standard Content Type

This is the working area for the individual Internet-Draft, "JSON Lines Standard Content Type".

* [Editor's Copy](https://sp4ce.github.io/jsonlines/#go.draft-jsonlines-standard-content-type.html)
* [Datatracker Page](https://datatracker.ietf.org/doc/draft-jsonlines-standard-content-type)
* [Individual Draft](https://datatracker.ietf.org/doc/html/draft-jsonlines-standard-content-type)
* [Compare Editor's Copy to Individual Draft](https://sp4ce.github.io/jsonlines/#go.draft-jsonlines-standard-content-type.diff)


### Contributing

See the
[guidelines for contributions](https://github.com/sp4ce/jsonlines/blob/main/CONTRIBUTING.md).

Contributions can be made by creating pull requests.
The GitHub interface supports creating pull requests using the Edit (✏) button.


### Command Line Usage

Formatted text and HTML versions of the draft can be built using `make`.

```sh
$ make
```

Command line usage requires that you have the necessary software installed. See
[the instructions](https://github.com/martinthomson/i-d-template/blob/main/doc/SETUP.md).

90 changes: 90 additions & 0 deletions draft-pernetmugnier-json-lines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
###
# Internet-Draft Markdown Template
#
# Rename this file from draft-todo-yourname-protocol.md to get started.
# Draft name format is "draft-<yourname>-<workgroup>-<name>.md".
#
# For initial setup, you only need to edit the first block of fields.
# Only "title" needs to be changed; delete "abbrev" if your title is short.
# Any other content can be edited, but be careful not to introduce errors.
# Some fields will be set automatically during setup if they are unchanged.
#
# Don't include "-00" or "-latest" in the filename.
# Labels in the form draft-<yourname>-<workgroup>-<name>-latest are used by
# the tools to refer to the current version; see "docname" for example.
#
# This template uses kramdown-rfc: https://github.com/cabo/kramdown-rfc
# You can replace the entire file if you prefer a different format.
# Change the file extension to match the format (.xml for XML, etc...)
#
###
title: JavaScript Object Notation (JSON) Lines
abbrev: JSON Lines
category: info

docname: draft-pernetmugnier-json-lines-latest
submissiontype: IETF # also: "independent", "editorial", "IAB", or "IRTF"
number:
date:
consensus: true
v: 3
# area: AREA
# workgroup: WG Working Group
keyword:
- next generation
- unicorn
- sparkling distributed ledger
venue:
# group: WG
# type: Working Group
# mail: [email protected]
# arch: https://example.com/WG
github: "sp4ce/jsonlines"
latest: "https://sp4ce.github.io/jsonlines/internet-draft/draft-pernetmugnier-json-lines.html"

author:
-
fullname: Baptiste Pernet-Mugnier
organization: Your Organization Here
email: [email protected]

normative:

informative:

...

--- abstract

TODO Abstract


--- middle

# Introduction

TODO Introduction


# Conventions and Definitions

{::boilerplate bcp14-tagged}


# Security Considerations

TODO Security


# IANA Considerations

This document has no IANA actions.


--- back

# Acknowledgments
{:numbered="false"}

TODO acknowledge.
9 changes: 9 additions & 0 deletions site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Bundle generated folders
.bundle
vendor/bundle

# Jekyll generated folders
_site
.sass-cache/
.jekyll-cache/
.jekyll-metadata
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.