Castle documentation has been migrated from ScrewTurn Wiki to GitHub

[Jonathon Rossi]

I've finished migrating all of the documentation from
http://docs.castleproject.org/ into each project's git repo. There is now a
docs directory each project's git repo with a README.md file.

e.g. https://github.com/castleproject/Windsor/blob/master/docs/README.md

The entry point of the wiki is now in the home git repo (
https://github.com/castleproject/Home) which now sort of does a similar
purpose to the web site.

We can now easily receive, review and merge changes to documentation with
pull requests.

FYI I've removed all the pages from the wiki excluding the Windsor pages
which I've put a link to the new location so that StackOverflow answers and
other inbound links will allow users to find the page. Not sure how long we
want to keep STW running for.

[Krzysztof Koźmic]

Love your work Jono.

Re STW: let's monitor how much traffic it gets, and once it goes down
significantly shut it down

Post by Jonathon Rossi
I've finished migrating all of the documentation from
http://docs.castleproject.org/ into each project's git repo. There is now
a docs directory each project's git repo with a README.md file.
e.g. https://github.com/castleproject/Windsor/blob/master/docs/README.md
The entry point of the wiki is now in the home git repo (
https://github.com/castleproject/Home) which now sort of does a similar
purpose to the web site.
We can now easily receive, review and merge changes to documentation with
pull requests.
FYI I've removed all the pages from the wiki excluding the Windsor pages
which I've put a link to the new location so that StackOverflow answers and
other inbound links will allow users to find the page. Not sure how long we
want to keep STW running for.
--
Jono
--
You received this message because you are subscribed to the Google Groups
"Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send an
.
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.

[Jonathon Rossi]

Thanks, it took much longer than I thought it was going to. I removed/fixed
some obsolete content as I went, but there is still some more, but
hopefully users are more likely to fix it now on GitHub.

It looks like we've got Google Analytics on that page, have you got access
to it?

On Thu, Jun 11, 2015 at 4:22 PM, Krzysztof Koźmic <

Post by Krzysztof Koźmic
Love your work Jono.
Re STW: let's monitor how much traffic it gets, and once it goes down
significantly shut it down

Post by Jonathon Rossi
I've finished migrating all of the documentation from
http://docs.castleproject.org/ into each project's git repo. There is
now a docs directory each project's git repo with a README.md file.
e.g. https://github.com/castleproject/Windsor/blob/master/docs/README.md
The entry point of the wiki is now in the home git repo (
https://github.com/castleproject/Home) which now sort of does a similar
purpose to the web site.
We can now easily receive, review and merge changes to documentation with
pull requests.
FYI I've removed all the pages from the wiki excluding the Windsor pages
which I've put a link to the new location so that StackOverflow answers and
other inbound links will allow users to find the page. Not sure how long we
want to keep STW running for.
--
Jono
--
You received this message because you are subscribed to the Google Groups
"Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send an
To post to this group, send email to
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups
"Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send an
.
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.

[Krzysztof Koźmic]

I don't think I do.

Post by Jonathon Rossi
Thanks, it took much longer than I thought it was going to. I
removed/fixed some obsolete content as I went, but there is still some
more, but hopefully users are more likely to fix it now on GitHub.
It looks like we've got Google Analytics on that page, have you got access
to it?
On Thu, Jun 11, 2015 at 4:22 PM, Krzysztof Koźmic <

Post by Krzysztof Koźmic
Love your work Jono.
Re STW: let's monitor how much traffic it gets, and once it goes down
significantly shut it down

Post by Jonathon Rossi
I've finished migrating all of the documentation from
http://docs.castleproject.org/ into each project's git repo. There is
now a docs directory each project's git repo with a README.md file.
e.g. https://github.com/castleproject/Windsor/blob/master/docs/README.md
The entry point of the wiki is now in the home git repo (
https://github.com/castleproject/Home) which now sort of does a similar
purpose to the web site.
We can now easily receive, review and merge changes to documentation
with pull requests.
FYI I've removed all the pages from the wiki excluding the Windsor pages
which I've put a link to the new location so that StackOverflow answers and
other inbound links will allow users to find the page. Not sure how long we
want to keep STW running for.
--
Jono
--
You received this message because you are subscribed to the Google
Groups "Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send
To post to this group, send email to
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups
"Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send an
To post to this group, send email to
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.

--
Jono
--
You received this message because you are subscribed to the Google Groups
"Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send an
.
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.

[Jonathon Rossi]

Ah, it's the same analytics ID that the old castleproject.org site used, so
Henry would have access.

https://github.com/castleproject/Castleproject.org-Site-READONLY/blob/0a7826a117180e97a2de6f4c3f949b6f3331ae65/site.vsl#L327

On Thu, Jun 11, 2015 at 4:53 PM, Krzysztof Koźmic <

Post by Krzysztof Koźmic
I don't think I do.

Post by Jonathon Rossi
Thanks, it took much longer than I thought it was going to. I
removed/fixed some obsolete content as I went, but there is still some
more, but hopefully users are more likely to fix it now on GitHub.
It looks like we've got Google Analytics on that page, have you got
access to it?
On Thu, Jun 11, 2015 at 4:22 PM, Krzysztof Koźmic <

Post by Krzysztof Koźmic
Love your work Jono.
Re STW: let's monitor how much traffic it gets, and once it goes down
significantly shut it down

Post by Jonathon Rossi
I've finished migrating all of the documentation from
http://docs.castleproject.org/ into each project's git repo. There is
now a docs directory each project's git repo with a README.md file.
e.g.
https://github.com/castleproject/Windsor/blob/master/docs/README.md
The entry point of the wiki is now in the home git repo (
https://github.com/castleproject/Home) which now sort of does a
similar purpose to the web site.
We can now easily receive, review and merge changes to documentation
with pull requests.
FYI I've removed all the pages from the wiki excluding the Windsor
pages which I've put a link to the new location so that StackOverflow
answers and other inbound links will allow users to find the page. Not sure
how long we want to keep STW running for.
--
Jono
--
You received this message because you are subscribed to the Google
Groups "Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send
To post to this group, send email to
Visit this group at http://groups.google.com/group/castle-project-devel
.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google
Groups "Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send
To post to this group, send email to
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.

--
Jono
--
You received this message because you are subscribed to the Google Groups
"Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send an
To post to this group, send email to
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups
"Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send an
.
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.

[hammett]

+1
Thanks a lot!

On Wed, Jun 10, 2015 at 11:22 PM, Krzysztof Koźmic

Post by Krzysztof Koźmic
Love your work Jono.
Re STW: let's monitor how much traffic it gets, and once it goes down
significantly shut it down

Post by Jonathon Rossi
I've finished migrating all of the documentation from
http://docs.castleproject.org/ into each project's git repo. There is now a
docs directory each project's git repo with a README.md file.
e.g. https://github.com/castleproject/Windsor/blob/master/docs/README.md
The entry point of the wiki is now in the home git repo
(https://github.com/castleproject/Home) which now sort of does a similar
purpose to the web site.
We can now easily receive, review and merge changes to documentation with
pull requests.
FYI I've removed all the pages from the wiki excluding the Windsor pages
which I've put a link to the new location so that StackOverflow answers and
other inbound links will allow users to find the page. Not sure how long we
want to keep STW running for.
--
Jono
--
You received this message because you are subscribed to the Google Groups
"Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send an
To post to this group, send email to
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups
"Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send an
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.

--
Cheers,
hammett
http://www.d-collab.com/
http://www.hammettblog.com/

[Janco Wolmarans]

Hi Jonathon,

What did you use to do the screwturn to markdown conversion? Apologies if
this is a little off topic, but we're trying to migrate one of our internal
wikis, and are looking for tools to do that.

Regards
Janco

Post by Jonathon Rossi
I've finished migrating all of the documentation from
http://docs.castleproject.org/ into each project's git repo. There is now
a docs directory each project's git repo with a README.md file.
e.g. https://github.com/castleproject/Windsor/blob/master/docs/README.md
The entry point of the wiki is now in the home git repo (
https://github.com/castleproject/Home) which now sort of does a similar
purpose to the web site.
We can now easily receive, review and merge changes to documentation with
pull requests.
FYI I've removed all the pages from the wiki excluding the Windsor pages
which I've put a link to the new location so that StackOverflow answers and
other inbound links will allow users to find the page. Not sure how long we
want to keep STW running for.
--
Jono

[Jonathon Rossi]

Nothing fancy because I had to avoid destroying inline code which can have
wiki syntax (e.g. windsor config has "{{...}}"). There was also all sorts
of random escaped wikitext that people needed to get STW to display what we
wanted. Along with the conversation I skim read the majority of pages as I
went and rearranged things, fixed headers that had the wrong indentation
level and many other problems.

If you've got a cleaner set you might be able to find some tools but I
didn't find anything I was confident to run. I basically had a script using
grep (with --color) that would display all in wikitext symbols (i.e. [[,
[[, {{, }}, @@, '', ''', &lt;, &gt;, and those annoying quotes from Word).
If it looked good I used another script to replace a few of those symbols.
I then jumped into Atom and manually edited headers and a bunch of other
things, then ran the first script which also ran markdownlint (
https://github.com/mivok/markdownlint) until I had no more symbols left and
no more lint warnings, I then finished by having a look at the markdown
preview in Atom.

Yep, sounds pretty painful, but I did a lot of clean up as I went and
deleted a bunch of duplicate content, merged some pages, cleaned up some
code samples, etc. I did most of it while watching TV as to burn the least
amount of real time doing it.

Sorry that I don't have a silver bullet to offer.

Post by Janco Wolmarans
Hi Jonathon,
What did you use to do the screwturn to markdown conversion? Apologies if
this is a little off topic, but we're trying to migrate one of our internal
wikis, and are looking for tools to do that.
Regards
Janco

Post by Jonathon Rossi
I've finished migrating all of the documentation from
http://docs.castleproject.org/ into each project's git repo. There is
now a docs directory each project's git repo with a README.md file.
e.g. https://github.com/castleproject/Windsor/blob/master/docs/README.md
The entry point of the wiki is now in the home git repo (
https://github.com/castleproject/Home) which now sort of does a similar
purpose to the web site.
We can now easily receive, review and merge changes to documentation with
pull requests.
FYI I've removed all the pages from the wiki excluding the Windsor pages
which I've put a link to the new location so that StackOverflow answers and
other inbound links will allow users to find the page. Not sure how long we
want to keep STW running for.
--
Jono

--
You received this message because you are subscribed to the Google Groups
"Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send an
.
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.

[Janco Wolmarans]

Thanks for the info. We went with this code as a starting point, and
modified it where we picked up some issues:
https://bitbucket.org/bleroy/screwturn2markdown

Cheers.

Post by Jonathon Rossi
Nothing fancy because I had to avoid destroying inline code which can have
wiki syntax (e.g. windsor config has "{{...}}"). There was also all sorts
of random escaped wikitext that people needed to get STW to display what we
wanted. Along with the conversation I skim read the majority of pages as I
went and rearranged things, fixed headers that had the wrong indentation
level and many other problems.
If you've got a cleaner set you might be able to find some tools but I
didn't find anything I was confident to run. I basically had a script using
grep (with --color) that would display all in wikitext symbols (i.e. [[,
If it looked good I used another script to replace a few of those symbols.
I then jumped into Atom and manually edited headers and a bunch of other
things, then ran the first script which also ran markdownlint (
https://github.com/mivok/markdownlint) until I had no more symbols left
and no more lint warnings, I then finished by having a look at the markdown
preview in Atom.
Yep, sounds pretty painful, but I did a lot of clean up as I went and
deleted a bunch of duplicate content, merged some pages, cleaned up some
code samples, etc. I did most of it while watching TV as to burn the least
amount of real time doing it.
Sorry that I don't have a silver bullet to offer.

Post by Janco Wolmarans
Hi Jonathon,
What did you use to do the screwturn to markdown conversion? Apologies if
this is a little off topic, but we're trying to migrate one of our internal
wikis, and are looking for tools to do that.
Regards
Janco

Post by Jonathon Rossi
I've finished migrating all of the documentation from
http://docs.castleproject.org/ into each project's git repo. There is
now a docs directory each project's git repo with a README.md file.
e.g. https://github.com/castleproject/Windsor/blob/master/docs/README.md
The entry point of the wiki is now in the home git repo (
https://github.com/castleproject/Home) which now sort of does a similar
purpose to the web site.
We can now easily receive, review and merge changes to documentation
with pull requests.
FYI I've removed all the pages from the wiki excluding the Windsor pages
which I've put a link to the new location so that StackOverflow answers and
other inbound links will allow users to find the page. Not sure how long we
want to keep STW running for.
--
Jono

--
You received this message because you are subscribed to the Google Groups
"Castle Project Development List" group.
To unsubscribe from this group and stop receiving emails from it, send an
To post to this group, send email to
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.

--
Jono
--
You received this message because you are subscribed to a topic in the
Google Groups "Castle Project Development List" group.
To unsubscribe from this topic, visit
https://groups.google.com/d/topic/castle-project-devel/HOTDC1YDukI/unsubscribe
.
To unsubscribe from this group and all its topics, send an email to
.
Visit this group at http://groups.google.com/group/castle-project-devel.
For more options, visit https://groups.google.com/d/optout.