Skip to content
This repository has been archived by the owner on Sep 2, 2023. It is now read-only.

maintain a summary document/website #35

Closed
devsnek opened this issue Feb 23, 2018 · 12 comments
Closed

maintain a summary document/website #35

devsnek opened this issue Feb 23, 2018 · 12 comments

Comments

@devsnek
Copy link
Member

devsnek commented Feb 23, 2018

i stumbled across https://github.com/martinheidegger/es6modules-nodejs which seems like a very appealing type of thing to keep updated, i think it would be nice to include something similar in this repo.

the repo also hosts a site, which i think is a pretty nice template as well (http://es2015-node.js.org/)

also https://github.com/nodejs/node/wiki/ES6-Module-Detection-in-Node and ofc the ep https://github.com/nodejs/node-eps/blob/master/002-es-modules.md

/cc @martinheidegger

@devsnek devsnek changed the title maintain a summary document for the general users maintain a summary document Feb 23, 2018
@devsnek devsnek changed the title maintain a summary document maintain a summary document/website Feb 23, 2018
@martinheidegger
Copy link

@devsnek Thanks for posting this here. Actually i thought of shutting down that site because https://medium.com/the-node-js-collection/the-current-state-of-implementation-and-planning-for-esmodules-a4ecb2aac07a explained it much better than I did (and honestly I have no time maintaining that repo properly)

@devsnek
Copy link
Member Author

devsnek commented Feb 23, 2018

@martinheidegger it would become our job to whatever we come up with updated (the author of that blog post is a member of this modules team) i was just using your repo as a kind of "gold example"

@martinheidegger
Copy link

Oh, okay ^_^ btw. I wouldn't have a problem giving up ownership of that repo

@mcollina
Copy link
Member

mcollina commented Feb 23, 2018

IMHO the summary should live in this repo, and it should be updated as things progresses.

@chrisdickinson
Copy link

(FWIW, I own the modules.guide domain, I'd be happy to donate it to this cause.)

@jkrems
Copy link
Contributor

jkrems commented Feb 28, 2018

On the more "academic" side I also assembled a history of ES modules here: https://gist.github.com/jkrems/769a8cd8806f7f57903b641c74b5f08a

@devsnek
Copy link
Member Author

devsnek commented Mar 5, 2018

i've created some pages based heavily on @jkrems' gist and @martinheidegger's repo. I would like to either use our wiki (https://github.com/nodejs/modules/wiki) or point gh-pages to the doc folder and use that with markdown hosted pages. I'd like to decide between these two options at the next meeting. As a side note: we currently have no process for deciding on changes to the wiki so we might have to come up with something if we do

@MylesBorins MylesBorins removed the modules-agenda To be discussed in a meeting label Mar 12, 2018
@MylesBorins
Copy link
Member

Moving off the agenda based on last weeks conversation

@devsnek
Copy link
Member Author

devsnek commented Apr 1, 2018

so far i have a history based on @jkrems's gist and a more in-depth document about how esm has been interacting with node based on @martinheidegger's document. i'm working on a few other things like FAQ and such atm. @MylesBorins in the next meeting can we try to vote on using the wiki as a place to keep this stuff such that our pr rules don't affect keeping the documentation updated? i think everyone would agree with that as these documents are purely factual and don't push any implementations above the others, they just say what has been discussed, what hasn't, what currently isn't possible, FAQ, etc

@MylesBorins
Copy link
Member

I this something we are still planning to do or can we close this issue?

@GeoffreyBooth
Copy link
Member

I think the modules repo README is basically our summary document. It would be good to add a Status section to it so that casual visitors can know what we’re currently working on, but it has our goals on there.

@MylesBorins
Copy link
Member

Closing this as there has been no movement in a while, please feel free to re-open or ask me to do so if you are unable to.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

7 participants