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

Use GitHub's Wiki for all docs #401

Closed
nhooyr opened this issue Apr 1, 2019 · 11 comments
Closed

Use GitHub's Wiki for all docs #401

nhooyr opened this issue Apr 1, 2019 · 11 comments
Assignees
Labels
docs Documentation related

Comments

@nhooyr
Copy link
Contributor

nhooyr commented Apr 1, 2019

https://www.growingwiththeweb.com/2016/07/enabling-pull-requests-on-github-wikis.html

The workaround presented in that article makes it a very elegant model.

@NGTmeaty
Copy link
Contributor

NGTmeaty commented Apr 2, 2019

#191 was closed before? Are we going with this now?

@sr229
Copy link
Contributor

sr229 commented Sep 18, 2019

I'll be assigning this to myself. Porting the docs should be easy to do.

@sr229 sr229 self-assigned this Sep 18, 2019
@sr229 sr229 added the docs Documentation related label Sep 18, 2019
@nhooyr
Copy link
Contributor Author

nhooyr commented Sep 18, 2019

Yea I'm not sure if this is the best move considering translations/versions will be hard to manage when the docs are not managed directly with the source code.

Deferring to @code-asher.

@sr229
Copy link
Contributor

sr229 commented Sep 18, 2019

It's actually trackable since the wiki itself is a Git Repository @nhooyr

@nhooyr
Copy link
Contributor Author

nhooyr commented Sep 18, 2019

It's actually trackable since the wiki itself is a Git Repository @nhooyr

It is, but it gets harder to manage since the wiki will be a different repository and so you'll have to remember to always update the wiki as the features get updated instead of managing all of that in a single PR/repository.

@sr229
Copy link
Contributor

sr229 commented Sep 18, 2019

We can actually have the docs be a link to the wiki version and we can just push from code-server.wiki which could be automated anyways.

@code-asher
Copy link
Member

It sounds like if I have a feature branch that also has doc changes I'd have to maintain two PRs in separate repos for the same feature which doesn't sound like a super fun time to me. I also don't like that if I go back through code-server's history I don't also get the documentation for code-server at that point in time.

@sr229
Copy link
Contributor

sr229 commented Sep 18, 2019

It sounds like if I have a feature branch that also has doc changes I'd have to maintain two PRs in separate repos for the same feature which doesn't sound like a super fun time to me. I also don't like that if I go back through code-server's history I don't also get the documentation for code-server at that point in time.

From what I can see we can definitely have pushing to the Wiki page automated via docs/. This is something I'll work on. For now you can settle with me maintaining it up to date for now.

@nhooyr
Copy link
Contributor Author

nhooyr commented Sep 18, 2019

From what I can see we can definitely have pushing to the Wiki page automated via docs/. This is something I'll work on. For now you can settle with me maintaining it up to date for now.

At that point, why not just let people browse docs directly? The Wiki doesn't add anything other than a table of contents.

@code-asher
Copy link
Member

Hmm I'm not really seeing the gain here either. 🤔

@sr229
Copy link
Contributor

sr229 commented Sep 18, 2019

Based on internal discussion, we just disabled Wiki. Closing.

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

No branches or pull requests

4 participants