diff --git a/EIPS/dcip-1.md b/DCIPs/dcip-1.md similarity index 88% rename from EIPS/dcip-1.md rename to DCIPs/dcip-1.md index c074ad2..a3886ff 100644 --- a/EIPS/dcip-1.md +++ b/DCIPs/dcip-1.md @@ -1,9 +1,11 @@ --- -eip: 1 +dcip: 1 title: DCIP-1(unfinished) DCIP Purpose and Guidelines author: Omar Octavio Huerta Valdez (@bleeckersteker) -status: Living type: Standards Track +status: Living category: Core +layout: post created: --- + diff --git a/EIPS/dcip-2.md b/DCIPs/dcip-2.md similarity index 99% rename from EIPS/dcip-2.md rename to DCIPs/dcip-2.md index 7b32756..408fc91 100644 --- a/EIPS/dcip-2.md +++ b/DCIPs/dcip-2.md @@ -1,11 +1,12 @@ --- -eip: 2 +dcip: 2 title: DCIP-2 Meetings author: David E. Perez Negron R. (@P1R) status: Final type: Standards Track category: Core created: 2023-02-01 +layout: post --- ## Simple Summary diff --git a/EIPS/dcip-3.md b/DCIPs/dcip-3.md similarity index 87% rename from EIPS/dcip-3.md rename to DCIPs/dcip-3.md index 65282f2..594cb46 100644 --- a/EIPS/dcip-3.md +++ b/DCIPs/dcip-3.md @@ -1,9 +1,10 @@ --- -eip: 3 +dcip: 3 title: DCIP-3(unfinished) Tasks author: David E. Perez Negron R. (@P1R) -status: Living type: Standards Track category: Core +status: Living created: +layout: post --- diff --git a/README.md b/README.md index 09f4a06..bb7ae23 100644 --- a/README.md +++ b/README.md @@ -1,83 +1,13 @@ # Decentralized Climate Improvement Proposals (DCIPs) -The goal of the DCIP project is to standardize and provide high-quality documentation for Decentralized Climate itself and conventions built upon it. This repository tracks past and ongoing improvements to Decentralized Climate in the form of Decentralized Climate Improvement Proposals (DCIPs). [DCIP-1](dcips.decentralizedclimate.org/EIPS/dcip-1) governs how DCIPs are published. +The goal of the DCIP project is to standardize and provide high-quality documentation for Decentralized Climate itself and conventions built upon it. This repository tracks past and ongoing improvements to Decentralized Climate in the form of Decentralized Climate Improvement Proposals (DCIPs). [DCIP-1](dcips.decentralizedclimate.org/DCIPS/dcip-1) governs how DCIPs are published. The [status page](https://dcips.decentralizedclimate.org/) tracks and lists DCIPs, which can be divided into the following categories: - [Core DCIPs](https://dcips.decentralizedclimate.org/core) are improvements to the Decentralized Climate consensus protocol. - [Networking DCIPs](https://dcips.decentralizedclimate.org/networking) specify the peer-to-peer networking layer of Decentralized Climate. - [Interface DCIPs](https://dcips.decentralizedclimate.org/interface) standardize interfaces to Decentralized Climate, which determine how users and applications interact with the blockchain. -- [ERCs](https://dcips.decentralizedclimate.org/erc) specify application layer standards, which determine how applications running on Decentralized Climate can interact with each other. + - [Meta DCIPs](https://dcips.decentralizedclimate.org/meta) are miscellaneous improvements that nonetheless require some sort of consensus. -- [Informational DCIPs](https://eips.decentralizedclimate.org/informational) are non-standard improvements that do not require any form of consensus. +- [Informational DCIPs](https://dcips.decentralizedclimate.org/informational) are non-standard improvements that do not require any form of consensus. -**Before you write an DCIP, ideas MUST be thoroughly discussed on [Decentralized Climate Magicians](https://ethereum-magicians.org/) or [Decentralized Climate Research](https://ethresear.ch/t/read-this-before-posting/8). Once consensus is reached, thoroughly read and review [EIP-1](https://eips.ethereum.org/EIPS/eip-1), which describes the EIP process.** - -Please note that this repository is for documenting standards and not for help implementing them. These types of inquiries should be directed to the [Decentralized Climate Stack Exchange](https://ethereum.stackexchange.com). For specific questions and concerns regarding EIPs, it's best to comment on the relevant discussion thread of the EIP denoted by the `discussions-to` tag in the EIP's preamble. - -If you would like to become an EIP Editor, please read [EIP-5069](./EIPS/eip-5069.md). - -## Preferred Citation Format - -The canonical URL for an EIP that has achieved draft status at any point is at . For example, the canonical URL for EIP-1 is . - -Consider any document not published at as a working paper. Additionally, consider published EIPs with a status of "draft", "review", or "last call" to be incomplete drafts, and note that their specification is likely to be subject to change. - -## Validation and Automerging - -All pull requests in this repository must pass automated checks before they can be automatically merged: - -- [eip-review-bot](https://github.com/ethereum/eip-review-bot/) determines when PRs can be automatically merged [^1] -- DCIP-1 rules are enforced using [`eipw`](https://github.com/ethereum/eipw)[^2] -- HTML formatting and broken links are enforced using [HTMLProofer](https://github.com/gjtorikian/html-proofer)[^2] -- Spelling is enforced with [CodeSpell](https://github.com/codespell-project/codespell)[^2] - - False positives sometimes occur. When this happens, please submit a PR editing [.codespell-whitelist](https://github.com/ethereum/EIPs/blob/master/config/.codespell-whitelist) and **ONLY** .codespell-whitelist -- Markdown best practices are checked using [markdownlint](https://github.com/DavidAnson/markdownlint)[^2] - -[^1]: https://github.com/ethereum/EIPs/blob/master/.github/workflows/auto-review-bot.yml -[^2]: https://github.com/ethereum/EIPs/blob/master/.github/workflows/ci.yml - -It is possible to run the DCIP validator locally: - -```sh -cargo install eipv -eipv -``` - -## Build the status page locally - -### Install prerequisites - -1. Open Terminal. - -2. Check whether you have Ruby 2.1.0 or higher installed: - - ```sh - ruby --version - ``` - -3. If you don't have Ruby installed, install Ruby 2.1.0 or higher. - -4. Install Bundler: - - ```sh - gem install bundler - ``` - -5. Install dependencies: - - ```sh - bundle install - ``` - -### Build your local Jekyll site - -1. Bundle assets and start the server: - - ```sh - bundle exec jekyll serve - ``` - -2. Preview your local Jekyll site in your web browser at `http://localhost:4000`. - -More information on Jekyll and GitHub Pages [here](https://docs.github.com/en/enterprise/2.14/user/articles/setting-up-your-github-pages-site-locally-with-jekyll). diff --git a/_config.yml b/_config.yml index e25ae80..ecc32f3 100644 --- a/_config.yml +++ b/_config.yml @@ -18,7 +18,7 @@ description: >- Decentralized Climate Foundation (DCIPs) describe standards for the Decentralized Climate platform, including core protocol specifications, client APIs, and contract standards. -url: "dcips.decentralizedclimate.org" +url: "dcips.decentralizedclimate.org/" github_username: DECENTRALIZEDCLIMATE repository: DECENTRALIZEDCLIMATE/DCIPs @@ -27,7 +27,6 @@ header_pages: - core.html - networking.html - interface.html - - erc.html - meta.html - informational.html @@ -37,7 +36,7 @@ markdown: kramdown theme: minima kramdown: parse_block_html: false - # This is the default, but be explicit as some EIPs depend on it + # This is the default, but be explicit as some DCIPs depend on it auto_ids: true # This is to ensure more determistic behaviour auto_id_stripping: true @@ -45,10 +44,16 @@ kramdown: permalink: /:slug + +collections: + dcip: + output: true + + defaults: - scope: - path: "DCIPS" + path: "DCIPs" values: layout: "dcip" @@ -61,7 +66,7 @@ exclude: - vendor/cache/ - vendor/gems/ - vendor/ruby/ - - eip-template.md + - dcip-template.md - ISSUE_TEMPLATE.md - PULL_REQUEST_TEMPLATE.md - README.md diff --git a/_includes/dcipnums.html b/_includes/dcipnums.html new file mode 100644 index 0000000..f72fb0d --- /dev/null +++ b/_includes/dcipnums.html @@ -0,0 +1,4 @@ +{% assign dcips=include.dcips|split:"," %} +{% for dcipnum in dcips %} + DCIP-{{dcipnum|strip}}{% if forloop.last == false %}, {% endif %} +{% endfor %} diff --git a/_includes/eiptable.html b/_includes/dciptable.html similarity index 56% rename from _includes/eiptable.html rename to _includes/dciptable.html index e2e2a78..3c8b304 100644 --- a/_includes/eiptable.html +++ b/_includes/dciptable.html @@ -1,29 +1,29 @@ {% for status in site.data.statuses %} - {% assign eips = include.eips|where:"status",status|sort:"eip" %} - {% assign count = eips|size %} + {% assign dcips = include.dcips|where:"status",status|sort:"dcip" %} + {% assign count = dcips|size %} {% if count > 0 %}

{{status}}

- +
{% if status == "Last Call" %} - + {% else %} - + {% endif %} - {% for page in eips %} + {% for page in dcips %} - + {% if status == "Last Call" and page.last-call-deadline != undefined %} {% endif %} diff --git a/_includes/eipnums.html b/_includes/eipnums.html deleted file mode 100644 index 4edcd30..0000000 --- a/_includes/eipnums.html +++ /dev/null @@ -1,4 +0,0 @@ -{% assign eips=include.eips|split:"," %} -{% for eipnum in eips %} - EIP-{{eipnum|strip}}{% if forloop.last == false %}, {% endif %} -{% endfor %} diff --git a/_includes/head.html b/_includes/head.html index b7bb45f..20aa707 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -2,13 +2,10 @@ - {% if page.layout == "eip" %} - {% if page.category == "ERC" %} - ERC-{{ page.eip }}: {{ page.title | escape }} - - {% else %} - EIP-{{ page.eip }}: {{ page.title | escape }} - + {% if page.layout == "dcip" %} + {% if page.category == "DCIP" %} + DCIP-{{ page.dcip }}: {{ page.title | escape }} + {% endif %} diff --git a/_includes/social.html b/_includes/social.html index a4983cc..bd1dc71 100644 --- a/_includes/social.html +++ b/_includes/social.html @@ -2,7 +2,7 @@ {%- if site.dribbble_username -%}
  • {{ site.dribbble_username| escape }}
    • {%- endif -%} {%- if site.facebook_username -%}
  • {{ site.facebook_username| escape }}
    • {%- endif -%} {%- if site.flickr_username -%}
  • {{ site.flickr_username| escape }}
    • {%- endif -%} -
  • ethereum/EIPs
    • +
  • DECENTALIZEDCLIMATE
    • {%- if site.instagram_username -%}
  • {{ site.instagram_username| escape }}
    • {%- endif -%} {%- if site.linkedin_username -%}
  • {{ site.linkedin_username| escape }}
    • {%- endif -%} {%- if site.pinterest_username -%}
  • {{ site.pinterest_username| escape }}
    • {%- endif -%} diff --git a/_layouts/eip.html b/_layouts/dcip.html similarity index 64% rename from _layouts/eip.html rename to _layouts/dcip.html index a2d3c06..40f454a 100644 --- a/_layouts/eip.html +++ b/_layouts/dcip.html @@ -20,36 +20,31 @@ layout: default
    {% if page.status == "Stagnant" %} - 🚧 Stagnant + 🚧 Stagnant {% endif %} {% if page.status == "Withdrawn" %} - 🛑 Withdrawn + 🛑 Withdrawn {% endif %} {% if page.status == "Draft" or page.status == "Review" %} - ⚠️ {{ page.status }} + ⚠️ {{ page.status }} {% endif %} {% if page.status == "Last Call" %} - 📢 Last Call + 📢 Last Call {% endif %} - {% if page.category == "ERC" %} - Standards Track: ERC {% elsif page.category == "Interface" %} Standards Track: Interface {% elsif page.category == "Networking" %} - Standards Track: Networking + Standards Track: Networking {% elsif page.category == "Core" %} Standards Track: Core {% elsif page.type == "Informational" %} - Informational + Informational {% elsif page.type == "Meta" %} - Meta + Meta {% endif %}

    - {% if page.category == "ERC" %} - ERC-{{ page.eip | xml_escape }}: {{ page.title | xml_escape }} - {% elsif page.category != "ERC" %} - EIP-{{ page.eip | xml_escape }}: {{ page.title | xml_escape }} + DCIP-{{ page.dcip | xml_escape }}: {{ page.title | xml_escape }} {% endif %} @@ -90,7 +85,7 @@ layout: default {% if page.requires != undefined %}
    Requires - {% include eipnums.html eips=page.requires %} + {% include dcipnums.html dcips=page.requires %}
    {% endif %}

    @@ -101,7 +96,7 @@ layout: default {% endif %} @@ -119,7 +114,7 @@ layout: default IEEE specification for reference formatting: https://ieee-dataport.org/sites/default/files/analysis/27/IEEE%20Citation%20Guidelines.pdf {% endcomment %} -

    {% include authorlist.html authors=page.author %}, "{% if page.category == "ERC" %}ERC{% else %}EIP{% endif %}-{{ page.eip | xml_escape }}: {{ page.title | xml_escape }}{% if page.status == "Draft" or page.status == "Stagnant" or page.status == "Withdrawn" or page.status == "Review" or page.status == "Last Call" %} [DRAFT]{% endif %}," Ethereum Improvement Proposals, no. {{ page.eip | xml_escape }}, {{ page.created | date: "%B %Y" }}. [Online serial]. Available: https://eips.ethereum.org/EIPS/eip-{{ page.eip | xml_escape }}.

    +

    {% include authorlist.html authors=page.author %}, "{% if page.category == "{% else %}DCIP{% endif %}-{{ page.dcip | xml_escape }}: {{ page.title | xml_escape }}{% if page.status == "Draft" or page.status == "Stagnant" or page.status == "Withdrawn" or page.status == "Review" or page.status == "Last Call" %} [DRAFT]{% endif %}," Decentralized Climate Foundation, no. {{ page.dcip | xml_escape }}, {{ page.created | date: "%B %Y" }}. [Online serial]. Available: https://dcips.decentralizedclimate.org/DCIPS/dcip-{{ page.dcip | xml_escape }}.

    {% comment %} Article schema specification: @@ -129,12 +124,8 @@ https://schema.org/TechArticle { "@context": "http://schema.org", "@type": "TechArticle", - {% if page.category == "ERC" %} - "headline": "ERC-{{ page.eip | xml_escape }}: {{ page.title | xml_escape }}{% if page.status == "Draft" or page.status == "Stagnant" or page.status == "Withdrawn" or page.status == "Review" or page.status == "Last Call" %} [DRAFT]{% endif %}", - "name": "ERC-{{ page.eip | xml_escape }}: {{ page.title | xml_escape }}{% if page.status == "Draft" or page.status == "Stagnant" or page.status == "Withdrawn" or page.status == "Review" or page.status == "Last Call" %} [DRAFT]{% endif %}", - {% else %} - "headline": "EIP-{{ page.eip | xml_escape }}: {{ page.title | xml_escape }}{% if page.status == "Draft" or page.status == "Stagnant" or page.status == "Withdrawn" or page.status == "Review" or page.status == "Last Call" %} [DRAFT]{% endif %}", - "name": "EIP-{{ page.eip | xml_escape }}: {{ page.title | xml_escape }}{% if page.status == "Draft" or page.status == "Stagnant" or page.status == "Withdrawn" or page.status == "Review" or page.status == "Last Call" %} [DRAFT]{% endif %}", + "headline": "DCIP-{{ page.dcip | xml_escape }}: {{ page.title | xml_escape }}{% if page.status == "Draft" or page.status == "Stagnant" or page.status == "Withdrawn" or page.status == "Review" or page.status == "Last Call" %} [DRAFT]{% endif %}", + "name": "DCIP-{{ page.dcip | xml_escape }}: {{ page.title | xml_escape }}{% if page.status == "Draft" or page.status == "Stagnant" or page.status == "Withdrawn" or page.status == "Review" or page.status == "Last Call" %} [DRAFT]{% endif %}", {% endif %} "author": "{{ page.author }}", "dateCreated": "{{ page.created | date: "%Y-%m-%d" }}", diff --git a/all.html b/all.html index d57a5a9..4ed0e36 100644 --- a/all.html +++ b/all.html @@ -3,4 +3,4 @@ layout: page title: All --- -{% include eiptable.html eips=site.pages %} +{% include dciptable.html dcips=site.pages %} diff --git a/config/.jekyll-labels.yml b/config/.jekyll-labels.yml index 56f96e9..d1f871a 100644 --- a/config/.jekyll-labels.yml +++ b/config/.jekyll-labels.yml @@ -1,4 +1,4 @@ -#### EIP Type / Category #### +#### DCIP Type / Category #### # Type t-informational: this?.new?.type == "Informational" && this?.old?.status != "Living" @@ -8,10 +8,9 @@ t-meta: this?.new?.type == "Meta" && this?.old?.status != "Living" t-core: this?.new?.category == "Core" && this?.old?.status != "Living" t-networking: this?.new?.category == "Networking" && this?.old?.status != "Living" t-interface: this?.new?.category == "Interface" && this?.old?.status != "Living" -t-erc: this?.new?.category == "ERC" && this?.old?.status != "Living" -# Living EIPs & EIP Template -t-process: this?.old?.status == "Living" || this?.old?.title == "" +# Living DCIPs & DCIP Template +t-process: this?.old?.status == "Living" || this?.old?.title == "" # Status s-draft: this?.new?.status == "Draft" diff --git a/config/eip-editors.yml b/config/dcip-editors.yml similarity index 98% rename from config/eip-editors.yml rename to config/dcip-editors.yml index e404663..4e6a923 100644 --- a/config/eip-editors.yml +++ b/config/dcip-editors.yml @@ -11,7 +11,7 @@ core: - SamWilsn - Pandapip1 - g11tech -erc: +dcrc: - axic - SamWilsn - Pandapip1 diff --git a/config/ipfs-config.json b/config/ipfs-config.json new file mode 100644 index 0000000..fa02b56 --- /dev/null +++ b/config/ipfs-config.json @@ -0,0 +1,24 @@ +{ + + "public": true, + "files": [ + { + "path": "/home/team1/DCIPs/DCIPs/dcip-1.md", + "cid": "", + "contentType": "text/markdown" + }, + { + "path": "/home/team1/DCIPs/DCIPs/dcip-2.md", + "cid": "", + "contentType": "text/markdown" + }, + { + "path": "/home/team1/DCIPs/DCIPs/dcip-3.md", + "cid": "", + "contentType": "text/markdown" + } + + ] + + } + diff --git a/core.html b/core.html index 29cceb2..df870d6 100644 --- a/core.html +++ b/core.html @@ -3,5 +3,5 @@ layout: page title: Core --- -{% assign eips=site.pages|where:"type","Standards Track"|where:"category","Core" %} -{% include eiptable.html eips=eips %} +{% assign dcips=site.pages|where:"type","Standards Track"|where:"category","Core" %} +{% include dciptable.html dcips=dcips %} diff --git a/eip-template.md b/dcip-template.md similarity index 60% rename from eip-template.md rename to dcip-template.md index 892fda1..1393919 100644 --- a/eip-template.md +++ b/dcip-template.md @@ -1,23 +1,23 @@ --- -title: +title: description: author: , FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)> discussions-to: status: Draft type: -category: # Only required for Standards Track. Otherwise, remove this field. +category: # Only required for Standards Track. Otherwise, remove this field. created: -requires: # Only required when you reference an EIP in the `Specification` section. Otherwise, remove this field. +requires: # Only required when you reference an DCIP in the `Specification` section. Otherwise, remove this field. --- @@ -35,9 +35,9 @@ requires: # Only required when you reference an EIP in the `Spec @@ -45,7 +45,7 @@ requires: # Only required when you reference an EIP in the `Spec ## Specification @@ -98,7 +98,7 @@ No backward compatibility issues found. This section is optional. The Reference Implementation section should include a minimal implementation that assists in understanding or implementing this specification. It should not include project build files. The reference implementation is not a replacement for the Specification section, and the proposal should still be understandable without it. - If the reference implementation is too large to reasonably be included inline, then consider adding it as one or more files in `../assets/eip-####/`. External links will not be allowed. + If the reference implementation is too large to reasonably be included inline, then consider adding it as one or more files in `../assets/dcip-####/`. External links will not be allowed. TODO: Remove this comment before submitting --> @@ -106,7 +106,7 @@ No backward compatibility issues found. ## Security Considerations
    NumberReview endsTitleAuthor
    NumberReview endsTitleAuthor
    NumberTitleAuthor
    NumberTitleAuthor
    {{page.eip|xml_escape}}{{page.dcip|xml_escape}}{{ page.last-call-deadline | xml_escape }}