Skip to content

Commit 2f7101f

Browse files
committed
Update documentation for contributing, troubleshooting, and usage.
1 parent d08bd85 commit 2f7101f

File tree

3 files changed

+142
-330
lines changed

3 files changed

+142
-330
lines changed

docs/content/en/docs/Contributing/_index.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,32 @@ instructions provided by the bot. You will only need to do this once across all
1717

1818
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
1919
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
20-
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
20+
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
21+
22+
## Contributing to Documentation
23+
24+
Below are the steps and required packages to get the Azure Quick Review Hugo site to build and run locally.
25+
26+
* Ensure that you have the following packages installed locally.
27+
28+
- git
29+
- hugo extended
30+
- nodejs
31+
32+
* Fork the azqr repository, clone locally and then head to the docs folder
33+
34+
``` powershell
35+
cd .\azqr\docs
36+
```
37+
38+
* Execute the Node Module installer
39+
40+
``` console
41+
npm install
42+
```
43+
44+
* Once this has finish you can execute the Hugo Server
45+
46+
``` console
47+
hugo server
48+
```

docs/content/en/docs/Troubleshooting/_index.md

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -16,31 +16,4 @@ Please search the existing issues before filing new issues to avoid duplicates.
1616
- For new issues, file your bug or feature request as a new [issue](https://github.com/Azure/azqr/issues).
1717
- For help, discussion, and support questions about using this project, join or start a [discussion](https://github.com/Azure/azqr/discussions).
1818

19-
Support for this project / product is limited to the resources listed above.
20-
21-
## Contributing to Documentation
22-
23-
Below are the steps and required packages to get the Azure Quick Review Hugo site to build locally.
24-
First please ensure that you have the following packages installed locally.
25-
26-
- Git.Git
27-
- Hugo.Hugo.Extended
28-
- OpenJS.NodeJS
29-
30-
Please fork the azqr repository, clone locally and then head to the docs folder
31-
32-
``` powershell
33-
Set-Location .\azqr\docs
34-
```
35-
36-
Execute the Node Module installer
37-
38-
``` console
39-
npm install
40-
```
41-
42-
Once this has finish you can execute the Hugo Server
43-
44-
``` console
45-
hugo server
46-
```
19+
Support for this project / product is limited to the resources listed above.

0 commit comments

Comments
 (0)