Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

express/examples #2923

Closed
Knighton910 opened this issue Mar 3, 2016 · 20 comments
Closed

express/examples #2923

Knighton910 opened this issue Mar 3, 2016 · 20 comments

Comments

@Knighton910
Copy link

@dougwilson I'd like to start working new express/examples They're pretty old currently.

What are you're thoughts on this?

The majority of these are 2 years, there are a few, just a tad old.

@dougwilson
Copy link
Contributor

Yes, we absolutely need modern examples, that use modern features of Express 4.x :) I think this is a great idea! There has been discussion a long time ago for if examples should be in this repository or their own repository (but I'm not suggesting we change this just yet, as the existing examples are part of the test suite and tests features missing from the actual test suite... lol).

If you are looking for feedback ahead of time, feel free to share what ideas you have for example apps and other people may even better be able to say what is the most desired :)

@Knighton910
Copy link
Author

Okay cool, I think another reason this is a good idea, is because people are quicker to jump in once we get the ball rolling & express is looking at V5, this is needed. But yeah, I'll keep you posted.

feel free to share what ideas you have for example apps

Will do 😄

@Knighton910
Copy link
Author

@dougwilson I should have lead with this, my Operative Goal is to add a Markdown.md in some examples and so it's more like a guide to those examples. And update the actual examples as well.

@dougwilson
Copy link
Contributor

Sounds even better, especially as steps to shore up those existing ones :)!

@Knighton910
Copy link
Author

+1 @dougwilson

Sounds even better, especially as steps to shore up those existing ones :)!

Great! we will get the ball rolling soon.

@crandmck
Copy link
Member

crandmck commented Mar 8, 2016

This is relevant to expressjs/expressjs.com#463 as well. Perhaps we can incorporate the .md files into the docs, or at least link out to them. This doc issue has been open for some time, but unfortunately I haven't had time to work much on it -- I made a bare start of describing the existing examples: https://github.com/strongloop/expressjs.com/wiki/Example-notes. I would think it would make sense to create any new examples with the existing ones in mind, either as replacements or revisions.

@Knighton910
Copy link
Author

Out of the gate, i would say revisions, But let me get an overall look of what's at play, and i'm sure, it's something we should tackle without to much of a fuss. 💯

@crandmck
Copy link
Member

crandmck commented Mar 8, 2016

@kelthenoble Please feel free to edit https://github.com/strongloop/expressjs.com/wiki/Example-notes as a starting point, if it's helpful for you. It will certainly help me to have more information (one way or another) if/when we add more info in the docs about the examples.

@Knighton910
Copy link
Author

Okay, will do 👍 @crandmck

@kbariotis
Copy link

hello @crandmck I thought I would add a few descriptions to the Wiki page. Thanks.

@crandmck
Copy link
Member

Thanks @kbariotis for the help!

@caiocutrim
Copy link

I am in to help with something 👍 maybe we need to rewrite the entire express with es6 syntax 👍

@Knighton910
Copy link
Author

Yea sounds great @caiocutrim lets link up and put something together

@ghost
Copy link

ghost commented May 13, 2016

It may be possible for me to help as well, please keep me informed.

@notrab
Copy link
Contributor

notrab commented Aug 9, 2016

Would there be any concerns removing examples directory from the core express repo?

I noticed @dougwilson mentioned a few things regarding this. Is this a massive job that would require rewriting more things or would it just require a admin/cleanup job?

I'm a huge fan of creating a separate expressjs/examples repo.

I'm new to Express and I haven't dived too far down the dependency rabbit hole, so forgive my ignorance.

@NickNaso
Copy link

NickNaso commented Aug 9, 2016

Good idea to refactor the examples but i don't know if create a new repo is the right thing. My opinion is that if you want use examples in test case they have to remain in repo otherwise they could be moved.

@crandmck
Copy link
Member

crandmck commented Aug 9, 2016

I think this bears discussing. I'll add it to the agenda of the next Express TC meeting: expressjs/discussions#29 Please join if you'd like to add your input.

@dougwilson
Copy link
Contributor

I don't personally care if the examples are in this repo or their own repo, but I feel like there are a few things to consider:

  1. The only reason we have 100% test coverage is because we run the examples during testing Express. Removing that would require someone to also implement all those tests again before we can remove the examples.
  2. It makes it really easy to keep up-to-date with Express changes, though someone can just be diligent at keeping a separate repo up-to-date on their own.

@ScottFreeCode
Copy link

Not part of the examples per se, but similar in nature: I was thinking the site's page on error-handling could use discussion of 404s. Or maybe a dedicated 404-explanation page alongside it? They're currently basically undocumented as far as I can tell. They're also especially hard to figure out if you're using view rendering (which 500s on missing view files rather than fitting into Express's multiple-handler-trying 404 paradigm), so some documentation of it is pretty badly needed.

Would it be worthwhile for me to put together a PR with at least a rough draft of a proposed 404 documentation addition for the site? If so, is it particularly important whether it's part of the page on error-handling or gets its own dedicated page?

@dougwilson
Copy link
Contributor

@ScottFreeCode probably a question you would need to make on the website repo, to make sure the right people see it and track it.

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

No branches or pull requests

8 participants