Make Wiki publicly editable / Wiki Pull Request #252

Closed
JohannesRudolph opened this Issue May 8, 2013 · 23 comments

Comments

Projects
None yet
4 participants
@JohannesRudolph

Hi Stuart, you've done some excellent work with MvvmCross. I'm right now in the middle of learning it, and while at that I though I improve the documentation (which is in pretty bad shape!)

I have re-structured and updated the wiki at my fork. If you're ok with my changes, can you please pull from that repo?

git@github.com:JohannesRudolph/MvvmCross.wiki.git

If you could also make your wiki publicly editable (repository settings) that'd make life for contributors much easier. We could include/destilate information from your blog piece by piece.

@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge May 8, 2013

Contributor

Thanks

Will take a look at this soon - probably tomorrow - I'm in the middle of preparing for tonight's presentation right now.

If you are interested in contributing to the current docs effort, it might be worth talking with a few of the people on the jabbr group - together we can hopefully split up the task, avoid overlap waste, and make it easier and more fun :)

Thanks - more tomorrow!

Stuart

Contributor

slodge commented May 8, 2013

Thanks

Will take a look at this soon - probably tomorrow - I'm in the middle of preparing for tonight's presentation right now.

If you are interested in contributing to the current docs effort, it might be worth talking with a few of the people on the jabbr group - together we can hopefully split up the task, avoid overlap waste, and make it easier and more fun :)

Thanks - more tomorrow!

Stuart

@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge May 9, 2013

Contributor

Hi

I don't know if you got a chance to hook up with @rafealsteil on this?

As I've said on jabbr I am planning to look at the documentation area after I get this latest batch of talks out of the way... but I can't before then.

I also gave details (6 March?) about what I personally feel about XML docs inside the source code versus inside sample projects (all IMHO stuff)

I also gave details about the fact that I love seeing people just publish stuff on their own blogs, on codeproject.com, channel9, geekchamp.com, etc as well as people contributing to community things - sometimes people can make a huge difference by doing things externally... e.g. greg's magazine article and gitte's techdays-be talk - both of which were done without ever asking me a question, waiting for me to give any kind of approval, etc

I am also doing the N+1 videos - and would like to do a shorter, better quality pluralsight type course

I am also talking with some bigger companies who are talking about offering help on the documentation front - these talks take time and are confidential so I can't say more....

I have published a list of what I would tackle... http://slodge.blogspot.co.uk/2013/02/mvvmcross-v3-documentation-plan.html and this did create the first tutorial http://slodge.blogspot.co.uk/2013/03/hot-tuna-docs-mvvmcross-v3-slowly.html

.....

However, I also love the idea of getting better documents too :) Of course, I want everything :) And I love having people like Rafael and yourself volunteer such fab contributions.

if people would like to contribute to a centralised document store, then what I propose is that I open up access to https://github.com/MvvmCross/Documents and that you store/create/edit them there as wikis and/or as github pages. I'll then close the wiki on https://github.com/slodge/MvvmCross and provide readme and blog links to the new community location. At some point in the future we might be able to merge the docs back in with the main source repo - but right now I'd just prefer them to be separate - the separation helps in my mind :)

How's that? Would that work? Please do push back with suggestions that would make it more awesome...

Stuart
(a bit busy this week, so maybe not thinking straight!)

Contributor

slodge commented May 9, 2013

Hi

I don't know if you got a chance to hook up with @rafealsteil on this?

As I've said on jabbr I am planning to look at the documentation area after I get this latest batch of talks out of the way... but I can't before then.

I also gave details (6 March?) about what I personally feel about XML docs inside the source code versus inside sample projects (all IMHO stuff)

I also gave details about the fact that I love seeing people just publish stuff on their own blogs, on codeproject.com, channel9, geekchamp.com, etc as well as people contributing to community things - sometimes people can make a huge difference by doing things externally... e.g. greg's magazine article and gitte's techdays-be talk - both of which were done without ever asking me a question, waiting for me to give any kind of approval, etc

I am also doing the N+1 videos - and would like to do a shorter, better quality pluralsight type course

I am also talking with some bigger companies who are talking about offering help on the documentation front - these talks take time and are confidential so I can't say more....

I have published a list of what I would tackle... http://slodge.blogspot.co.uk/2013/02/mvvmcross-v3-documentation-plan.html and this did create the first tutorial http://slodge.blogspot.co.uk/2013/03/hot-tuna-docs-mvvmcross-v3-slowly.html

.....

However, I also love the idea of getting better documents too :) Of course, I want everything :) And I love having people like Rafael and yourself volunteer such fab contributions.

if people would like to contribute to a centralised document store, then what I propose is that I open up access to https://github.com/MvvmCross/Documents and that you store/create/edit them there as wikis and/or as github pages. I'll then close the wiki on https://github.com/slodge/MvvmCross and provide readme and blog links to the new community location. At some point in the future we might be able to merge the docs back in with the main source repo - but right now I'd just prefer them to be separate - the separation helps in my mind :)

How's that? Would that work? Please do push back with suggestions that would make it more awesome...

Stuart
(a bit busy this week, so maybe not thinking straight!)

@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge May 27, 2013

Contributor

Just putting the links in here... slowly will try to get everything done...

Just got to get this out of chat if I can...

Contributor

slodge commented May 27, 2013

Just putting the links in here... slowly will try to get everything done...

Just got to get this out of chat if I can...

@ghuntley

This comment has been minimized.

Show comment
Hide comment
@ghuntley

ghuntley Jun 2, 2013

Member

Howdy,

I've got something setup and this is an open invitation to all to help out with documentation (the layout of which is being heavily based upon the Xamarin documentation navigation structure). HTML markup has been generously forked from @zurb/foundation and may change in the future. Right now I promise if you contribute anything substantial it will be included and navigation structure right now is only proposed to get people thinking - if you have a idea, make the change and we'll discuss on the commit comments.

re: hosting infrastructure:

Documentation (and the entire website) is hosted on GitHub using GitHub pages, this is achieved using Jekyll (http://jekyllrb.com/) and putting all data on a "gh-pages" branch (http://pages.github.com/). The decision behind this vs github wiki is that this allows us to customise the look/feel of the documentation and host the core website as well on GitHub; thus removing sysadmin time and reducing barriers to contribution.

For now I've created https://github.com/ghuntley/MvvmCross-Documentation/ and have added @JohannesRudolph, @rafaelsteil, @slodge, @Redth and @Cheesebaron as contributors. If anyone else wants direct edit access then post here in this issue and I'll add you in - otherwise you can contribute using the pull request system on the repo.

You can view the current state of the docs at http://d559ko54.com/docs/solution-layout.html

Once we have enough momentum/documentation we'll redirect my repo over to @slodge/MvvmCross-Website and mvvmcross.com

re: editing the documentation:

If you have write access to the repository then you can edit directly from within the GitHub interface and it will publish the site changes immediately or you can clone locally, make your changes and then on push the changes will become live.

All documentation and webpages are done using MarkDown but CAN contain a mixture of MarkDown and HTML (see 1970-01-01-solution-layout.markdown)

Source: https://raw.github.com/ghuntley/MvvmCross-Documentation/gh-pages/_posts/1970-01-01-linker-include.markdown
Result: http://d559ko54.com/docs/linker-include.html

When creating a new page there exists the following convention:

re: editing locally on your machine:

  • Install http://jekyllrb.com

  • From command line run:

    jekyll serve

  • Visit http://localhost:4000/docs/

  • Make your changes using your favourite markdown/text editor, upon save jekyll will see that the file has changed and rebuild the entire documentation.

re: content:

Have a Trello board active for tasks, right now there are no tasks but heaps of references to branding, where the framework is being used, etc which serves as a useful starting point for the basics.

https://trello.com/board/branding-website-documentation/519630837c66d4eb70008e07

My suggestion is to split each section/pages up into Trello tasks and organise via there but just as happy to coordinate using issue #252. Which ever is the lowest barrier/friction to contributing.

  • Full class documentation seems like it would be a bitch to keep up to date and not really worth it.
  • Unit tests do serve as good documentation for some cases, but it wouldn't really be enough on its own for a project like this and high quality samples and guides within the documentation would go much further.
  • CI is probably a job for another month or two though away (awaiting on Xam!)
  • @slodge 's documentation plan is at http://slodge.blogspot.co.uk/2013/02/mvvmcross-v3-documentation-plan.html
Member

ghuntley commented Jun 2, 2013

Howdy,

I've got something setup and this is an open invitation to all to help out with documentation (the layout of which is being heavily based upon the Xamarin documentation navigation structure). HTML markup has been generously forked from @zurb/foundation and may change in the future. Right now I promise if you contribute anything substantial it will be included and navigation structure right now is only proposed to get people thinking - if you have a idea, make the change and we'll discuss on the commit comments.

re: hosting infrastructure:

Documentation (and the entire website) is hosted on GitHub using GitHub pages, this is achieved using Jekyll (http://jekyllrb.com/) and putting all data on a "gh-pages" branch (http://pages.github.com/). The decision behind this vs github wiki is that this allows us to customise the look/feel of the documentation and host the core website as well on GitHub; thus removing sysadmin time and reducing barriers to contribution.

For now I've created https://github.com/ghuntley/MvvmCross-Documentation/ and have added @JohannesRudolph, @rafaelsteil, @slodge, @Redth and @Cheesebaron as contributors. If anyone else wants direct edit access then post here in this issue and I'll add you in - otherwise you can contribute using the pull request system on the repo.

You can view the current state of the docs at http://d559ko54.com/docs/solution-layout.html

Once we have enough momentum/documentation we'll redirect my repo over to @slodge/MvvmCross-Website and mvvmcross.com

re: editing the documentation:

If you have write access to the repository then you can edit directly from within the GitHub interface and it will publish the site changes immediately or you can clone locally, make your changes and then on push the changes will become live.

All documentation and webpages are done using MarkDown but CAN contain a mixture of MarkDown and HTML (see 1970-01-01-solution-layout.markdown)

Source: https://raw.github.com/ghuntley/MvvmCross-Documentation/gh-pages/_posts/1970-01-01-linker-include.markdown
Result: http://d559ko54.com/docs/linker-include.html

When creating a new page there exists the following convention:

re: editing locally on your machine:

  • Install http://jekyllrb.com

  • From command line run:

    jekyll serve

  • Visit http://localhost:4000/docs/

  • Make your changes using your favourite markdown/text editor, upon save jekyll will see that the file has changed and rebuild the entire documentation.

re: content:

Have a Trello board active for tasks, right now there are no tasks but heaps of references to branding, where the framework is being used, etc which serves as a useful starting point for the basics.

https://trello.com/board/branding-website-documentation/519630837c66d4eb70008e07

My suggestion is to split each section/pages up into Trello tasks and organise via there but just as happy to coordinate using issue #252. Which ever is the lowest barrier/friction to contributing.

  • Full class documentation seems like it would be a bitch to keep up to date and not really worth it.
  • Unit tests do serve as good documentation for some cases, but it wouldn't really be enough on its own for a project like this and high quality samples and guides within the documentation would go much further.
  • CI is probably a job for another month or two though away (awaiting on Xam!)
  • @slodge 's documentation plan is at http://slodge.blogspot.co.uk/2013/02/mvvmcross-v3-documentation-plan.html
@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge Jun 4, 2013

Contributor

Thanks

Looking like lots of progress.

I'm still getting my head around this - plus I'm trying to get customer work out the way (so I'm not focussing properly on this - sorry)

A couple of quick questions:

  1. Is there an easy to read one-pager somewhere about the markdown flavour being used? I look at https://github.com/slodge/MvvmCross-Documentation/blob/gh-pages/_posts/1970-01-01-solution-layout.markdown or https://github.com/slodge/MvvmCross-Documentation/edit/gh-pages/_posts/1970-01-01-linker-include.markdown and it seems a bit technical compared to my normal markdown
  2. Is there any way to create new files using just the github web interface? I can see how to edit existing files, but I kind of wanted to play "somewhere safe" - so in a new file

My intention right now is to try to get some time on just 'writing stuff down' - and I love the idea of using webpages with instant publishing to do that :)

Cheers

Stuart

PS I have no intention of this ever ending up inside /slodge on github - I've set up /mvvmcross and I really want to transfer stuff in there :)

Contributor

slodge commented Jun 4, 2013

Thanks

Looking like lots of progress.

I'm still getting my head around this - plus I'm trying to get customer work out the way (so I'm not focussing properly on this - sorry)

A couple of quick questions:

  1. Is there an easy to read one-pager somewhere about the markdown flavour being used? I look at https://github.com/slodge/MvvmCross-Documentation/blob/gh-pages/_posts/1970-01-01-solution-layout.markdown or https://github.com/slodge/MvvmCross-Documentation/edit/gh-pages/_posts/1970-01-01-linker-include.markdown and it seems a bit technical compared to my normal markdown
  2. Is there any way to create new files using just the github web interface? I can see how to edit existing files, but I kind of wanted to play "somewhere safe" - so in a new file

My intention right now is to try to get some time on just 'writing stuff down' - and I love the idea of using webpages with instant publishing to do that :)

Cheers

Stuart

PS I have no intention of this ever ending up inside /slodge on github - I've set up /mvvmcross and I really want to transfer stuff in there :)

@rafaelsteil

This comment has been minimized.

Show comment
Hide comment
@rafaelsteil

rafaelsteil Jun 4, 2013

Hey all,

just to let you all know that I am alive and following with all the discussions, I just being beaten by parallel demands and employees on vacation, but I hope to change that very soon :)

Hey all,

just to let you all know that I am alive and following with all the discussions, I just being beaten by parallel demands and employees on vacation, but I hope to change that very soon :)

@ghuntley

This comment has been minimized.

Show comment
Hide comment
@ghuntley

ghuntley Jun 5, 2013

Member

@slodge

re: your questions

  1. It uses the official Markdown style, as per the specification:

http://daringfireball.net/projects/markdown/syntax

You can mix in HTML if you want to do complicated things like display data in a table, etc.

As a proper example have taken the source from:

https://github.com/mojombo/jekyll/edit/gh-pages/docs/pages.md

Created this:

https://github.com/ghuntley/MvvmCross-Documentation/blob/gh-pages/_posts/1970-01-01-copy-and-paste.markdown

Which ends up like this:

http://d559ko54.com/docs/copy-and-paste.html

Information about the backend engine is available at http://jekyllrb.com/ and http://pages.github.com/

  1. Yes you can create new files without having to clone, meaning the entire website/docs is editable from the browser or via the usual git clone/commit/push cycle. See:

https://github.com/blog/1327-creating-files-on-github

re: the way forward.

If you do your editing on a fork of ghuntley/mvvm-crossdocumentation then the website at d559ko54.com will not automatically update. You have write access to ghuntley/mvvmcross-documentation which when updated will automatically publish to my domain.

You are more then welcome for now to do all edits directly in that repository and at a later stage we'll move it cross to @mvvmcross/website and the domain of mvvmcross.com.

OR

  • Take a copy of the repository as it is now
  • Create @mvvmcross/website push the repository there.
  • Update the file named CNAME and change to mvvmcross.com
  • Commit and push the updated file back to github.
  • Update your DNS entries on mvvmcross.com as follows -> https://help.github.com/articles/setting-up-a-custom-domain-with-pages
  • Grant commit access to the website repo to the usual suspects.
Member

ghuntley commented Jun 5, 2013

@slodge

re: your questions

  1. It uses the official Markdown style, as per the specification:

http://daringfireball.net/projects/markdown/syntax

You can mix in HTML if you want to do complicated things like display data in a table, etc.

As a proper example have taken the source from:

https://github.com/mojombo/jekyll/edit/gh-pages/docs/pages.md

Created this:

https://github.com/ghuntley/MvvmCross-Documentation/blob/gh-pages/_posts/1970-01-01-copy-and-paste.markdown

Which ends up like this:

http://d559ko54.com/docs/copy-and-paste.html

Information about the backend engine is available at http://jekyllrb.com/ and http://pages.github.com/

  1. Yes you can create new files without having to clone, meaning the entire website/docs is editable from the browser or via the usual git clone/commit/push cycle. See:

https://github.com/blog/1327-creating-files-on-github

re: the way forward.

If you do your editing on a fork of ghuntley/mvvm-crossdocumentation then the website at d559ko54.com will not automatically update. You have write access to ghuntley/mvvmcross-documentation which when updated will automatically publish to my domain.

You are more then welcome for now to do all edits directly in that repository and at a later stage we'll move it cross to @mvvmcross/website and the domain of mvvmcross.com.

OR

  • Take a copy of the repository as it is now
  • Create @mvvmcross/website push the repository there.
  • Update the file named CNAME and change to mvvmcross.com
  • Commit and push the updated file back to github.
  • Update your DNS entries on mvvmcross.com as follows -> https://help.github.com/articles/setting-up-a-custom-domain-with-pages
  • Grant commit access to the website repo to the usual suspects.
@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge Jun 7, 2013

Contributor

Have tried adding my first page

http://d559ko54.com/docs/ioc.html

So far;

  • the good
    • it just worked :) :) :) :) :) :) :) :) :)
    • it was really quick to do
    • I could cut and paste from StackOveflow
  • the not so good

Will keep trying/playing - although I'm way too busy right now - thanks for pushing this forwards and sorry I'm not spending more time on this!

Stuart

Contributor

slodge commented Jun 7, 2013

Have tried adding my first page

http://d559ko54.com/docs/ioc.html

So far;

  • the good
    • it just worked :) :) :) :) :) :) :) :) :)
    • it was really quick to do
    • I could cut and paste from StackOveflow
  • the not so good

Will keep trying/playing - although I'm way too busy right now - thanks for pushing this forwards and sorry I'm not spending more time on this!

Stuart

@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge Jun 7, 2013

Contributor

also added http://d559ko54.com/docs/mvxtableviewsource.html

still using stackoverflow as my editor at the moment...

Contributor

slodge commented Jun 7, 2013

also added http://d559ko54.com/docs/mvxtableviewsource.html

still using stackoverflow as my editor at the moment...

@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge Jun 24, 2013

Contributor

Have continued adding some more to https://github.com/ghuntley/MvvmCross-Documentation

e.g.:

I've also continued to record lots of N+1's - http://mvvmcross.wordpress.com

I'd like to get to a state soon where:

  • The main MvvmCross readme is more welcoming
  • The N+1 videos are all in the ghuntley documentation repo (even if it's just a copy of the Mvvmcross.wordpress.com index)
  • plus we can add links to the Evolve video, to the Xaminar, to the Azure Cloud-to-Client video, to the NDC video (when available), to the spanish intro (if available), to Gitte's TechDays talk, to Daniel's BUILD talk, etc
  • The TipCalc tutorial is updated and copied into the ghuntley documentation
  • We've completed the high level pages and also written a few more basic pages - i.e.

Note: I'm not sure we need that many more in order to get a basic site up and running)

I don't want to plan a big docs site with lots of pages right now - let's do this agile with a small functioning site which we can then grow.

If we can get a first set of pages done, then:

  • I'll move slodge/mvvmcross over to mvvmcross/mvvmcross and copy in whatever the new readme is.
  • we can move ghuntley/mvvmcross-documentation into a mvvmcross/ repo too (and do whatever DNS magic is required
  • we can move forwards :) :) :) :) :) :)

Please post here whatever anyone wants to contribute to this :)

Contributor

slodge commented Jun 24, 2013

Have continued adding some more to https://github.com/ghuntley/MvvmCross-Documentation

e.g.:

I've also continued to record lots of N+1's - http://mvvmcross.wordpress.com

I'd like to get to a state soon where:

  • The main MvvmCross readme is more welcoming
  • The N+1 videos are all in the ghuntley documentation repo (even if it's just a copy of the Mvvmcross.wordpress.com index)
  • plus we can add links to the Evolve video, to the Xaminar, to the Azure Cloud-to-Client video, to the NDC video (when available), to the spanish intro (if available), to Gitte's TechDays talk, to Daniel's BUILD talk, etc
  • The TipCalc tutorial is updated and copied into the ghuntley documentation
  • We've completed the high level pages and also written a few more basic pages - i.e.

Note: I'm not sure we need that many more in order to get a basic site up and running)

I don't want to plan a big docs site with lots of pages right now - let's do this agile with a small functioning site which we can then grow.

If we can get a first set of pages done, then:

  • I'll move slodge/mvvmcross over to mvvmcross/mvvmcross and copy in whatever the new readme is.
  • we can move ghuntley/mvvmcross-documentation into a mvvmcross/ repo too (and do whatever DNS magic is required
  • we can move forwards :) :) :) :) :) :)

Please post here whatever anyone wants to contribute to this :)

@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge Jul 2, 2013

Contributor

Am a bit lost on status... feels like the docs effort is the opposite of agile...

I'm currently hacking at a data binding doc - https://github.com/slodge/MvvmCross/wiki/Databinding

Have put this on the local wiki here while we work out where things are really going.

Will try to finish this doc this week

Stuart

Contributor

slodge commented Jul 2, 2013

Am a bit lost on status... feels like the docs effort is the opposite of agile...

I'm currently hacking at a data binding doc - https://github.com/slodge/MvvmCross/wiki/Databinding

Have put this on the local wiki here while we work out where things are really going.

Will try to finish this doc this week

Stuart

@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge Jul 2, 2013

Contributor

That came across less bouncy than I intended... assume it's midnight and I've been writing docs for the last 5 hours :)

It's gonna be lovely and I'm excited :)

Bounce bounce bounce

Contributor

slodge commented Jul 2, 2013

That came across less bouncy than I intended... assume it's midnight and I've been writing docs for the last 5 hours :)

It's gonna be lovely and I'm excited :)

Bounce bounce bounce

@rafaelsteil

This comment has been minimized.

Show comment
Hide comment
@rafaelsteil

rafaelsteil Jul 4, 2013

@slodge just to make sure, we'll continue to add the documentation to @ghuntley's repo, as discussed so far? I am asking because the (great) Databinding work is currently on your repo. Will it be migrated to @ghuntley documentation repository?

Right now I am starting to write some documentation about IoC, focusing on general questions I know a lot of people will have, based again on my own experience at my job.

@slodge just to make sure, we'll continue to add the documentation to @ghuntley's repo, as discussed so far? I am asking because the (great) Databinding work is currently on your repo. Will it be migrated to @ghuntley documentation repository?

Right now I am starting to write some documentation about IoC, focusing on general questions I know a lot of people will have, based again on my own experience at my job.

@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge Jul 4, 2013

Contributor

@rafaelsteil The wiki is temporary.

I've lost track of where stuff's at

I think the migration of the docs is still in-flux - so that's why I put the work-in-progress on the wiki - I was scared if I put it in the wrong place I'd lose it.

As soon as the migration is clear, I'll move the wiki copy (and the wiki TipCalc tutorial too)... or if the migration is too hard/gets stuck then we'll make a call on quickly doing "something different".

Stuart

Contributor

slodge commented Jul 4, 2013

@rafaelsteil The wiki is temporary.

I've lost track of where stuff's at

I think the migration of the docs is still in-flux - so that's why I put the work-in-progress on the wiki - I was scared if I put it in the wrong place I'd lose it.

As soon as the migration is clear, I'll move the wiki copy (and the wiki TipCalc tutorial too)... or if the migration is too hard/gets stuck then we'll make a call on quickly doing "something different".

Stuart

@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge Jul 6, 2013

Contributor

I'm going to try to get a few more articles written and finished in the next couple of weeks...

For now I've pulled back the articles that were at least starting to take shape into https://github.com/slodge/MvvmCross/wiki and I'll continue to add them there using GitHub-Wiki-Markdown.

When we work out what/where/how the 'real docs' will live then I'll happily move things - transferring markdown to a different venue is easy. For now I just need to look at one set of documents and I need to avoid the jekyll %syntax% issues - I just want to get on and write stuff :)

Hope that's ok with everyone - not sure if I'm just getting in the way here - sorry if I am - just trying to get some docs out and currently struggling to work out who else is doing what :/

Let me know if I'm being a doofus and missing the obvious anywhere!

Stuart

Contributor

slodge commented Jul 6, 2013

I'm going to try to get a few more articles written and finished in the next couple of weeks...

For now I've pulled back the articles that were at least starting to take shape into https://github.com/slodge/MvvmCross/wiki and I'll continue to add them there using GitHub-Wiki-Markdown.

When we work out what/where/how the 'real docs' will live then I'll happily move things - transferring markdown to a different venue is easy. For now I just need to look at one set of documents and I need to avoid the jekyll %syntax% issues - I just want to get on and write stuff :)

Hope that's ok with everyone - not sure if I'm just getting in the way here - sorry if I am - just trying to get some docs out and currently struggling to work out who else is doing what :/

Let me know if I'm being a doofus and missing the obvious anywhere!

Stuart

@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge Jul 26, 2013

Contributor

I've pushed on a littte more with this ...

I've pushed some more content to the wiki - https://github.com/slodge/MvvmCross/wiki - and removed lots of TODOs. It does now look like a Wiki is going to be the place where information is written - the formatting overhead of jekyll was only small, but the zero-information compile errors made it unfriendly :( On the reverse side... I don't really like the limited version history on the Wiki! Hopefully GitHub will launch some new feature for us soon :)

I'll continue posting updates about what docs I get written here - plus I'll also make a conscious effort to transfer answers and blog posts into the wiki in the future. Completely understand that others are busy - the app is king - what we have now is a good starting point. Will look to add more over the coming months

Stuart

Contributor

slodge commented Jul 26, 2013

I've pushed on a littte more with this ...

I've pushed some more content to the wiki - https://github.com/slodge/MvvmCross/wiki - and removed lots of TODOs. It does now look like a Wiki is going to be the place where information is written - the formatting overhead of jekyll was only small, but the zero-information compile errors made it unfriendly :( On the reverse side... I don't really like the limited version history on the Wiki! Hopefully GitHub will launch some new feature for us soon :)

I'll continue posting updates about what docs I get written here - plus I'll also make a conscious effort to transfer answers and blog posts into the wiki in the future. Completely understand that others are busy - the app is king - what we have now is a good starting point. Will look to add more over the coming months

Stuart

@ghuntley

This comment has been minimized.

Show comment
Hide comment
@ghuntley

ghuntley Jul 26, 2013

Member

Agree, content first then worry about the presentation layer.

@mvvmcross.com/dev.mvvmcross.com has been rebased and can be used later if desired:

Member

ghuntley commented Jul 26, 2013

Agree, content first then worry about the presentation layer.

@mvvmcross.com/dev.mvvmcross.com has been rebased and can be used later if desired:

@rafaelsteil

This comment has been minimized.

Show comment
Hide comment
@rafaelsteil

rafaelsteil Aug 15, 2013

@slodge I forked the wiki to add a small section to the IoC page, the diff is here: rafaelsteil/MvvmCross-Wiki@439964d

Not sure if it's the best approach, though.

@slodge I forked the wiki to add a small section to the IoC page, the diff is here: rafaelsteil/MvvmCross-Wiki@439964d

Not sure if it's the best approach, though.

@rafaelsteil

This comment has been minimized.

Show comment
Hide comment
@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge Aug 23, 2013

Contributor

@rafaelsteil thanks - i've added some updates based on these diffs at https://github.com/slodge/MvvmCross/wiki/Service-Location-and-Inversion-of-Control

I'm not sure if it's the best approach either - but it is manageable given the current levels. Very much still learning.

Just as with trying to encourage extensions and plugins to live outside the main repo, I think I'm still keen on getting others to publish their articles and tutorials externally too - but definitely still learning :)

Contributor

slodge commented Aug 23, 2013

@rafaelsteil thanks - i've added some updates based on these diffs at https://github.com/slodge/MvvmCross/wiki/Service-Location-and-Inversion-of-Control

I'm not sure if it's the best approach either - but it is manageable given the current levels. Very much still learning.

Just as with trying to encourage extensions and plugins to live outside the main repo, I think I'm still keen on getting others to publish their articles and tutorials externally too - but definitely still learning :)

@rafaelsteil

This comment has been minimized.

Show comment
Hide comment
@rafaelsteil

rafaelsteil Aug 23, 2013

Yes, it is a process we are going through, but the perspectives are good. Although the current set of information is still a bit sparse or outdated, it is much better than just a few months ago.

Here at the company we're hitting the point were we need the mvvm stuff to be created - so far we were working on hardcore core code -, and my approach to the team is being like ".. well, we need to do this and that, so take a look at these links at slodge's blog, these others at stackoverflow, and these mvvmcross tutorials, and extract the pieces you need from there, and then add to our internal wiki the puzzle pieces".

I believe (and want) that will be able to create documentation to contribute back with this approach.

Yes, it is a process we are going through, but the perspectives are good. Although the current set of information is still a bit sparse or outdated, it is much better than just a few months ago.

Here at the company we're hitting the point were we need the mvvm stuff to be created - so far we were working on hardcore core code -, and my approach to the team is being like ".. well, we need to do this and that, so take a look at these links at slodge's blog, these others at stackoverflow, and these mvvmcross tutorials, and extract the pieces you need from there, and then add to our internal wiki the puzzle pieces".

I believe (and want) that will be able to create documentation to contribute back with this approach.

@slodge

This comment has been minimized.

Show comment
Hide comment
@slodge

slodge Feb 2, 2014

Contributor

The wiki has actually been editable for months: https://github.com/MvvmCross/MvvmCross/wiki/_history

Would still love to have a nice looking github pages entry point - but that doesn't really fit in this old issue.

So closing this now.... Thanks all for all the input - between N+1, the wiki here and lots of bloggers and presenter we are in a much better position than we were - thank you all :)

Stuart

Contributor

slodge commented Feb 2, 2014

The wiki has actually been editable for months: https://github.com/MvvmCross/MvvmCross/wiki/_history

Would still love to have a nice looking github pages entry point - but that doesn't really fit in this old issue.

So closing this now.... Thanks all for all the input - between N+1, the wiki here and lots of bloggers and presenter we are in a much better position than we were - thank you all :)

Stuart

@slodge slodge closed this Feb 2, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment