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

move docs to github wiki #5466

Open
Adeor opened this issue Apr 18, 2015 · 3 comments
Open

move docs to github wiki #5466

Adeor opened this issue Apr 18, 2015 · 3 comments
Labels

Comments

@Adeor
Copy link

@Adeor Adeor commented Apr 18, 2015

hi,

would it be possible to move/copy the documentation to the GitHub Wiki?
I think it would be much clearer and easier to navigate (at least for me).

If you want I would gladly port it for you.

@dstftw dstftw mentioned this issue Jul 4, 2016
4 of 8 tasks complete
@yan12125
Copy link
Collaborator

@yan12125 yan12125 commented Jul 5, 2016

By default Github Wikis allow everyone to edit, just like Wikipedia. I'm afraid that it will be bloated with wrong/inproper information. There are some alternatives:

  1. Add a section in yt-dl.org and/or rg3.github.com/youtube-dl and sync contents of docs/. I guess pandoc can transform Markdown to HTML, too.
  2. Restrict Wikis to collaborators. An advantage of this approach is that Github provides a Wiki repository, so the Markdown -> HTML conversion is done by Github.

In both approaches we need to sync changes back manually if files under docs/ are modified. Github webhooks provides a seemingly simple synching mechanism.

@yan12125 yan12125 mentioned this issue Nov 18, 2016
0 of 5 tasks complete
@rg3
Copy link
Collaborator

@rg3 rg3 commented Nov 22, 2016

Sorry for being late to the party. I was just now browsing issues I'm "participating" on and I noticed #11234. If the team agrees I should change the project settings just mail me and I'll do.

@siddht4
Copy link

@siddht4 siddht4 commented Jul 30, 2017

@rg3 thank you for your positive response on wiki.
@yan12125 only the collaborators can change the wiki. We can post/comment things like what to add,what to change,etc.(I have tried it myself pr doesnt work).

github webhook is a nice idea and keep track of all the changes.

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

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.