From d7f30dc9ffa22ee01f0026c81c84b982816af306 Mon Sep 17 00:00:00 2001 From: Derek Lewis Date: Mon, 3 Feb 2020 03:55:42 -0500 Subject: [PATCH 1/5] Move features doc to archive dir --- doc/{features.md => archive/features_2020-02-12.md} | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) rename doc/{features.md => archive/features_2020-02-12.md} (87%) diff --git a/doc/features.md b/doc/archive/features_2020-02-12.md similarity index 87% rename from doc/features.md rename to doc/archive/features_2020-02-12.md index 24d7a42..3bccf63 100644 --- a/doc/features.md +++ b/doc/archive/features_2020-02-12.md @@ -1,6 +1,12 @@ -# Features +| This document has been archived. It is now read-only. | +|---| + +| Date archived | Reason | Description | +|---|---|---| +| 12 February 2020 | Cause of confusion | This section, which previously existed in this repo's root README, was written for the new ECMAScript modules implementation initially created for Node 12.0.0. This feature list informed what became the [plan](../plan-for-new-modules-implementation.md) for that implementation. | -> The below list of features was written for the new ECMAScript modules implementation that was created for Node 12.0.0. These features informed what became the [plan](./plan-for-new-modules-implementation.md) for that implementation. + +# Features Based on [these use cases](./doc/use-cases.md) ([#55](https://github.com/nodejs/modules/issues/55)), our implementation aims to support the following features (subject to change): From 5e49fc792da2140ed7323bd0dea84801fa23a884 Mon Sep 17 00:00:00 2001 From: Derek Lewis Date: Mon, 3 Feb 2020 04:03:23 -0500 Subject: [PATCH 2/5] Improve Archives section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b56ecb1..12d5544 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ Work includes: ## Archives -As part of creating the ECMAScript Modules implementation for Node.js 12.0.0, [use cases](./doc/use-cases.md) were brainstormed, which led to a list of [features](./doc/features.md), which guided the [plan for the implementation](./doc/plan-for-new-modules-implementation.md). +- **[`features_2020-02-12.md`](./doc/archive/features_2020-02-12.md)**: As part of creating the ECMAScript Modules implementation for Node.js 12.0.0, [use cases](./doc/use-cases.md) were brainstormed, which led to a list of features that guided the [plan for the implementation](./doc/plan-for-new-modules-implementation.md). ## Members From 3c47d571f7ec082b901ce42be36c40fee99a4299 Mon Sep 17 00:00:00 2001 From: Derek Lewis Date: Wed, 5 Feb 2020 00:22:33 -0500 Subject: [PATCH 3/5] arch: match description on README and archived document --- README.md | 2 +- doc/archive/{features_2020-02-12.md => features.md} | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) rename doc/archive/{features_2020-02-12.md => features.md} (90%) diff --git a/README.md b/README.md index 12d5544..282763c 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ Work includes: ## Archives -- **[`features_2020-02-12.md`](./doc/archive/features_2020-02-12.md)**: As part of creating the ECMAScript Modules implementation for Node.js 12.0.0, [use cases](./doc/use-cases.md) were brainstormed, which led to a list of features that guided the [plan for the implementation](./doc/plan-for-new-modules-implementation.md). +- **[`features.md`](./doc/archive/features.md)**: As part of creating the ECMAScript Modules implementation for Node.js 12.0.0, [use cases](./doc/use-cases.md) were brainstormed, which led to a list of features. This feature list, which previously existed as a section in this repo's root README, informed what became the [plan for the implementation](./doc/plan-for-new-modules-implementation.md). ## Members diff --git a/doc/archive/features_2020-02-12.md b/doc/archive/features.md similarity index 90% rename from doc/archive/features_2020-02-12.md rename to doc/archive/features.md index 3bccf63..bab055f 100644 --- a/doc/archive/features_2020-02-12.md +++ b/doc/archive/features.md @@ -3,8 +3,7 @@ | Date archived | Reason | Description | |---|---|---| -| 12 February 2020 | Cause of confusion | This section, which previously existed in this repo's root README, was written for the new ECMAScript modules implementation initially created for Node 12.0.0. This feature list informed what became the [plan](../plan-for-new-modules-implementation.md) for that implementation. | - +| 12 February 2020 | Cause of confusion | As part of creating the ECMAScript Modules implementation for Node.js 12.0.0, use cases were brainstormed, which led to a list of features. This feature list, which previously existed as a section in this repo's root README, informed what became the plan for the implementation. | # Features From ced0ff2b504170df2ded6f5c624c841be47fbc3e Mon Sep 17 00:00:00 2001 From: Derek Lewis Date: Thu, 6 Feb 2020 22:24:58 -0500 Subject: [PATCH 4/5] Add the plan to the archive --- README.md | 3 +++ doc/{ => archive}/plan-for-new-modules-implementation.md | 7 +++++++ 2 files changed, 10 insertions(+) rename doc/{ => archive}/plan-for-new-modules-implementation.md (97%) diff --git a/README.md b/README.md index 282763c..8566a82 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,9 @@ Work includes: ## Archives - **[`features.md`](./doc/archive/features.md)**: As part of creating the ECMAScript Modules implementation for Node.js 12.0.0, [use cases](./doc/use-cases.md) were brainstormed, which led to a list of features. This feature list, which previously existed as a section in this repo's root README, informed what became the [plan for the implementation](./doc/plan-for-new-modules-implementation.md). +- **[`plan-for-new-modules-implementation.md`](./doc/archive/plan-for-new-modules-implementation.md)**: Lorem ipsum. + + ## Members diff --git a/doc/plan-for-new-modules-implementation.md b/doc/archive/plan-for-new-modules-implementation.md similarity index 97% rename from doc/plan-for-new-modules-implementation.md rename to doc/archive/plan-for-new-modules-implementation.md index fb5bec9..daa8351 100644 --- a/doc/plan-for-new-modules-implementation.md +++ b/doc/archive/plan-for-new-modules-implementation.md @@ -1,3 +1,10 @@ +| This document has been archived. It is now read-only. | +|---| + +| Date archived | Reason | Description | +|---|---|---| +| 12 February 2020 | Lorem ipsum. | Lorem ipsum. | + # Plan for New Modules Implementation This document outlines the plan for building a new implementation to support ECMAScript modules in Node.js. The effort is split up into phases: From 966f026cb5b295e07534230f95b08ff14f929265 Mon Sep 17 00:00:00 2001 From: Geoffrey Booth Date: Sat, 8 Feb 2020 22:00:37 -0800 Subject: [PATCH 5/5] Add missing text; remove unnecessary detail --- README.md | 5 ++--- doc/archive/features.md | 9 +++------ doc/archive/plan-for-new-modules-implementation.md | 9 +++------ 3 files changed, 8 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 8566a82..a30dbe4 100644 --- a/README.md +++ b/README.md @@ -57,10 +57,9 @@ Work includes: ## Archives -- **[`features.md`](./doc/archive/features.md)**: As part of creating the ECMAScript Modules implementation for Node.js 12.0.0, [use cases](./doc/use-cases.md) were brainstormed, which led to a list of features. This feature list, which previously existed as a section in this repo's root README, informed what became the [plan for the implementation](./doc/plan-for-new-modules-implementation.md). -- **[`plan-for-new-modules-implementation.md`](./doc/archive/plan-for-new-modules-implementation.md)**: Lorem ipsum. +- **[Features](./doc/archive/features.md)**: As part of creating the ECMAScript Modules implementation for Node.js 12.0.0, [use cases](./doc/use-cases.md) were brainstormed, which led to a list of features. This feature list, which previously existed as a section in this repo's root README, informed what became the [plan for the implementation](./doc/archive/plan-for-new-modules-implementation.md). - +- **[Plan for New Modules Implementation](./doc/archive/plan-for-new-modules-implementation.md)**: This document summarized the work that went into the new ECMAScript Modules implementation that shipped in Node.js 12.0.0. ## Members diff --git a/doc/archive/features.md b/doc/archive/features.md index bab055f..b1a6308 100644 --- a/doc/archive/features.md +++ b/doc/archive/features.md @@ -1,9 +1,6 @@ -| This document has been archived. It is now read-only. | -|---| - -| Date archived | Reason | Description | -|---|---|---| -| 12 February 2020 | Cause of confusion | As part of creating the ECMAScript Modules implementation for Node.js 12.0.0, use cases were brainstormed, which led to a list of features. This feature list, which previously existed as a section in this repo's root README, informed what became the plan for the implementation. | +> _This document has been archived._ +> +> As part of creating the ECMAScript Modules implementation for Node.js 12.0.0, use cases were brainstormed, which led to a list of features. This feature list, which previously existed as a section in this repo's root [README](../../README.md), informed what became the [plan for the implementation](./plan-for-new-modules-implementation.md). # Features diff --git a/doc/archive/plan-for-new-modules-implementation.md b/doc/archive/plan-for-new-modules-implementation.md index daa8351..20612f9 100644 --- a/doc/archive/plan-for-new-modules-implementation.md +++ b/doc/archive/plan-for-new-modules-implementation.md @@ -1,9 +1,6 @@ -| This document has been archived. It is now read-only. | -|---| - -| Date archived | Reason | Description | -|---|---|---| -| 12 February 2020 | Lorem ipsum. | Lorem ipsum. | +> _This document has been archived._ +> +> This document summarized the work that went into the new ECMAScript Modules implementation that shipped in Node.js 12.0.0. # Plan for New Modules Implementation