You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

01-Getting-Started.md 2.7 KiB

5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. # Contributing to PowerShell Documentation
  2. Thank you for your interest in NTFSAccess documentation!
  3. See below for details on how you can contribute to our technical documentation.
  4. > For general information about getting started with Git and GitHub, see [GitHub Help][git-help].
  5. ## Providing feedback on NTFSAccess documentation
  6. Report errors, suggest changes, or request new topics by [creating an issue][new-issue] on the
  7. [NTFSAccess repository issues page][doc-issues].
  8. ## Making minor edits to existing topics
  9. To [edit an existing file][edit-file], navigate to it and click the "Edit" button. GitHub will
  10. automatically create your own fork of our repository where you can make your changes. Once you are
  11. finished, save your edits and submit a [pull request][pull] to the *staging* branch of the
  12. [NTFSAccess-Docs][docs-repo] repository. After your pull request is created, someone on the
  13. NTFSAccess documentation team reviews your changes before merging them into the *staging* branch.
  14. ## Making major edits to existing topics
  15. If you are making significant changes, adding or changing images, or contributing a new article, you
  16. need to create a GitHub fork and clone it to your computer. A fork is a GitHub-based replica of the
  17. main repository, under your GitHub account, that provides you with a working copy which you can use
  18. in isolation. You create pull requests from your fork. Similarly, a clone is a local-based replica
  19. of the repository which, in this case, is a clone of your fork. The clone allows you to work on Git
  20. repositories offline, and using more powerful native software/tools.
  21. Here is the workflow for making major edits to existing documentation:
  22. 1. [Create a fork][fork] of the [NTFSAccess][docs-repo] repository.
  23. 2. [Create a clone of your fork][clone] on your local computer.
  24. 3. Create a new local branch in your cloned repository.
  25. 4. Make changes to the file(s) you want to update in a Markdown editor.
  26. 5. [Push your local branch][push] to your fork.
  27. 6. [Create a pull request][pull] to the *staging* branch of the [NTFSAccess-Docs][docs-repo]
  28. repository.
  29. ## Next steps
  30. See [Writing documentation](02-Writing.md).
  31. <!-- External URLs -->
  32. [git-help]: https://help.github.com/
  33. [new-issue]: https://help.github.com/articles/creating-an-issue/
  34. [doc-issues]: https://github.com/raandree/NTFSSecurity/issues
  35. [edit-file]: https://help.github.com/articles/editing-files-in-another-user-s-repository/
  36. [docs-repo]: https://github.com/raandree/NTFSSecurity/
  37. [fork]: https://help.github.com/articles/fork-a-repo/
  38. [clone]: https://help.github.com/articles/cloning-a-repository/
  39. [push]: https://help.github.com/articles/pushing-to-a-remote/
  40. [pull]: https://help.github.com/articles/creating-a-pull-request/