From 170a59d5f1f0cb4033519f9ae08435f83a438853 Mon Sep 17 00:00:00 2001 From: Baptiste Pernet Date: Sat, 7 Jun 2025 11:15:48 -0400 Subject: [PATCH 01/15] Move site into site directory --- .github/workflows/jekyll.yml | 7 ++++++- README.md | 4 ++++ .gitignore => site/.gitignore | 0 CNAME => site/CNAME | 0 Gemfile => site/Gemfile | 0 Gemfile.lock => site/Gemfile.lock | 0 _config.yml => site/_config.yml | 0 {_data => site/_data}/menu.yml | 0 {_includes => site/_includes}/footer.html | 0 {_includes => site/_includes}/head.html | 0 {_includes => site/_includes}/menu.html | 0 {_layouts => site/_layouts}/default.html | 0 {examples => site/examples}/index.md | 0 {images => site/images}/body-bg.png | Bin {images => site/images}/highlight-bg.jpg | Bin {images => site/images}/hr.png | Bin {images => site/images}/octocat-icon.png | Bin {images => site/images}/tar-gz-icon.png | Bin {images => site/images}/zip-icon.png | Bin index.md => site/index.md | 0 {javascripts => site/javascripts}/validator.js | 0 .../vendor/codemirror-6.65.7-javascript.min.js | 0 .../javascripts}/vendor/codemirror-6.65.7.min.js | 0 .../javascripts}/vendor/jquery-3.7.0.min.js | 0 {on_the_web => site/on_the_web}/index.md | 0 params.json => site/params.json | 0 {stylesheets => site/stylesheets}/print.css | 0 {stylesheets => site/stylesheets}/pygment_trac.css | 0 {stylesheets => site/stylesheets}/stylesheet.css | 0 .../vendor/codemirror-6.65.7-abbott.min.css | 0 .../stylesheets}/vendor/codemirror-6.65.7.min.css | 0 {validator => site/validator}/index.md | 0 32 files changed, 10 insertions(+), 1 deletion(-) rename .gitignore => site/.gitignore (100%) rename CNAME => site/CNAME (100%) rename Gemfile => site/Gemfile (100%) rename Gemfile.lock => site/Gemfile.lock (100%) rename _config.yml => site/_config.yml (100%) rename {_data => site/_data}/menu.yml (100%) rename {_includes => site/_includes}/footer.html (100%) rename {_includes => site/_includes}/head.html (100%) rename {_includes => site/_includes}/menu.html (100%) rename {_layouts => site/_layouts}/default.html (100%) rename {examples => site/examples}/index.md (100%) rename {images => site/images}/body-bg.png (100%) rename {images => site/images}/highlight-bg.jpg (100%) rename {images => site/images}/hr.png (100%) rename {images => site/images}/octocat-icon.png (100%) rename {images => site/images}/tar-gz-icon.png (100%) rename {images => site/images}/zip-icon.png (100%) rename index.md => site/index.md (100%) rename {javascripts => site/javascripts}/validator.js (100%) rename {javascripts => site/javascripts}/vendor/codemirror-6.65.7-javascript.min.js (100%) rename {javascripts => site/javascripts}/vendor/codemirror-6.65.7.min.js (100%) rename {javascripts => site/javascripts}/vendor/jquery-3.7.0.min.js (100%) rename {on_the_web => site/on_the_web}/index.md (100%) rename params.json => site/params.json (100%) rename {stylesheets => site/stylesheets}/print.css (100%) rename {stylesheets => site/stylesheets}/pygment_trac.css (100%) rename {stylesheets => site/stylesheets}/stylesheet.css (100%) rename {stylesheets => site/stylesheets}/vendor/codemirror-6.65.7-abbott.min.css (100%) rename {stylesheets => site/stylesheets}/vendor/codemirror-6.65.7.min.css (100%) rename {validator => site/validator}/index.md (100%) diff --git a/.github/workflows/jekyll.yml b/.github/workflows/jekyll.yml index 5640a40..cf99a72 100644 --- a/.github/workflows/jekyll.yml +++ b/.github/workflows/jekyll.yml @@ -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: @@ -22,6 +23,9 @@ concurrency: jobs: # Build job build: + defaults: + run: + working-directory: ./site runs-on: ubuntu-latest steps: - name: Checkout @@ -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: @@ -40,7 +45,7 @@ jobs: uses: actions/upload-artifact@v4 with: name: site - path: _site + path: site/_site overwrite: true # Push job diff --git a/README.md b/README.md index 271ecb6..6bbff60 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ Follow steps: ### Bundle installation ```shell +cd site bundle config set --local path 'vendor/bundle' bundle install ``` @@ -21,6 +22,9 @@ bundle install ### Build and serve the site ```shell +# change directory to site +cd site + # just build the website bundle exec jekyll build diff --git a/.gitignore b/site/.gitignore similarity index 100% rename from .gitignore rename to site/.gitignore diff --git a/CNAME b/site/CNAME similarity index 100% rename from CNAME rename to site/CNAME diff --git a/Gemfile b/site/Gemfile similarity index 100% rename from Gemfile rename to site/Gemfile diff --git a/Gemfile.lock b/site/Gemfile.lock similarity index 100% rename from Gemfile.lock rename to site/Gemfile.lock diff --git a/_config.yml b/site/_config.yml similarity index 100% rename from _config.yml rename to site/_config.yml diff --git a/_data/menu.yml b/site/_data/menu.yml similarity index 100% rename from _data/menu.yml rename to site/_data/menu.yml diff --git a/_includes/footer.html b/site/_includes/footer.html similarity index 100% rename from _includes/footer.html rename to site/_includes/footer.html diff --git a/_includes/head.html b/site/_includes/head.html similarity index 100% rename from _includes/head.html rename to site/_includes/head.html diff --git a/_includes/menu.html b/site/_includes/menu.html similarity index 100% rename from _includes/menu.html rename to site/_includes/menu.html diff --git a/_layouts/default.html b/site/_layouts/default.html similarity index 100% rename from _layouts/default.html rename to site/_layouts/default.html diff --git a/examples/index.md b/site/examples/index.md similarity index 100% rename from examples/index.md rename to site/examples/index.md diff --git a/images/body-bg.png b/site/images/body-bg.png similarity index 100% rename from images/body-bg.png rename to site/images/body-bg.png diff --git a/images/highlight-bg.jpg b/site/images/highlight-bg.jpg similarity index 100% rename from images/highlight-bg.jpg rename to site/images/highlight-bg.jpg diff --git a/images/hr.png b/site/images/hr.png similarity index 100% rename from images/hr.png rename to site/images/hr.png diff --git a/images/octocat-icon.png b/site/images/octocat-icon.png similarity index 100% rename from images/octocat-icon.png rename to site/images/octocat-icon.png diff --git a/images/tar-gz-icon.png b/site/images/tar-gz-icon.png similarity index 100% rename from images/tar-gz-icon.png rename to site/images/tar-gz-icon.png diff --git a/images/zip-icon.png b/site/images/zip-icon.png similarity index 100% rename from images/zip-icon.png rename to site/images/zip-icon.png diff --git a/index.md b/site/index.md similarity index 100% rename from index.md rename to site/index.md diff --git a/javascripts/validator.js b/site/javascripts/validator.js similarity index 100% rename from javascripts/validator.js rename to site/javascripts/validator.js diff --git a/javascripts/vendor/codemirror-6.65.7-javascript.min.js b/site/javascripts/vendor/codemirror-6.65.7-javascript.min.js similarity index 100% rename from javascripts/vendor/codemirror-6.65.7-javascript.min.js rename to site/javascripts/vendor/codemirror-6.65.7-javascript.min.js diff --git a/javascripts/vendor/codemirror-6.65.7.min.js b/site/javascripts/vendor/codemirror-6.65.7.min.js similarity index 100% rename from javascripts/vendor/codemirror-6.65.7.min.js rename to site/javascripts/vendor/codemirror-6.65.7.min.js diff --git a/javascripts/vendor/jquery-3.7.0.min.js b/site/javascripts/vendor/jquery-3.7.0.min.js similarity index 100% rename from javascripts/vendor/jquery-3.7.0.min.js rename to site/javascripts/vendor/jquery-3.7.0.min.js diff --git a/on_the_web/index.md b/site/on_the_web/index.md similarity index 100% rename from on_the_web/index.md rename to site/on_the_web/index.md diff --git a/params.json b/site/params.json similarity index 100% rename from params.json rename to site/params.json diff --git a/stylesheets/print.css b/site/stylesheets/print.css similarity index 100% rename from stylesheets/print.css rename to site/stylesheets/print.css diff --git a/stylesheets/pygment_trac.css b/site/stylesheets/pygment_trac.css similarity index 100% rename from stylesheets/pygment_trac.css rename to site/stylesheets/pygment_trac.css diff --git a/stylesheets/stylesheet.css b/site/stylesheets/stylesheet.css similarity index 100% rename from stylesheets/stylesheet.css rename to site/stylesheets/stylesheet.css diff --git a/stylesheets/vendor/codemirror-6.65.7-abbott.min.css b/site/stylesheets/vendor/codemirror-6.65.7-abbott.min.css similarity index 100% rename from stylesheets/vendor/codemirror-6.65.7-abbott.min.css rename to site/stylesheets/vendor/codemirror-6.65.7-abbott.min.css diff --git a/stylesheets/vendor/codemirror-6.65.7.min.css b/site/stylesheets/vendor/codemirror-6.65.7.min.css similarity index 100% rename from stylesheets/vendor/codemirror-6.65.7.min.css rename to site/stylesheets/vendor/codemirror-6.65.7.min.css diff --git a/validator/index.md b/site/validator/index.md similarity index 100% rename from validator/index.md rename to site/validator/index.md From 2c94afa58365aadaf2aeb475d00e4fdb52366996 Mon Sep 17 00:00:00 2001 From: Baptiste Pernet Date: Tue, 10 Jun 2025 10:49:31 -0400 Subject: [PATCH 02/15] Add Internet Draft --- .github/workflows/setup.yml | 115 +++++++++++++++++++++++ draft-jsonlines-standard-content-type.md | 89 ++++++++++++++++++ 2 files changed, 204 insertions(+) create mode 100644 .github/workflows/setup.yml create mode 100644 draft-jsonlines-standard-content-type.md diff --git a/.github/workflows/setup.yml b/.github/workflows/setup.yml new file mode 100644 index 0000000..99a7f47 --- /dev/null +++ b/.github/workflows/setup.yml @@ -0,0 +1,115 @@ +name: "Perform Initial Repository Setup" + +on: + push: + branches: [internet-draft-template] + +jobs: + pre: + name: "Setup Repository" + runs-on: ubuntu-latest + outputs: + skip: ${{ steps.pre.outputs.skip }} + steps: + - name: "Checkout" + uses: actions/checkout@v4 + + - name: "Precondition Check" + id: pre + run: | + if ! ls draft-* rfc* 2>/dev/null | grep -qv draft-todo-yourname-protocol.md; then + { + echo "------------------------------------------------------------" + echo "Skipping setup for the first commit." + echo + echo "Rename draft-todo-yourname-protocol.md to start using this repository:" + echo + echo "> https://github.com/${{github.repository}}/edit/main/draft-todo-yourname-protocol.md" + echo + echo "Change the name of the file and its title." + echo "Commit the changes to the 'main' branch." + echo + echo "------------------------------------------------------------" + } >>"$GITHUB_STEP_SUMMARY" + echo "skip=true" >>"$GITHUB_OUTPUT" + elif [ ! -f draft-todo-yourname-protocol.md -a -f Makefile ]; then + { + echo "------------------------------------------------------------" + echo "Skipping setup for an already-configured repository." + echo + echo "Delete .github/workflows/setup.yml to avoid running this action:" + echo + echo "> https://github.com/${{github.repository}}/delete/main/.github/workflows/setup.yml" + echo + echo "------------------------------------------------------------" + } >>"$GITHUB_STEP_SUMMARY" + echo "skip=true" >>"$GITHUB_OUTPUT" + else + echo "skip=false" >>"$GITHUB_OUTPUT" + fi + + setup: + name: "Setup Repository" + runs-on: ubuntu-latest + needs: pre + if: ${{ needs.pre.outputs.skip != 'true' }} + permissions: + contents: write + steps: + - name: "Checkout" + uses: actions/checkout@v4 + + - name: "Git Config" + run: | + git config user.email "idbot@example.com" + git config user.name "I-D Bot" + + - name: "Update Draft Name" + run: | + for i in draft-*; do + if [ "$(head -1 "$i")" = "---" ]; then + sed -i -e '2,/^---/{/^###/,/^###/d + s|^docname: .*|docname: '"${i%.md}-latest"'| + s|^ fullname: Your Name Here| fullname: "'"$(git show -q --format='format:%aN' @)"'"| + s|^ email: your\.email@example\.com| email: "'"$(git show -q --format='format:%aE' @)"'"| + }' "$i" + fi + sed -i -e "s/draft-todo-yourname-protocol-latest/${i%.md}-latest/g" "$i" + git add "$i" + done + if [ -n "$(git status --porcelain draft-*)" ]; then + git commit -m "Update draft labels" draft-* + fi + + - name: "Cleanup" + run: | + git rm -rf .github/workflows/setup.yml + git commit -m "Remove setup files" + + - name: "Clone the i-d-template Repo" + run: | + git clone --depth=1 https://github.com/martinthomson/i-d-template lib + + - name: "Run i-d-template Setup" + uses: martinthomson/i-d-template@v1 + with: + make: setup + + - name: "Fix Lint" + uses: martinthomson/i-d-template@v1 + with: + make: fix-lint + + - name: "Update Venue Information" + uses: martinthomson/i-d-template@v1 + with: + make: update-venue + + - name: "Update GitHub Pages" + uses: martinthomson/i-d-template@v1 + with: + make: gh-pages + + - name: "Push Changes" + run: | + git push \ No newline at end of file diff --git a/draft-jsonlines-standard-content-type.md b/draft-jsonlines-standard-content-type.md new file mode 100644 index 0000000..2efa710 --- /dev/null +++ b/draft-jsonlines-standard-content-type.md @@ -0,0 +1,89 @@ +--- +### +# Internet-Draft Markdown Template +# +# Rename this file from draft-todo-yourname-protocol.md to get started. +# Draft name format is "draft---.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----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: JSONLines Standard Content Type +category: info + +docname: draft-todo-yourname-protocol-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: WG@example.com + arch: https://example.com/WG + github: USER/REPO + latest: https://example.com/LATEST + +author: + - + fullname: Your Name Here + organization: Your Organization Here + email: your.email@example.com + +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. \ No newline at end of file From 16b8448a3ef0a5f143bcd173a20ca2a3131a0392 Mon Sep 17 00:00:00 2001 From: I-D Bot Date: Tue, 10 Jun 2025 16:36:18 +0000 Subject: [PATCH 03/15] Update draft labels --- draft-jsonlines-standard-content-type.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/draft-jsonlines-standard-content-type.md b/draft-jsonlines-standard-content-type.md index 2efa710..1a6f89b 100644 --- a/draft-jsonlines-standard-content-type.md +++ b/draft-jsonlines-standard-content-type.md @@ -22,7 +22,7 @@ title: JSONLines Standard Content Type category: info -docname: draft-todo-yourname-protocol-latest +docname: draft-jsonlines-standard-content-type-latest submissiontype: IETF # also: "independent", "editorial", "IAB", or "IRTF" number: date: From 2d8bde548cbb10cfa728cb5752c5b9d81946ae95 Mon Sep 17 00:00:00 2001 From: I-D Bot Date: Tue, 10 Jun 2025 16:36:18 +0000 Subject: [PATCH 04/15] Remove setup files --- .github/workflows/setup.yml | 115 ------------------------------------ 1 file changed, 115 deletions(-) delete mode 100644 .github/workflows/setup.yml diff --git a/.github/workflows/setup.yml b/.github/workflows/setup.yml deleted file mode 100644 index 99a7f47..0000000 --- a/.github/workflows/setup.yml +++ /dev/null @@ -1,115 +0,0 @@ -name: "Perform Initial Repository Setup" - -on: - push: - branches: [internet-draft-template] - -jobs: - pre: - name: "Setup Repository" - runs-on: ubuntu-latest - outputs: - skip: ${{ steps.pre.outputs.skip }} - steps: - - name: "Checkout" - uses: actions/checkout@v4 - - - name: "Precondition Check" - id: pre - run: | - if ! ls draft-* rfc* 2>/dev/null | grep -qv draft-todo-yourname-protocol.md; then - { - echo "------------------------------------------------------------" - echo "Skipping setup for the first commit." - echo - echo "Rename draft-todo-yourname-protocol.md to start using this repository:" - echo - echo "> https://github.com/${{github.repository}}/edit/main/draft-todo-yourname-protocol.md" - echo - echo "Change the name of the file and its title." - echo "Commit the changes to the 'main' branch." - echo - echo "------------------------------------------------------------" - } >>"$GITHUB_STEP_SUMMARY" - echo "skip=true" >>"$GITHUB_OUTPUT" - elif [ ! -f draft-todo-yourname-protocol.md -a -f Makefile ]; then - { - echo "------------------------------------------------------------" - echo "Skipping setup for an already-configured repository." - echo - echo "Delete .github/workflows/setup.yml to avoid running this action:" - echo - echo "> https://github.com/${{github.repository}}/delete/main/.github/workflows/setup.yml" - echo - echo "------------------------------------------------------------" - } >>"$GITHUB_STEP_SUMMARY" - echo "skip=true" >>"$GITHUB_OUTPUT" - else - echo "skip=false" >>"$GITHUB_OUTPUT" - fi - - setup: - name: "Setup Repository" - runs-on: ubuntu-latest - needs: pre - if: ${{ needs.pre.outputs.skip != 'true' }} - permissions: - contents: write - steps: - - name: "Checkout" - uses: actions/checkout@v4 - - - name: "Git Config" - run: | - git config user.email "idbot@example.com" - git config user.name "I-D Bot" - - - name: "Update Draft Name" - run: | - for i in draft-*; do - if [ "$(head -1 "$i")" = "---" ]; then - sed -i -e '2,/^---/{/^###/,/^###/d - s|^docname: .*|docname: '"${i%.md}-latest"'| - s|^ fullname: Your Name Here| fullname: "'"$(git show -q --format='format:%aN' @)"'"| - s|^ email: your\.email@example\.com| email: "'"$(git show -q --format='format:%aE' @)"'"| - }' "$i" - fi - sed -i -e "s/draft-todo-yourname-protocol-latest/${i%.md}-latest/g" "$i" - git add "$i" - done - if [ -n "$(git status --porcelain draft-*)" ]; then - git commit -m "Update draft labels" draft-* - fi - - - name: "Cleanup" - run: | - git rm -rf .github/workflows/setup.yml - git commit -m "Remove setup files" - - - name: "Clone the i-d-template Repo" - run: | - git clone --depth=1 https://github.com/martinthomson/i-d-template lib - - - name: "Run i-d-template Setup" - uses: martinthomson/i-d-template@v1 - with: - make: setup - - - name: "Fix Lint" - uses: martinthomson/i-d-template@v1 - with: - make: fix-lint - - - name: "Update Venue Information" - uses: martinthomson/i-d-template@v1 - with: - make: update-venue - - - name: "Update GitHub Pages" - uses: martinthomson/i-d-template@v1 - with: - make: gh-pages - - - name: "Push Changes" - run: | - git push \ No newline at end of file From 8fade77d7b1712a25da62ae4110c9c53897a693a Mon Sep 17 00:00:00 2001 From: ID Bot Date: Tue, 10 Jun 2025 16:36:20 +0000 Subject: [PATCH 05/15] Setup repository for draft-jsonlines-standard-content-type using https://github.com/martinthomson/i-d-template --- .editorconfig | 8 ++++++++ .github/CODEOWNERS | 3 +++ .gitignore | 24 ++++++++++++++++++++++++ CONTRIBUTING.md | 17 +++++++++++++++++ LICENSE.md | 4 ++++ Makefile | 15 +++++++++++++++ README.md | 45 ++++++++++++++++++++++----------------------- 7 files changed, 93 insertions(+), 23 deletions(-) create mode 100644 .editorconfig create mode 100644 .github/CODEOWNERS create mode 100644 .gitignore create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 Makefile diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..8682023 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,8 @@ +# See http://editorconfig.org + +root = true + +[*.{md,xml,org}] +charset = utf-8 +insert_final_newline = true +trim_trailing_whitespace = true diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..aab34ea --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,3 @@ +# Automatically generated CODEOWNERS +# Regenerate with `make update-codeowners` +draft-jsonlines-standard-content-type.md your.email@example.com diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..15999c5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +*.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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..950e482 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..1753904 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,4 @@ +# License + +See the +[guidelines for contributions](https://github.com/sp4ce/jsonlines/blob/main/CONTRIBUTING.md). diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..9a5d15b --- /dev/null +++ b/Makefile @@ -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 diff --git a/README.md b/README.md index 6bbff60..f47ea51 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,32 @@ -# jsonlines -Documentation for the JSON Lines text file format + -Visit https://jsonlines.org +# JSONLines Standard Content Type -## Development +This is the working area for the individual Internet-Draft, "JSONLines Standard Content Type". -### Jekyll installation +* [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) -Follow steps: -- https://jekyllrb.com/docs/installation/ -- https://jekyllrb.com/docs -### Bundle installation +## 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. -```shell -cd site -bundle config set --local path 'vendor/bundle' -bundle install -``` -### Build and serve the site +## Command Line Usage -```shell -# change directory to site -cd site +Formatted text and HTML versions of the draft can be built using `make`. + +```sh +$ make +``` -# just build the website -bundle exec jekyll build +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). -# build and serve the website on default port -bundle exec jekyll serve -``` \ No newline at end of file From d939f9d010a0225892546f97c22ada5967043008 Mon Sep 17 00:00:00 2001 From: ID Bot Date: Tue, 10 Jun 2025 16:36:21 +0000 Subject: [PATCH 06/15] Automatic update of venue information --- draft-jsonlines-standard-content-type.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/draft-jsonlines-standard-content-type.md b/draft-jsonlines-standard-content-type.md index 1a6f89b..8cf4ca7 100644 --- a/draft-jsonlines-standard-content-type.md +++ b/draft-jsonlines-standard-content-type.md @@ -28,19 +28,19 @@ number: date: consensus: true v: 3 -area: AREA -workgroup: WG Working Group +# area: AREA +# workgroup: WG Working Group keyword: - next generation - unicorn - sparkling distributed ledger venue: - group: WG - type: Working Group - mail: WG@example.com - arch: https://example.com/WG - github: USER/REPO - latest: https://example.com/LATEST +# group: WG +# type: Working Group +# mail: WG@example.com +# arch: https://example.com/WG + github: "sp4ce/jsonlines" + latest: "https://sp4ce.github.io/jsonlines/draft-jsonlines-standard-content-type.html" author: - @@ -86,4 +86,4 @@ This document has no IANA actions. # Acknowledgments {:numbered="false"} -TODO acknowledge. \ No newline at end of file +TODO acknowledge. From ff3345cd8e3965a73dbbaa9544b76804fadb0535 Mon Sep 17 00:00:00 2001 From: Baptiste Pernet Date: Tue, 10 Jun 2025 12:37:02 -0400 Subject: [PATCH 07/15] Update README.md --- README.md | 44 +++++++++++++++++++++++++++++++++++++++----- 1 file changed, 39 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f47ea51..de529b3 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,42 @@ - + -# JSONLines Standard Content Type +# JSON Lines +Documentation for the JSON Lines text file format -This is the working area for the individual Internet-Draft, "JSONLines Standard Content Type". +Visit https://jsonlines.org + +## Website Development + +### Jekyll installation + +Follow steps: +- https://jekyllrb.com/docs/installation/ +- https://jekyllrb.com/docs + +### 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) @@ -10,7 +44,7 @@ This is the working area for the individual Internet-Draft, "JSONLines Standard * [Compare Editor's Copy to Individual Draft](https://sp4ce.github.io/jsonlines/#go.draft-jsonlines-standard-content-type.diff) -## Contributing +### Contributing See the [guidelines for contributions](https://github.com/sp4ce/jsonlines/blob/main/CONTRIBUTING.md). @@ -19,7 +53,7 @@ Contributions can be made by creating pull requests. The GitHub interface supports creating pull requests using the Edit (✏) button. -## Command Line Usage +### Command Line Usage Formatted text and HTML versions of the draft can be built using `make`. From a49e8ed5907c1332f3ec20d0ffb0b3ced85351ea Mon Sep 17 00:00:00 2001 From: Baptiste Pernet Date: Tue, 10 Jun 2025 13:16:11 -0400 Subject: [PATCH 08/15] Update .gitignore --- .gitignore | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.gitignore b/.gitignore index 15999c5..ced4d5f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,14 @@ +# Bundle generated folders +.bundle +vendor/bundle + +# Jekyll generated folders +_site +.sass-cache/ +.jekyll-cache/ +.jekyll-metadata + +# Internet Draft Setup *.html *.pdf *.redxml From 9561116b8eb5c26836a0c1b88efa4a83b7bb900c Mon Sep 17 00:00:00 2001 From: Baptiste Pernet Date: Tue, 10 Jun 2025 12:44:06 -0400 Subject: [PATCH 09/15] Internet Draft workflow --- .github/workflows/internet-draft.yml | 73 ++++++++++++++++++++++++++++ .github/workflows/jekyll.yml | 6 +-- 2 files changed, 76 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/internet-draft.yml diff --git a/.github/workflows/internet-draft.yml b/.github/workflows/internet-draft.yml new file mode 100644 index 0000000..de1bb85 --- /dev/null +++ b/.github/workflows/internet-draft.yml @@ -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 'deploy-bot@jsonlines.org' + git commit --allow-empty -m 'Automated Internet Draft Deployment' + git push diff --git a/.github/workflows/jekyll.yml b/.github/workflows/jekyll.yml index cf99a72..5d45c3b 100644 --- a/.github/workflows/jekyll.yml +++ b/.github/workflows/jekyll.yml @@ -65,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 'deploy-bot@jsonlines.org' - git commit --allow-empty -m 'Automated Deployment' - git push + git commit --allow-empty -m 'Automated Site Deployment' + git push From c85a27d0e1b3b0385a8da162a38197638fd28827 Mon Sep 17 00:00:00 2001 From: Nikita Karamov Date: Tue, 17 Jun 2025 12:17:53 +0200 Subject: [PATCH 10/15] Rename file --- ...-standard-content-type.md => draft-pernetmugnier-json-lines.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename draft-jsonlines-standard-content-type.md => draft-pernetmugnier-json-lines.md (100%) diff --git a/draft-jsonlines-standard-content-type.md b/draft-pernetmugnier-json-lines.md similarity index 100% rename from draft-jsonlines-standard-content-type.md rename to draft-pernetmugnier-json-lines.md From dea6426fbe7e8bb557126ece7e2d516ca225bf40 Mon Sep 17 00:00:00 2001 From: Nikita Karamov Date: Tue, 17 Jun 2025 12:18:32 +0200 Subject: [PATCH 11/15] Use new file name in the document --- draft-pernetmugnier-json-lines.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/draft-pernetmugnier-json-lines.md b/draft-pernetmugnier-json-lines.md index 8cf4ca7..675c75b 100644 --- a/draft-pernetmugnier-json-lines.md +++ b/draft-pernetmugnier-json-lines.md @@ -22,7 +22,7 @@ title: JSONLines Standard Content Type category: info -docname: draft-jsonlines-standard-content-type-latest +docname: draft-pernetmugnier-json-lines-latest submissiontype: IETF # also: "independent", "editorial", "IAB", or "IRTF" number: date: @@ -39,8 +39,8 @@ venue: # type: Working Group # mail: WG@example.com # arch: https://example.com/WG - github: "sp4ce/jsonlines" - latest: "https://sp4ce.github.io/jsonlines/draft-jsonlines-standard-content-type.html" + github: "sp4ce/jsonlines" + latest: "https://sp4ce.github.io/jsonlines/draft-pernetmugnier-json-lines.html" author: - @@ -86,4 +86,4 @@ This document has no IANA actions. # Acknowledgments {:numbered="false"} -TODO acknowledge. +TODO acknowledge. From b2af930142b3f0b5ab8f51959da5d0ed220389e1 Mon Sep 17 00:00:00 2001 From: Nikita Karamov Date: Tue, 17 Jun 2025 12:19:02 +0200 Subject: [PATCH 12/15] Rename the draft itself --- draft-pernetmugnier-json-lines.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/draft-pernetmugnier-json-lines.md b/draft-pernetmugnier-json-lines.md index 675c75b..782a64c 100644 --- a/draft-pernetmugnier-json-lines.md +++ b/draft-pernetmugnier-json-lines.md @@ -19,7 +19,8 @@ # Change the file extension to match the format (.xml for XML, etc...) # ### -title: JSONLines Standard Content Type +title: JavaScript Object Notation (JSON) Lines +abbrev: JSON Lines category: info docname: draft-pernetmugnier-json-lines-latest From f9c6f20577db09158fb009886bed15ef46da1147 Mon Sep 17 00:00:00 2001 From: Baptiste Pernet-Mugnier Date: Wed, 25 Jun 2025 11:06:35 -0400 Subject: [PATCH 13/15] Update draft-pernetmugnier-json-lines.md --- draft-pernetmugnier-json-lines.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/draft-pernetmugnier-json-lines.md b/draft-pernetmugnier-json-lines.md index 782a64c..16ad740 100644 --- a/draft-pernetmugnier-json-lines.md +++ b/draft-pernetmugnier-json-lines.md @@ -41,13 +41,13 @@ venue: # mail: WG@example.com # arch: https://example.com/WG github: "sp4ce/jsonlines" - latest: "https://sp4ce.github.io/jsonlines/draft-pernetmugnier-json-lines.html" + latest: "https://sp4ce.github.io/jsonlines/internet-draft/draft-pernetmugnier-json-lines.html" author: - - fullname: Your Name Here + fullname: Baptiste Pernet-Mugnier organization: Your Organization Here - email: your.email@example.com + email: baptiste.pm@protonmail.com normative: From d86fb6c5e2741db13ec2fc7610742b72d9c53204 Mon Sep 17 00:00:00 2001 From: Baptiste Pernet-Mugnier Date: Wed, 25 Jun 2025 11:09:55 -0400 Subject: [PATCH 14/15] Update draft-pernetmugnier-json-lines.md --- draft-pernetmugnier-json-lines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/draft-pernetmugnier-json-lines.md b/draft-pernetmugnier-json-lines.md index 16ad740..984a7b5 100644 --- a/draft-pernetmugnier-json-lines.md +++ b/draft-pernetmugnier-json-lines.md @@ -47,7 +47,7 @@ author: - fullname: Baptiste Pernet-Mugnier organization: Your Organization Here - email: baptiste.pm@protonmail.com + email: baptiste.pernetmugnier@gmail.com normative: From 5dd97977265e999d4b194d07f7046a342487da3f Mon Sep 17 00:00:00 2001 From: Baptiste Pernet-Mugnier Date: Wed, 25 Jun 2025 11:17:39 -0400 Subject: [PATCH 15/15] Delete CODEOWNERS --- .github/CODEOWNERS | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index aab34ea..0000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1,3 +0,0 @@ -# Automatically generated CODEOWNERS -# Regenerate with `make update-codeowners` -draft-jsonlines-standard-content-type.md your.email@example.com