Migrate Google Code Wiki to Github

[kekkoudesu]

I just discovered that there is a rich wiki for working on Winetricks available at the old repository host: https://code.google.com/archive/p/winetricks/wikis

If I knew about this yesterday, my life would have been a lot easier! I was moving through the script in Vim, trying to figure out what each function and variable did and how they connected to each other, when I could have read these pages and gotten up to speed much more quickly:

• https://code.google.com/archive/p/winetricks/wikis/AddingNewVerbs.wiki
• https://code.google.com/archive/p/winetricks/wikis/Functions.wiki
• https://code.google.com/archive/p/winetricks/wikis/Variables.wiki

Some of this information is likely to be outdated or incomplete, but it's a very good start!

I think the README should either link to this wiki, or it should be moved to Github's wiki. That would make it a lot easier to onboard new contributors.

[Chiitoo]

I could add them to https://wiki.winehq.org/Winetricks if that makes sense, at least the information that is still true.

[kekkoudesu]

The entire Adding New Verbs article was very useful to me and is great at outlining the process. While the Functions/Variables articles might be incomplete, they're a good place to start. The Autohotkey article was also just the thing I was looking for when trying to write an AHK script before I found the Unattended Mode section in Adding New Verbs. There are a few other miscellaneous articles that have useful, timeless information like Commadnline Tips.

Moving that information to the WineHQ wiki is a better idea than moving it to the Github wiki as it's a more permanent home, although maybe some of these articles should be on separate, dedicated pages for better readability (the article is currently a user's guide rather than a contributor's guide)?

[austin987]

I don't think it makes sense to move them to the Wine wiki. winetrick is a separate project, and its documentation should be on GitHub alongside the project/code.

The wiki page on WineHQ is intended for Wine users.

[austin987]

I've re-enabled the wiki; it will need some cleanup. Maybe you could help with that @kekkoudesu ?

[kekkoudesu]

Sure, I can make a start.

I think the WineHQ wiki page should link to this Github wiki. I don't think I can create an account on the WineHQ Wiki—could either of you make this edit to the page?

[kekkoudesu]

I've been trying to push to the Github wiki with git, but have encountered some trouble:

ERROR: Permission to Winetricks/winetricks.wiki.git denied to kekkoudesu.
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

My .git/config is setup like this:

[remote "origin"]
	url = git@github.com:Winetricks/winetricks.wiki.git
	fetch = +refs/heads/*:refs/remotes/origin/*

I cloned the wiki with that URL, and I can fetch new changes with it, but I can't push with it because I don't have access rights. What I've been doing for now is copying my changes from the .md file into my browser window and committing there, but it would be nice to get this working.

---

So far, good progress! I have the Adding New Verbs and Autohotkey pages up, with some of my own additions and fixes. The only thing I don't know about is whether this information is still accurate: https://github.com/Winetricks/winetricks/wiki/Automation-With-Autohotkey#optional-dialogs

The crysis2 verb no longer exists, as there aren't many examples of verbs with Loop in the AHK script, so I didn't know how to arrange the code snippet.

Also, there's this page about the BottleSpec (?) which links to a dead WineHQ wiki page: https://code.google.com/archive/p/winetricks/wikis/BottleSpec.wiki

Still need to migrate:

• https://code.google.com/archive/p/winetricks/wikis/LearningAboutShellScripting.wiki
• https://code.google.com/archive/p/winetricks/wikis/CommandlineTips.wiki
• https://code.google.com/archive/p/winetricks/wikis/PostinstallScripts.wiki
• https://code.google.com/archive/p/winetricks/wikis/TamingTroublesomeTitles.wiki
• https://code.google.com/archive/p/winetricks/wikis/SummerOfCode.wiki
• https://code.google.com/archive/p/winetricks/wikis/ApplicationTemplate.wiki
• https://code.google.com/archive/p/winetricks/wikis/WhereAppsGo.wiki

And speaking of crysis2, I noticed that winetricks games list no longer exists, and neither do any of the game verbs. I assume these verbs were removed at some point because of the progress made with WineD3D and the appearance of DXVK, as well as Valve providing Proton for Steam games. There are a few out-of-date things in winetricks --help and the manpage that I could fix with a merge request after I get these pages moved over.

[kekkoudesu]

Everything I've deemed of note has been moved over to the Github wiki. I've merged some pages together where it made sense, fixed code snippets, and improved the markup for the Home page. Most of it has aged well.

@austin987 If my understanding is correct that Winetricks no longer supports verbs for games, those sections should be removed from the GSoC page: https://github.com/Winetricks/winetricks/wiki/Google-Summer-of-Code

Actually, most of the ideas should, aside from Better Multi-Language Support, because most of them have been implemented afaik.

The other outstanding items are:

• @Chiitoo The Winetricks page in WineHQ should link to the github wiki for users looking for more information
• Not sure if this is still accurate and how to structure the syntax: https://github.com/Winetricks/winetricks/wiki/Automation-With-Autohotkey#optional-dialogs
• Is BottleSpec still a thing? Is this information still useful? https://code.google.com/archive/p/winetricks/wikis/BottleSpec.wiki

Once those are resolved, we can close this issue.

[austin987]

I've been trying to push to the Github wiki with git, but have encountered some trouble:
...
I cloned the wiki with that URL, and I can fetch new changes with it, but I can't push with it because I don't have access rights. What I've been doing for now is copying my changes from the .md file into my browser window and committing there, but it would be nice to get this working.

That's expected; if you're not a maintainer, you can't push to a repo :). While I greatly appreciate your help, I don't want to give out maintainer access, but I am happy to review pull requests and merge them.

You should instead set up a fork and push your changes there, which should allow you to view your changes on github live (under your fork) until they are ready/merged.

So far, good progress! I have the Adding New Verbs and Autohotkey pages up, with some of my own additions and fixes. The only thing I don't know about is whether this information is still accurate: https://github.com/Winetricks/winetricks/wiki/Automation-With-Autohotkey#optional-dialogs

The crysis2 verb no longer exists, as there aren't many examples of verbs with Loop in the AHK script, so I didn't know how to arrange the code snippet.

Check out dotnet11, for example, as that code is definitely used and AFAIK, reliable.

And speaking of crysis2, I noticed that winetricks games list no longer exists, and neither do any of the game verbs. I assume these verbs were removed at some point because of the progress made with WineD3D and the appearance of DXVK, as well as Valve providing Proton for Steam games.

While those improvements are great, no, the real reason was that that code was unmaintained. See #2015

Everything I've deemed of note has been moved over to the Github wiki. I've merged some pages together where it made sense, fixed code snippets, and improved the markup for the Home page. Most of it has aged well.

Thanks!

@austin987 If my understanding is correct that Winetricks no longer supports verbs for games, those sections should be removed from the GSoC page: https://github.com/Winetricks/winetricks/wiki/Google-Summer-of-Code

Actually, most of the ideas should, aside from Better Multi-Language Support, because most of them have been implemented afaik.

I've deleted the page instead. Wine hasn't done GSOC for a couple years, and when Winetricks applied, it wasn't accepted.

That said, if there was student interest I would consider applying, but IMO there are better projects to direct student efforts towards.

The other outstanding items are:

* Is BottleSpec still a thing? Is this information still useful? https://code.google.com/archive/p/winetricks/wikis/BottleSpec.wiki

IMO no. That was a proposal that AFAIK no other projects adopted. It should be nuked.

[kekkoudesu]

It's kind of odd that Github Wiki works like that, but I guess it makes some sense to prevent abuse.

You should instead set up a fork and push your changes there, which should allow you to view your changes on github live (under your fork) until they are ready/merged.

I'm done editing now, but I don't know if it's possible to target a pull request at the Wiki. There's the wiki branch in the main repository, but that seems to be something different.

I prefer local editing because Github Wiki doesn't autosave drafts or anything, and it doesn't have find-and-replace or other useful commands. Also, no way to show diffs to remember what you changed. They've unfortunately really under-equipped their Wiki section.

But I'm already done editing, so no worries there :)

Check out dotnet11, for example, as that code is definitely used and AFAIK, reliable.

Thanks; we're using that now!

While those improvements are great, no, the real reason was that that code was unmaintained.

Fair enough!

IMO no. That was a proposal that AFAIK no other projects adopted. It should be nuked.

All good, I never moved the page over.

---

The only thing left to do is to link to the Github wiki from the WineHQ wiki, but since it seems neither of us have access to that and it's a relatively small thing, feel free to close this issue.

[Chiitoo]

I'm not sure the GitHub Wiki is really intended to be used via git, since it's not exactly easy to even find out that you can do it (at least that's my experience some years ago when I found out myself).

Pretty sure you can't do PRs for it in any case, but instead, just directly edit it as you have been doing.

I'm not really a fan of it in general myself, and as such, I think it would be best to have all the documentation in the source repository itself (imagine GitHub goes away tomorrow for example, with its wiki). That's just my opinion though.

But yeah, I do agree the WineHQ wiki doesn't make sense for these things either, but I will include that link there at least sometime soon!

[kekkoudesu]

As a point of comparison, Lutris has a Docs repository: https://github.com/lutris/docs

There are pros and cons to this approach. You can see this repository has a lot of open pull requests that haven't been looked at by the maintainers for a long time: https://github.com/lutris/docs/pulls

The good thing about the Github Wiki is anyone can edit it. The bad thing about the Github Wiki is anyone can edit it.

I think both approaches make sense, and of course you can restrict edit access to the Github Wiki too. I'm not sure which is right for this project.

I echo this though:

(imagine GitHub goes away tomorrow for example, with its wiki).

---

I do agree the WineHQ wiki doesn't make sense for these things either, but I will include that link there at least sometime soon!

Thank you!