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

docs: curate wiki back into the repo #12449

Closed
refack opened this issue Apr 16, 2017 · 9 comments
Closed

docs: curate wiki back into the repo #12449

refack opened this issue Apr 16, 2017 · 9 comments
Labels
meta Issues and PRs related to the general management of the project.

Comments

@refack
Copy link
Contributor

refack commented Apr 16, 2017

  • Subsystem: docs,guides

A little bit similar to the concept in http://stackoverflow.com/questions/6941688/how-to-integrate-a-github-wiki-into-the-main-project
We clone the current wiki into a new repo (maybe nodejs/core-wiki) and migrate the non-API docs and guides there. This will allow us the regular issue/PR workflow that would end in "landing" changes into https://github.com/nodejs/node/wiki (which is a git repo https://github.com/nodejs/node.wiki.git that would become write restricted).

Also I feel it's very important to have a clear table-of-content with pointers as to whom should read what (maybe also copied into /README.md)

@refack
Copy link
Contributor Author

refack commented Apr 16, 2017

spin off from #12436 (comment)

@refack refack added discuss Issues opened for discussions and feedbacks. meta Issues and PRs related to the general management of the project. labels Apr 16, 2017
@refack refack self-assigned this Apr 16, 2017
@gibfahn
Copy link
Member

gibfahn commented Apr 16, 2017

I'd be -1 on this for the reasons in #12436 . Basically I don't see what you gain, and it makes things more complicated. I'd rather move the stuff in the wiki to doc/guides/website.

Also I feel it's very important to have a clear table-of-content with pointers as to whom should read what (maybe also copied into /README.md)

I think this should just be the README, which is where I think most people start.

#6885 may be relevant.

@refack
Copy link
Contributor Author

refack commented Apr 16, 2017

You've read my opinions in the #12436 thread. I'm mainly pro-README-as-ToC, and a little bit of tidying up.

I'm just asking you to give it second thought, whether it wouldn't be nicer, cleaner, and tidier to have the meta-documentation (and meta-meta discussion i.e. issues and PRs) in a separate space.

@refack
Copy link
Contributor Author

refack commented Apr 16, 2017

If we don't get consensus on a new repo, I'm also suggesting a small reorganization of files, and adding a guides tag for easy separation.

@joyeecheung
Copy link
Member

joyeecheung commented Apr 17, 2017

I think moving the wiki to somewhere managed by git would be better, no matter where it gets moved to.

As for the guides, I am not sure, because for me they also serve as documentations of the codebase (i.e. why certain lines of code are written in a certain way, why the commit history looks in a certain way, how to use the internal API to do stuff), I am more used to seeing this kind of stuff in the codebase (so they would show up when I am searching the codebase for an explanation...)

@sam-github
Copy link
Contributor

If this was an actively used wiki with up-to-date content, I might agree, but as-is, I'm -1.

I think a more useful approach would to survey the content of the wiki, and determine a reasonable disposition:

  • API Changes & Breaking changes: should in website repo so its on nodejs.org
  • async exception handling: should be deleted, its wrong
  • contributing: out of date, delete
  • deprecation: out of date, delete

.... I don't have energy to go through this all, but so far, most of the stuff I've seen should be deleted or moved. I don't think there will be anything in it when this process is complete.

@refack refack changed the title docs: move guides and wiki into their own repo docs: curate wiki back into the repo Apr 18, 2017
@refack
Copy link
Contributor Author

refack commented Apr 18, 2017

I did a 180.
I'll follow @sam-github comment and make a PR.

@refack refack closed this as completed Apr 27, 2017
@refack refack reopened this Apr 27, 2017
@Trott
Copy link
Member

Trott commented Aug 18, 2017

Should this remain open?

@Trott Trott removed the discuss Issues opened for discussions and feedbacks. label Mar 11, 2018
@apapirovski
Copy link
Member

This has been inactive for a year now. I'm going to close it out but feel free to reopen if you're intending to revisit this sometime soon or think this is well suited to the help wanted or good first issue labels.

@refack refack removed their assignment Oct 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Issues and PRs related to the general management of the project.
Projects
None yet
Development

No branches or pull requests

6 participants