From e8c02a8dddd9d084070198d66214998c87e4988e Mon Sep 17 00:00:00 2001 From: Baptiste Pernet Date: Wed, 21 May 2025 12:10:33 -0400 Subject: [PATCH 1/3] Add rfc section --- examples/index.html | 1 + index.html | 1 + on_the_web/index.html | 1 + rfc/index.html | 44 +++++++++++++++++++++++++++++++++++++++++++ validator/index.html | 1 + 5 files changed, 48 insertions(+) create mode 100644 rfc/index.html diff --git a/examples/index.html b/examples/index.html index 1b401a8..c6e1ae3 100644 --- a/examples/index.html +++ b/examples/index.html @@ -27,6 +27,7 @@

Examples

  • Examples
  • Validator
  • On the web
    • +
  • RFC (draft)
  • json.org
    • diff --git a/index.html b/index.html index 71c613d..127ea05 100644 --- a/index.html +++ b/index.html @@ -25,6 +25,7 @@

    Documentation for the JSON Lines text file format

  • Examples
  • Validator
  • On the web
    • +
  • RFC (draft)
  • json.org
    • diff --git a/on_the_web/index.html b/on_the_web/index.html index 5192c6b..ab58519 100644 --- a/on_the_web/index.html +++ b/on_the_web/index.html @@ -27,6 +27,7 @@

    On the web

  • Examples
  • Validator
  • On the web
    • +
  • RFC (draft)
  • json.org
    • diff --git a/rfc/index.html b/rfc/index.html new file mode 100644 index 0000000..b562fb3 --- /dev/null +++ b/rfc/index.html @@ -0,0 +1,44 @@ + + + + + + + + + + + RFC (Draft) + + +
    +
    +
    +

    JSON Lines

    +

    RFC (Draft)

    +
    + +
    +
    + In Progress +
    + +
    +
    + + diff --git a/validator/index.html b/validator/index.html index 240b6ab..dcd2ee9 100644 --- a/validator/index.html +++ b/validator/index.html @@ -31,6 +31,7 @@

    Validator

  • Examples
  • Validator
  • On the web
    • +
  • RFC (draft)
  • json.org
    • From 9ab6cde9200f98c8e05535b16f0aac3cbd3b200f Mon Sep 17 00:00:00 2001 From: Baptiste Pernet Date: Fri, 6 Jun 2025 16:45:39 -0400 Subject: [PATCH 2/3] Add template from martinthomson --- Gemfile.lock | 19 ++---- _data/menu.yml | 2 + rfc/draft-jsonlines-standard_mime_type.md | 73 +++++++++++++++++++++++ rfc/index.html | 44 -------------- 4 files changed, 79 insertions(+), 59 deletions(-) create mode 100644 rfc/draft-jsonlines-standard_mime_type.md delete mode 100644 rfc/index.html diff --git a/Gemfile.lock b/Gemfile.lock index 7db7d62..4c97200 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -10,17 +10,9 @@ GEM eventmachine (>= 0.12.9) http_parser.rb (~> 0) eventmachine (1.2.7) - ffi (1.17.2-arm64-darwin) - ffi (1.17.2-x86_64-darwin) - ffi (1.17.2-x86_64-linux-gnu) + ffi (1.17.2) forwardable-extended (2.6.0) - google-protobuf (4.31.0-arm64-darwin) - bigdecimal - rake (>= 13) - google-protobuf (4.31.0-x86_64-darwin) - bigdecimal - rake (>= 13) - google-protobuf (4.31.0-x86_64-linux-gnu) + google-protobuf (4.31.0) bigdecimal rake (>= 13) http_parser.rb (0.8.0) @@ -65,12 +57,9 @@ GEM rexml (3.4.1) rouge (4.5.2) safe_yaml (1.0.5) - sass-embedded (1.89.0-arm64-darwin) - google-protobuf (~> 4.31) - sass-embedded (1.89.0-x86_64-darwin) - google-protobuf (~> 4.31) - sass-embedded (1.89.0-x86_64-linux-gnu) + sass-embedded (1.89.1) google-protobuf (~> 4.31) + rake (>= 13) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) unicode-display_width (2.6.0) diff --git a/_data/menu.yml b/_data/menu.yml index e110bf2..2078117 100644 --- a/_data/menu.yml +++ b/_data/menu.yml @@ -7,5 +7,7 @@ items: url: '/validator/' - label: 'On the web' url: '/on_the_web/' + - label: 'Internet Draft' + url: '/rfc/draft-jsonlines-standard_mime_type.html' - label: 'json.org' url: 'https://json.org' diff --git a/rfc/draft-jsonlines-standard_mime_type.md b/rfc/draft-jsonlines-standard_mime_type.md new file mode 100644 index 0000000..f9d8874 --- /dev/null +++ b/rfc/draft-jsonlines-standard_mime_type.md @@ -0,0 +1,73 @@ +--- +layout: default +title: Internet Draft +--- +title: "application/jsonl Standard MIME 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 diff --git a/rfc/index.html b/rfc/index.html deleted file mode 100644 index b562fb3..0000000 --- a/rfc/index.html +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - - - - RFC (Draft) - - -
    -
    -
    -

    JSON Lines

    -

    RFC (Draft)

    -
    - -
    -
    - In Progress -
    - -
    -
    - - From e18a9fedd972a3723c97fae17dad84670bcf7edf Mon Sep 17 00:00:00 2001 From: Baptiste Pernet Date: Sat, 7 Jun 2025 11:15:48 -0400 Subject: [PATCH 3/3] Add draft setup workflow --- .github/workflows/draft-setup.yml | 116 ++++++++++++++++++ _data/menu.yml | 2 +- ... => draft-jsonlines-standard-mime-type.md} | 0 3 files changed, 117 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/draft-setup.yml rename rfc/{draft-jsonlines-standard_mime_type.md => draft-jsonlines-standard-mime-type.md} (100%) diff --git a/.github/workflows/draft-setup.yml b/.github/workflows/draft-setup.yml new file mode 100644 index 0000000..a6c24e3 --- /dev/null +++ b/.github/workflows/draft-setup.yml @@ -0,0 +1,116 @@ +name: "Perform Initial Repository Setup" + +on: + push: + branches: [main] + +jobs: + pre: + name: "Setup Repository" + runs-on: ubuntu-latest + defaults: + run: + working-directory: ./rfc + 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 + defaults: + run: + working-directory: ./rfc + 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 README.md + 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: "Push Changes" + run: | + git push \ No newline at end of file diff --git a/_data/menu.yml b/_data/menu.yml index 2078117..8eafeaf 100644 --- a/_data/menu.yml +++ b/_data/menu.yml @@ -8,6 +8,6 @@ items: - label: 'On the web' url: '/on_the_web/' - label: 'Internet Draft' - url: '/rfc/draft-jsonlines-standard_mime_type.html' + url: '/rfc/draft-jsonlines-standard-mime-type.html' - label: 'json.org' url: 'https://json.org' diff --git a/rfc/draft-jsonlines-standard_mime_type.md b/rfc/draft-jsonlines-standard-mime-type.md similarity index 100% rename from rfc/draft-jsonlines-standard_mime_type.md rename to rfc/draft-jsonlines-standard-mime-type.md