About the official site (ahkscript.org)

[amnesiac]

Moveover, I suggest that we use absolute path for images, css files, js files, zip files and so on. Relative path is for webpages which need be translated.

So when translate these webpages we needn't adjust those links.

If there is something I can do, please tell me and I'm willing.

[Ragnar]

tank, we could use the following method maybe.

• www.ahkscript.org (ahkscript.org points here), jump to proper language's page based on the brower's language of a visitor automatically.
• en.ahkscript.org: the English pages, hosted at the github and use own domain name. Other ambassadors can translate from this project. The main page contains all links to all language's main page (including English page's link).
• cn.ahkscript.org: the translated Chinese pages, point to the github project selected by Chinese translators.
• ...
• forum.ahkscript.org: this forum, hosted at current room.

For the documents, let en.ahkscript.org/docs refer to AutoHotkey_L-Docs by git submodule.

Is it seamless?

Sounds good.

[lexikos]

Moveover, I suggest that we use absolute path for images, css files, js files, zip files and so on.

That isn't possible for the documentation, since it needs to work offline. Perhaps those directories can simply be redirected back to the English files.

[tank]

Redirects should work

[ryunp]

Minor issue: Line break issue with the entries on the side nav. Some entries' lengths cross the margins.

Edit: Issue reported in the Docs git, thanks for the correction.

[joedf]

I suggest posting an issue here: https://github.com/Lexikos/AutoHotkey_L-Docs/issues

[amnesiac]

Moveover, I suggest that we use absolute path for images, css files, js files, zip files and so on.

That isn't possible for the documentation, since it needs to work offline. Perhaps those directories can simply be redirected back to the English files.

The offline help contains a different set of files encoded in GBK for Chinese, though their contents and non-webpages are the same. So I must process it and the online help separately.

[lexikos]

Why?

Anyway, I was of course referring to the "official" documentation. Aside from the offline documentation, there is also the GitHub mirror and v2 documentation to consider. Absolute paths are also more likely to require changes, and are just not necessary.

[guest3456]

Aside from the offline documentation, there is also the GitHub mirror and v2 documentation to consider.

Do these github mirrors pull the docs directly from the live github branch? So they will always be more up-to-date than the actual ahkscript.com/docs site?

[lexikos]

No, they use git sub-modules which need to be updated manually. (This involves merely telling git which commits to use.) I have a script which does this, but often neglect to run it because I don't really care whether the mirrors are up to date. However, I've just added it to my release script, so if I've done it correctly, future updates to v1 should automatically update the mirrors.

My release script always updates ahkscript.org/docs from my working copy, so it is always at least as up-to-date as the downloads. Sometimes it is more up-to-date, because I forget to commit changes to git.

I started using github mirrors because 1) I could and 2) it is quicker and easier to put v2 there than have an additional FTP sync.

[guest3456]

if someone (tank, joedf, etc?) will post a .zip of the ahkscript.org site files, i will get the ball rolling on this

[tank]

not sure i understand? you want to be able to get a zip of the docs folder?

[guest3456]

no, i'm looking for the ahkscript.org homepage files, to migrate onto github pages. the docs can be easily linked with git submodules. i will set it up and you guys can see

The ahkscript.github.io project has been existed but doesn't host the ahkscript.org's contents.

[guest3456]

Ok take a look at this:

http://mmikeww.github.io/ahkscript/


That page is built directly from my github repository, in the 'gh-pages' branch:
https://github.com/mmikeww/ahkscript/tree/gh-pages

I simply cloned the existing ahkscript.github.io but then I removed all the existing stuff. I guess I didn't need to clone in that case heh.
You can click the 'commits' button in the upper left to see in detail.

I've changed a few links on that homepage.

1. The big gray "Docs" button points to my local copy of the v1 docs, which is grabbed from Lexikos' live repository. This is a pointer from the subfolder "v1/"
2. The "Other Versions" download link points to the index in "v1/". It looks like this is the same as the download page, but Lexikos doesn't keep it up to date.
3. The same for the "v2 link" at the top, and subfolder "v2/" which points to the v2 branch of the docs
4. The same for the "german link" at the top, subfolder "de/". This is grabbed from Ragnar's live repository
5. The "german external link" points to Ragnar's page at http://ragnar-f.github.io/. That's his own github page which grabs his live repo, but it also allows him to host his v2 docs at http://ragnar-f.github.io/v2/ which I wasn't able to do

This means that updating that website is a simple as pushing my changes to github. It also means anyone can contribute and submit a pull request, and as soon as I merge it into my repository, it becomes live for everyone at that url.
You can try that here:
https://github.com/mmikeww/ahkscript/bl ... /index.htm
That's the file for the homepage. Click the pencil in the upper right to edit the file. Prospose the change.
When I accept the pull request, the changes will be merged and the site will update.

It also means that whenever Lexikos or another user contributes updates the docs, the webpage will update too because it simply points directly to his files. But there may need to be some configuration to make sure the submodules automatically update to the newer commit.

If we push the changes to the ahkscript.github.io organization repository, then, you would need to set up a redirect CNAME to point ahkscript.org to the github page. The end result would look like this:

Code: Select all

url                                       github repo

http://www.ahkscript.org/              -> ahkscript/ahkscript.github.io
http://www.ahkscript.org/v1/           -> Lexikos/AutoHotkey_L-Docs
http://www.ahkscript.org/v1/docs/      -> Lexikos/AutoHotkey_L-Docs
http://www.ahkscript.org/v2/           -> Lexikos/AutoHotkey_L-Docs
http://www.ahkscript.org/v2/docs/      -> Lexikos/AutoHotkey_L-Docs
http://www.ahkscript.org/de/           -> Ragnar-F/ragnar-f.github.com

Thats the same structure that I have now at http://mmikeww.github.io/ahkscript/
You can check the urls as you click the 5 links described above

We would lose the existing ahkscript.github.io page but I don't really think thats being used anyway.

Alternatively, instead of using submodules, we could merge Lexikos doc repo and Ragnar's de repo all into one main website repo, ala ruby-lang listed in the OP. This is probably the best way, and avoids the updating of the submodules. But it might pose some difficulty in building the offline HTML Help .chm (why is that still used anyway)?

It sounds kinda confusing but its really not.

[tank]

The homepage in particular is not entirely static content. So some changes would be necesary.before I can move it to github

[joedf]

Hmm interesting, haven't had time to access my computer yet, I will soon... Currently just using my mobile phone.

[amnesiac]

This means that updating that website is a simple as pushing my changes to github. It also means anyone can contribute and submit a pull request, and as soon as I merge it into my repository, it becomes live for everyone at that url.
You can try that here:
https://github.com/mmikeww/ahkscript/bl ... /index.htm
That's the file for the homepage. Click the pencil in the upper right to edit the file. Prospose the change.
When I accept the pull request, the changes will be merged and the site will update.

It also means that whenever Lexikos or another user contributes updates the docs, the webpage will update too because it simply points directly to his files. But there may need to be some configuration to make sure the submodules automatically update to the newer commit.

Beautiful shows. I'm very happy to see it. Thank you.

To tank:
When rebuild the official site, please remember to add the Chinese link.
Updated Chinese help: http://ahkcn.github.io/docs/
The github project: https://github.com/ahkcn/ahkcn.github.io

[guest3456]

The homepage in particular is not entirely static content. So some changes would be necesary.before I can move it to github

Ah ok. What is dynamically generated? And do we really need any dynamic content?

One downside about this is that our page will be dependent upon github being up. But they use a CDN with DoS protection. Plus most contributors should have local backups of the repository as well, and if we ever need to change it, we can just reup to the webhost and change the DNS Server to stop pointing to github

We can leave the /boards/ link to point to the webhost

Beautiful shows. I'm very happy to see it. Thank you.

Thanks.

A forum software that i use has also migrated their website to github: myBB. It seems to be the new trend, and its a great idea for numerous reasons.

To tank:
When rebuild the official site, please remember to add the Chinese link.
Updated Chinese help: http://ahkcn.github.io/docs/
The github project: https://github.com/ahkcn/ahkcn.github.io

Yes of course, these could sit at the /cn/ subdir just like I have for /de/

However, we need to decide how we want to structure the site. Do we want to use submodules like I showed above, pointing to separate repositories? Or should all of the /de/ and /cn/ and even /docs/ be all put into one repository and then every contributes directly to ahkscript github account? We would need a decision from Lexikos regarding how he wants to handle the docs.

[fincs]

My two cents:

I'm (in principle) in favour of moving the ahkscript.org content to GitHub pages (in fact, it was even planned by poly for the old domain). However, documentation should be set up strictly using submodules - otherwise it would be a mess (with 4 kinds of documentation in the same repo and the impossibility to use git merges) & would destroy git history.

Things that indeed need to be considered are the downloads and the forum (amongst other "services"). They could get their own subdomains which would still be hosted using the current ahkscript server (download.ahkscript.org and boards.ahkscript.org) and we could set up redirects from the old locations (if that's even possible, otherwise it's a major show-stopper). Additionally, in the case we recover the autohotkey.com domain, this would make it easier for us to merge.

If we're considering the possibility of changing the forum software, we'd first need to evaluate the alternatives and establish a consensus. I'm currently happy with phpBB (and don't see any reason why to migrate to myBB). However lately I've been reading information about Discourse, and it may be interesting to consider it, especially since it seems to be designed towards reducing noise and has post relevancy features which may be useful for a programming forum (oh, and it looks like it's possible to set up GitHub-style syntax highlighting for code blocks). However there are several things which will require rethinking (such as the fact that it's not possible to cleanly reproduce the multi-language setup we currently have, therefore needing separate boards for German and Chinese users; I don't know if it's possible to share the user table).

[tank]

If we're considering the possibility of changing the forum software

I wasnt aware forum software had entered the subject

What is dynamically generated?

not so much wat is dynamically generated as what is dynamically handled corrected tracked by php code right now. The small amount of content that is dynamic can be handled with some jquery. instead of server includes. dont get me wrong i flat don't have any attachment to it staying as is. but i do have a small amount of work to do to it

Ill be on my home PC this weekend doing homework and get it done in between assignments.