-
Notifications
You must be signed in to change notification settings - Fork 28.9k
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
Document long-term technical debt #1795
Comments
maybe we should we have wiki page this for collaborator use? |
Unmess debugger? :) |
Domains, it's invasive but not really deprecatable at this stage at least--a path to make them less invasive or properly deprecate and remove? |
👍 On putting this stuff in collaborator docs somewhere. @trevnorris and I are wanting to get some documentation put together on internals, dependencies and such, so this would be very relevant to us. |
+1 to using a doc somewhere to list this. Adding a doc to the repo ought to
|
I've been poking at building out a "doc/internal" dir, to contain things like this. There's going to be a node doc meetup at nodeconf this year with the goal of producing a comprehensive IA for the docs, internal and external. In the meantime a "doc/internal/todo.md" would likely suffice!
|
+1 to doc/internal/ |
Alternately it might be worth opening separate issues (with more details) to give people a place to collaborate on a specific issue. Then, tagging them all with a specific tag, and linking to that tag from some kind of docs. |
|
We should be able to put this stuff into https://github.com/nodejs/docs for now. @piscisaureus mind writing and PRing your stuff to somewhere within If anyone else has info dumps, that's probably also the target place for now. :) |
If there are a lot off problems, then I like the idea of each having its own issue. Though if that happens then I'd also like its own repo or such. Having those scattered throughout here would be a pain. |
You could just tag them with a |
Having never ending issues is not a good idea imo. The docs repo is already separate, why not do it in there? |
@Qard It really would depend on the number of issues. I doubt we'd get enough to merit that. Was also thinking it could go along well w/ something like internal docs or whatnot where all this stuff could be cataloged. |
True, it would probably fit well in the internals docs section of the docs wg stuff. I'm 👍 for putting it there. |
@piscisaureus Now that you are back more do you think you could do some of this? The current location would be https://github.com/nodejs/new.nodejs.org/tree/master/locale/en/docs/meta/topics (Public as https://nodejs.org/en/docs/meta/topics/dependencies/, but not necessarily linked to on the website) Ala https://github.com/nodejs/docs/blob/master/GETTING-STARTED.md#what-we-write If that doesn't work we should make sub-directories like that in the docs folder here. |
Closing this due to lack of activity. This is generally a good idea but there's no reason to keep this open. |
There are longstanding known issues in node which are (mostly) in my head only.
For some of them there currently isn't a plan on how to prioritize them.
It feels futile to open issues for these topics, because they'll be buried soon under a pile of short-term, actionable bug reports.
The goal here is to capture some tacit knowledge and share with more people.
An example (which would be documented in much more detail):
Many of the things I know about are actually windows issues:
I would not mind setting myself down to document what I know and submit it as a PR. But would it be helpful/worthwhile? Please advise @nodejs/tsc.
The text was updated successfully, but these errors were encountered: