search

geddy / geddy

Web framework for Node.js
http://geddyjs.org/
1.87k stars 240 forks source link

Document not up to date #660

Open phanect opened 9 years ago

phanect commented 9 years ago

In my understanding, Guide, and API Refference is stored under doc directory and Tutorial is here.

I have commited changes for some times, but it is not applied to geddyjs.org, even my commit is over 6 monthes ago. I believe any manual operation is required to apply, but currently no one does it and docs are left old.

Manual upload solve this problem this time, but I suggest the ways to skip manual upload process.

I'm considering following in my mind:

  1. Use any wiki services; e.g.
  2. Use Github's wiki
  3. Write script to automatically apply to the website and register as the hook so that it works on commit
mde commented 9 years ago

I can't remember what state I left the site in. It's possible that now it is using the files on the local filesystem (pulled down by git) instead of fetching them from GitHub. Either way -- we want to make sure that the docs are for the release branch, not the master branch. That might explain at least some of the delay you're seeing. The docs site is in the "site" directory, and it's just a Geddy app, so it's easy to run it locally. If you want to make changes to it, please feel free, and I'll update the production site. Just make your changes in the release branch, not in master.

phanect commented 9 years ago

OK, so you are currently manually upload changes of documents, and I have to ask you to upload, right?

Then I suggest to introduce automation script. I will create it if you agree. What service do you use for geddyjs.org server? Your own server? IaaS or VPS? Rental servers? If your server is difficult to execute script, readthedocs might be a good choice.