This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
Welcome to the repository for documentation and guides for Microsoft Dynamics GP! The content is available as markdown files (.md), where each file represents an article in the help that publishes to https://docs.microsoft.com/en-us/dynamics-gp/. This repo also provides a way for you to actively contribute to the Dynamics GP content, and we welcome your contributions.
The live branch has been updated for the release of Dynamics GP 2018 R2. Content still in process of being updated for that release is currently in the master-installation branch.
If you have any questions, please contact the Dynamics SMB User Assistance (UA) team at [email protected].
-
Fork this repo
You cannot work directly in the msftdynamicsgpdocs repo, so the first thing you need to do is create a fork of the repo under your GitHub account. A fork basically is copy of this repo that lets you work freely on the content without affecting the msftdynamicsgpdocs repo. For more information, see Fork a Repo.
-
Install GitHub Desktop (optional) and clone your forked repo.
GitHub Desktop makes is easy to work and collaborate with repos locally from your own desktop. For more information, see GitHub Desktop.
-
Get hold of your favorite MarkDown editor, and start making changes.
The help content is stored in the dynamics-gp folder of the repo. Articles use a syntax for formatting text called GitHub Flavored Markdown. To learn more about working with markdown, see Getting started with writing and formatting on GitHub.
-
Optionally, build the HTML files for your website.
One way you can build the HTML files is by using DocFX, which is an open source tool for converting markdown files. This section provides some guidance on how you can use DocFX to publish HTML files.
-
Install DocFX on your computer.
For more information, see DocFx.
-
Specify the output folder in which to store the generated HTML files.
By default the files will be saved in the folder c:/output. The output folder is set in the docfx.json file. If you want to change this folder, do the following:
a. In the folder *[clone path]\msftdynamicsgpdocs\dynamics-gp*, open the docfx.json file in your editor.
b. Set the "dest:" parameter to your output folder, and save the changes. -
Go to your desktop and open a command prompt.
-
Go to the docfx installation folder.
-
Run the following command:
docfx "[clone path]\msftdynamicsgpdocs\dynamics-gp\docfx.json"'
The files are generated as .html files and stored in the specified output.
A benefit of GitHub is the ability for you to contribute to the core content that the Microsoft team provides in the msftdynamicsgpdocs repo. For example, you might have a new article that you think would be beneficial or you might have a correction to an existing article. If you would like to contribute to the msftdynamicsgpdocs repo, you create what is called a pull request from your repo to the msftdynamicsgpdocs repo. The Dynamics SMB UA team will then review the request and include the changes as appropriate.
For example, to create a pull request to the msftdynamicsgpdocs repo by using GitHub Desktop, do the following:
- Commit the changes to your repo that you want to include in the pull request.
- Choose Sync to push the changes up to your repo on GitHub.
- When the sync is completed, choose Pull Request, and then choose send Pull Request.
Get tips, tools, and guidance in the Microsoft Docs Contributor Guide.