New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move Old Wiki Docs To MonoGame Docs #4080

Open
tomspilman opened this Issue Aug 16, 2015 · 27 comments

Comments

Projects
None yet
4 participants
@tomspilman
Member

tomspilman commented Aug 16, 2015

We need one or more people to go thru the old wiki docs and decide what content there is worth moving over to the new MonoGame docs in the repo:

Old Wiki Docs: https://github.com/mono/MonoGame/wiki
New Docs: https://github.com/mono/MonoGame/tree/develop/Documentation

It should be done only a page or two at a time. Please chime in here first if you plan to work on particular pages from the wiki.

Once the doc PR is merged we can delete those old pages from the wiki. Eventually we should end up with an empty wiki simply pointing people to the official docs on the website.

@emersont1

This comment has been minimized.

Show comment
Hide comment
@emersont1

emersont1 Nov 4, 2015

Hi
I'm in the process of migrating the git pages all into on page, but there seems to be conflicting information in [[GIT'n Some Updates]] and [[GIT'ing Started with git]]
Getting some updates mentions downloading a zip, but the update section in getting started doesn't

Hi
I'm in the process of migrating the git pages all into on page, but there seems to be conflicting information in [[GIT'n Some Updates]] and [[GIT'ing Started with git]]
Getting some updates mentions downloading a zip, but the update section in getting started doesn't

@tomspilman

This comment has been minimized.

Show comment
Hide comment
@tomspilman

tomspilman Nov 5, 2015

Member

That probably needs to be re-written anyway. I say pick whichever you think is more correct and we can revisit it again later.

Member

tomspilman commented Nov 5, 2015

That probably needs to be re-written anyway. I say pick whichever you think is more correct and we can revisit it again later.

@emersont1

This comment has been minimized.

Show comment
Hide comment
@emersont1

emersont1 Nov 5, 2015

Okay. Just going to commit in a bit

Sent by Outlook for Android

On Thu, Nov 5, 2015 at 1:22 AM -0800, "Tom Spilman" notifications@github.com wrote:
That probably needs to be re-written anyway. I say pick whichever you think is more correct and we can revisit it again later.


Reply to this email directly or view it on GitHub:
#4080 (comment)

Okay. Just going to commit in a bit

Sent by Outlook for Android

On Thu, Nov 5, 2015 at 1:22 AM -0800, "Tom Spilman" notifications@github.com wrote:
That probably needs to be re-written anyway. I say pick whichever you think is more correct and we can revisit it again later.


Reply to this email directly or view it on GitHub:
#4080 (comment)

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Jan 6, 2016

Contributor

I will try to help out.

Contributor

ralfjansson commented Jan 6, 2016

I will try to help out.

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Jan 23, 2016

Contributor

I have perused the old wiki and compared it with the new documentation:

  1. The tutorial pages may be usefull to salvage for the "Platform-Specifics Notes" pages of
    the new documentation. So do too the pages on "PCL project support", "Performance tips",
    "Properly supporting android ARM devices", "Android manifest requirements" and "Migrating to OpenTK 1.0".
  2. I find the page on "Released games" interesting, so how about including that?

The Wiki gages on Git, Coding guidelines, content pipeline, contributing, effects and shaders is perhaps of less interest to include in the new documentation.

I would be happy to make an effort rewriting 1 and 2 as soon as I am able.

Contributor

ralfjansson commented Jan 23, 2016

I have perused the old wiki and compared it with the new documentation:

  1. The tutorial pages may be usefull to salvage for the "Platform-Specifics Notes" pages of
    the new documentation. So do too the pages on "PCL project support", "Performance tips",
    "Properly supporting android ARM devices", "Android manifest requirements" and "Migrating to OpenTK 1.0".
  2. I find the page on "Released games" interesting, so how about including that?

The Wiki gages on Git, Coding guidelines, content pipeline, contributing, effects and shaders is perhaps of less interest to include in the new documentation.

I would be happy to make an effort rewriting 1 and 2 as soon as I am able.

@tomspilman

This comment has been minimized.

Show comment
Hide comment
@tomspilman

tomspilman Jan 25, 2016

Member

First thanks for any help you can give in docs.

1.The tutorial pages may be usefull to salvage for

We just have to be certain that info is still accurate. If you can at least get the PR submitted with them others can come in and read to be sure nothing is missed.

2.I find the page on "Released games" interesting, so how about including that?

I think we should leave marketing for the main website and not the docs. We already represent some of the biggest and most well known titles on the home page. A lot of those links in the wiki are dead anyway or to old titles released over 5 years ago now.

Member

tomspilman commented Jan 25, 2016

First thanks for any help you can give in docs.

1.The tutorial pages may be usefull to salvage for

We just have to be certain that info is still accurate. If you can at least get the PR submitted with them others can come in and read to be sure nothing is missed.

2.I find the page on "Released games" interesting, so how about including that?

I think we should leave marketing for the main website and not the docs. We already represent some of the biggest and most well known titles on the home page. A lot of those links in the wiki are dead anyway or to old titles released over 5 years ago now.

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Jan 25, 2016

Contributor

Ok. I will take a look at task 1. above.
Sorry for asking, but just to be sure. With "PR" you mean Pre-Requisites that can be found here and there in the old wiki?

Contributor

ralfjansson commented Jan 25, 2016

Ok. I will take a look at task 1. above.
Sorry for asking, but just to be sure. With "PR" you mean Pre-Requisites that can be found here and there in the old wiki?

@cra0zy

This comment has been minimized.

Show comment
Hide comment
@cra0zy

cra0zy Jan 25, 2016

Member

PR means "pull request".

Member

cra0zy commented Jan 25, 2016

PR means "pull request".

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Jan 26, 2016

Contributor

Thank you!

Contributor

ralfjansson commented Jan 26, 2016

Thank you!

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Feb 6, 2016

Contributor

I have made my first PR.
tried copy text from wiki info documents. #4507
Please let me know if I got it right.

Contributor

ralfjansson commented Feb 6, 2016

I have made my first PR.
tried copy text from wiki info documents. #4507
Please let me know if I got it right.

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Feb 15, 2016

Contributor

New PR made. More android information #4541.

Contributor

ralfjansson commented Feb 15, 2016

New PR made. More android information #4541.

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Feb 29, 2016

Contributor

I am using the GitHub Desktop tool.

Is it possible to perhaps speed up the process by branching several work branches from the development branch? And then try make a PR each one of them?

Contributor

ralfjansson commented Feb 29, 2016

I am using the GitHub Desktop tool.

Is it possible to perhaps speed up the process by branching several work branches from the development branch? And then try make a PR each one of them?

@cra0zy

This comment has been minimized.

Show comment
Hide comment
@cra0zy

cra0zy Feb 29, 2016

Member

@ralfjansson I highly recommend you listen to the following 2 tutorials:

Member

cra0zy commented Feb 29, 2016

@ralfjansson I highly recommend you listen to the following 2 tutorials:

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Feb 29, 2016

Contributor

Thank you! I will.
And now I have :)

Contributor

ralfjansson commented Feb 29, 2016

Thank you! I will.
And now I have :)

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Mar 6, 2016

Contributor

What do we want to do with the coding guide lines?
https://github.com/mono/MonoGame/wiki/Coding-Guidelines

Contributor

ralfjansson commented Mar 6, 2016

What do we want to do with the coding guide lines?
https://github.com/mono/MonoGame/wiki/Coding-Guidelines

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Mar 6, 2016

Contributor

I added a reference to the new doc here
https://github.com/mono/MonoGame/wiki/Content-Build-Pipeline
And removed the text of that page. It looked obsolete and contained some plans for developement. I hop that was okey.

Contributor

ralfjansson commented Mar 6, 2016

I added a reference to the new doc here
https://github.com/mono/MonoGame/wiki/Content-Build-Pipeline
And removed the text of that page. It looked obsolete and contained some plans for developement. I hop that was okey.

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Mar 6, 2016

Contributor

I added a reference to the new docs for this page too:
https://github.com/mono/MonoGame/wiki/Contributing-to-MonoGame
I don't Think I am quilified to change or copy this text yet, so I have left it as it is.

Contributor

ralfjansson commented Mar 6, 2016

I added a reference to the new docs for this page too:
https://github.com/mono/MonoGame/wiki/Contributing-to-MonoGame
I don't Think I am quilified to change or copy this text yet, so I have left it as it is.

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Mar 6, 2016

Contributor

The same goes for this page:
https://github.com/mono/MonoGame/wiki/Contribution-Guidelines

Should there be page for contributing in the new docs? Could not find such page...

Contributor

ralfjansson commented Mar 6, 2016

The same goes for this page:
https://github.com/mono/MonoGame/wiki/Contribution-Guidelines

Should there be page for contributing in the new docs? Could not find such page...

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Mar 6, 2016

Contributor

New PR made. #4607. Copied the FAQ text from the wiki to the new docs.
4 build problems. What did I do wrong?

Contributor

ralfjansson commented Mar 6, 2016

New PR made. #4607. Copied the FAQ text from the wiki to the new docs.
4 build problems. What did I do wrong?

@tomspilman

This comment has been minimized.

Show comment
Hide comment
@tomspilman

tomspilman Mar 6, 2016

Member

What do we want to do with the coding guide lines?
https://github.com/mono/MonoGame/wiki/Coding-Guidelines

@KonajuGames - Can you review that and make sure it all still applies?

If so we should move them into like a CODEGUIDE.md in the root of the repo like the CONTRIBUTING.md or README.md. I just want to wait before we add content for contributors into the docs.

Member

tomspilman commented Mar 6, 2016

What do we want to do with the coding guide lines?
https://github.com/mono/MonoGame/wiki/Coding-Guidelines

@KonajuGames - Can you review that and make sure it all still applies?

If so we should move them into like a CODEGUIDE.md in the root of the repo like the CONTRIBUTING.md or README.md. I just want to wait before we add content for contributors into the docs.

@tomspilman

This comment has been minimized.

Show comment
Hide comment
@tomspilman

tomspilman Mar 6, 2016

Member

And removed the text of that page. It looked obsolete and contained some plans for developement. I hop that was okey.

Yeah... that seems fine.

https://github.com/mono/MonoGame/wiki/Contributing-to-MonoGame
https://github.com/mono/MonoGame/wiki/Contribution-Guidelines

Those have been replaced by...

https://github.com/mono/MonoGame/blob/develop/CONTRIBUTING.md

... you can clear them out and point them there. Same as with the coding guidelines lets not link that into the documentation just yet.

Member

tomspilman commented Mar 6, 2016

And removed the text of that page. It looked obsolete and contained some plans for developement. I hop that was okey.

Yeah... that seems fine.

https://github.com/mono/MonoGame/wiki/Contributing-to-MonoGame
https://github.com/mono/MonoGame/wiki/Contribution-Guidelines

Those have been replaced by...

https://github.com/mono/MonoGame/blob/develop/CONTRIBUTING.md

... you can clear them out and point them there. Same as with the coding guidelines lets not link that into the documentation just yet.

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Apr 2, 2016

Contributor

New PR made #4707. "Getting Effect .fx files to compile and run Hints, Tips and Gotchas ".
Cleared up the text a bit in case you want to reuse it.
Cleared the orignal wiki page and added reference to the new doc.

Contributor

ralfjansson commented Apr 2, 2016

New PR made #4707. "Getting Effect .fx files to compile and run Hints, Tips and Gotchas ".
Cleared up the text a bit in case you want to reuse it.
Cleared the orignal wiki page and added reference to the new doc.

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Apr 24, 2016

Contributor

I noticed that some texts 'jump' in level for headers like in

'* Level 1 header
*** Level 2 header'

Instead of

'* Level1 header
** Level 2 header'

Was this intentional by the author? Or should change these?

Contributor

ralfjansson commented Apr 24, 2016

I noticed that some texts 'jump' in level for headers like in

'* Level 1 header
*** Level 2 header'

Instead of

'* Level1 header
** Level 2 header'

Was this intentional by the author? Or should change these?

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson May 7, 2016

Contributor

So with regard to #4707, is it still okey for me to continue suggesting PRs for the rest of the old wiki docs, or should we try a different strategy?

Contributor

ralfjansson commented May 7, 2016

So with regard to #4707, is it still okey for me to continue suggesting PRs for the rest of the old wiki docs, or should we try a different strategy?

@tomspilman

This comment has been minimized.

Show comment
Hide comment
@tomspilman

tomspilman Sep 3, 2016

Member

FYI. Because of confusion we've disabled the old wiki entirely.

You should be able to access the old docs from the wiki repo history:

https://github.com/MonoGame/MonoGame.wiki.git

Member

tomspilman commented Sep 3, 2016

FYI. Because of confusion we've disabled the old wiki entirely.

You should be able to access the old docs from the wiki repo history:

https://github.com/MonoGame/MonoGame.wiki.git

@ralfjansson

This comment has been minimized.

Show comment
Hide comment
@ralfjansson

ralfjansson Sep 4, 2016

Contributor

Ok. Tanks :)

On 2016-09-03 20:43, Tom Spilman wrote:

FYI. Because of confusion we've disabled the old wiki entirely.

You should be able to access the old docs from the wiki repo history:

https://github.com/MonoGame/MonoGame.wiki.git


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#4080 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/ALTnvwEVmic3qYHIxUavX8vDWjM9xS4bks5qmb_CgaJpZM4FsUPM.

Contributor

ralfjansson commented Sep 4, 2016

Ok. Tanks :)

On 2016-09-03 20:43, Tom Spilman wrote:

FYI. Because of confusion we've disabled the old wiki entirely.

You should be able to access the old docs from the wiki repo history:

https://github.com/MonoGame/MonoGame.wiki.git


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#4080 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/ALTnvwEVmic3qYHIxUavX8vDWjM9xS4bks5qmb_CgaJpZM4FsUPM.

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