Unity icon indicating copy to clipboard operation
Unity copied to clipboard

Update documentation and user guides

Open shana opened this issue 6 years ago • 5 comments

This is a starting list of the user guides that we should probably have at a minimum. Some of them have already started to be fleshed out, others need starting. This isn't exhaustive, if you see something missing, feel free to add it to the list.

The user guides are currently in the https://github.com/github-for-unity/Unity/tree/master/docs/using folder. If you want to work on a doc, just add a comment with what you're grabbing. For guidelines on how docs should generally look like, see the GHfVS at https://github.com/github/VisualStudio/tree/master/docs

  • [ ] Getting Started
    • [ ] Setup GitHub for Unity
      • [ ] On an existing project
      • [x] On a new project
    • [x] Install & Updating GitHub for Unity
    • [ ] Uninstalling GitHub for Unity
    • [ ] Git configuration
    • [ ] Repository configuration
    • [ ] Git installation
    • [x] Authentication
      • Login in GitHub for Unity
      • Personal access tokens
      • Working with other git providers
  • [ ] Working with GitHub for Unity
    • [x] Commit your changes
    • [x] Pushing your work
    • [x] Reverting changes
    • [x] Pulling other people's changes
    • [ ] Exclusive locks on files for editing
      • Requesting locks
      • Releasing locks
      • Seeing existing locks
    • [x] Managing branches
      • Create
      • Checkout
      • Delete

shana avatar Jun 11 '18 17:06 shana

Definitely +1 to a guide on how to lock files, I haven't seen it anywhere else.

GriffinBrodman avatar Jun 28 '18 14:06 GriffinBrodman

I went through the body of the issue, I checked off what was complete and removed our names. Anyone that wants to should feel free to submit a document for what remains.

StanleyGoldman avatar Jun 28 '18 14:06 StanleyGoldman

If anyone can add Uninstalling Github for Unity that would be truly stellar. 🙏

stanishev avatar Feb 07 '19 17:02 stanishev

Hi, I'm trying to use this project but running into difficulties connecting two machines/accounts to the same project. This section of the docs is missing - if someone has some instructions I'd be happy to write them up nicely for the docs.

Currently I've ended up in a mess with the two machines on completely different version histories, refusing to pull or push.

makkasu avatar Mar 31 '20 21:03 makkasu

I can take the git configuration and installation. What exactly is needed from the git configuration?

Ragueel avatar Oct 01 '20 05:10 Ragueel