Refactoring - next steps

[paul90]

Continuing the work started in #395 and #402.

I have recorded some thoughts, see code refactor in my fed wiki.

This will impact both the WardCunningham/wiki and WardCunningham/wiki-client repositories, as well as this one. As well as creating another 35(?) plug-in repositories (and npm packages).

N.B. If you comment by forking the fed wiki page, please provide a link to your fork here.

[almereyda]

As well as creating another 35(?) plug-in repositories (and npm packages).

👍 I had to smile a little. 👊 📦

[almereyda]

Another idea could be to finally create a #fedwiki GitHub Organization and move all concerning repos there.

[WardCunningham]

I've added some notes on CDN caching and fallback to @paul90 refactoring page:
http://ward.fed.wiki.org/code-refactor-nov-2013.html

[paul90]

The refactoring of the node version is now available, as an installable package. See paul90/wiki-exp.

This must still be considered a work in progress, the code for both the client and server is contained in the paul90/refactor branch of my forks of the wiki-client and wiki repositories.

Those wishing to try this new version can install it globally with npm:

$ npm install -g wiki-exp
$ wiki-exp --data ~/.wiki

N.B. A data path should be specified when starting the wiki, see WardCunningham/wiki#41.

[almereyda]

Great work! I was not really aware of the fact that this was a one person task.

Despite the last but one line carries a little typo : --data.

[paul90]

Thanks, it didn't start out that way.

[WardCunningham]

Awesome work Paul.
I fixed the typo, --data.
I can't wait to try it.

[WardCunningham]

I've tried an install on my mac. It installed smoothly but won't start. Here is what I've tried.

$ wiki-exp
env: node\r: No such file or directory
$ wiki-exp --data ~/.wiki
env: node\r: No such file or directory
$ mkdir foo
$ wiki-exp --data foo
env: node\r: No such file or directory

[paul90]

@WardCunningham can you try again - looks like a line ending issue. I have changed the line endings in bin/server.js and republished, which should resolve the problem.

[WardCunningham]

Updated to version 0.1.1. Works great. Thanks.

[paul90]

That's good.

There are a few recent updates that have not yet made it across. I
should get to them soon.

Ward Cunningham mailto:notifications@github.com
17 December 2013 16:08

Updated to version 0.1.1. Works great. Thanks.

—
Reply to this email directly or view it on GitHub
#403 (comment).

[paul90]

I think the following steps are needed to complete this.

Rather than creating new repositories, we will transfer the existing GitHub repositories to the fedwiki organization.
GitHub will redirect to the new location - as long as we don't create a new repo with the same name - see
https://github.com/blog/1508-repository-redirects-are-here, and https://help.github.com/articles/renaming-a-repository

I propose to create an issue in each repository with the relevant checklist.

For each wiki-plugin-*

• Update package.json to include new repository and issues url
• Update ReadMe.md
• increment patch version
• move to fedwiki org.
• remove github wiki, if not already done.
• add ward as an owner of the package
• republish to npm

for wiki-exp

• review the documentation, and update
• move to fedwiki org, as wiki, or to wiki-npm so like wiki-gem???

This will replace the existing wiki npm package, so need to get all the docs to reflect this, including details on how to contribute (both to the existing components, and also writing new plugins).

A few more steps that are needed once wiki and wiki-client steps are completed.

• ensure package.json is updated, using npm rather than git to install the wiki-server and wiki-client packages, as well as new repository and issues url
• publish to npm - this is the last step, as it will be published as wiki.

for wiki

• review documentation, and update
• move to fedwiki org, and rename as wiki-server
• merge refactor branch into master
• Update package.json to include new repository and issues url
• publish to npm, as wiki-server

for wiki-client

• review documentation, and update
• move to fedwiki org
• merge refactor branch into master
• Update package.json to include new repository and issues url
• publish to npm

Those who have forked the wiki and wiki-client repos on GitHub will need to update their upstream remote to use the new URL - though as we transfer/rename the repos they will get redirected. See https://help.github.com/articles/how-to-transfer-a-repository#redirects-and-git-remotes

How best to handle issues? As the many of the components (client and plugins) are used by both server
implementations, I suggest that we central issues repository. The Smallest Federated Wiki repository would seem to be a good place.