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.

02-Writing.md 2.6 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
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. # WRITING DOCUMENTATION
  2. One of the easiest ways to contribute to the NTFSAccess PowerShell module is by helping to write and edit documentation.
  3. All the documentation hosted on GitHub is written using *Markdown*. Markdown is a lightweight markup
  4. language with plain text formatting syntax. Markdown forms the basis of our documentation's
  5. conceptual authoring language. Creating new articles is as easy as writing a simple text file by
  6. using your favorite text editor.
  7. ## Markdown editors
  8. Here are some Markdown editors you can try out:
  9. - [Visual Studio Code](https://code.visualstudio.com)
  10. - [Atom](https://atom.io/)
  11. - [Sublime Text](http://www.sublimetext.com/)
  12. ## Get started using Markdown
  13. To get started using Markdown, see [How to use Markdown for writing Docs](https://docs.microsoft.com/contribute/how-to-write-use-markdown).
  14. NTFSSecurity uses the [Mkdocs][mkdocs] builder on ReadTheDocs for documentation.
  15. Don't use hard tabs in Markdown. For more detailed information about the Markdown specification, see the
  16. [Markdown Specifics](04-Markdown-Specifics.md) article.
  17. ## Creating new topics
  18. To contribute new documentation, check for issues tagged as ["Help Wanted"][labels] to make sure
  19. you're not duplicating efforts. If no one seems to be working on what you have planned:
  20. - Open a new issue and label it as "in progress". If you don't have rights to assign labels, add "in
  21. progress" as a comment to tell others what you're working on.
  22. - Follow the same workflow as described above for making major edits to existing topics.
  23. - Add your new article to the `TOC.yml` file (located in the top-level folder of each
  24. documentation set).
  25. ## Updating topics that exist in multiple versions
  26. Most reference topics are duplicated across all versions of PowerShell. When reporting an issue
  27. about a cmdlet reference or an About_ article, you must specify which versions are affected by the
  28. issue. The default issue template in GitHub includes a [GFM task list][gfm-task]. Use the checkboxes
  29. in the task list to specify which versions of the content are affected. When you submit a change to
  30. a article for an issue that affects multiple versions of the content, you must apply the appropriate
  31. change to each version of the file.
  32. ## Next Steps
  33. Read the [Style Guide](03-Style-Guide.md).
  34. <!-- External URLs -->
  35. [markdig]: https://github.com/lunet-io/markdig
  36. [CommonMark]: https://spec.commonmark.org/
  37. [gfm-help]: https://help.github.com/categories/writing-on-github/
  38. [labels]: https://github.com/raandree/NTFSSecurity/labels/Help%20Wanted
  39. [mkdocs]: https://www.mkdocs.org/user-guide/writing-your-docs/