]> granicus.if.org Git - pdns/commitdiff
Fix some wording, some style and a typo
authorPieter Lexis <pieter@plexis.eu>
Mon, 1 Dec 2014 18:00:21 +0000 (19:00 +0100)
committerPieter Lexis <pieter@plexis.eu>
Mon, 1 Dec 2014 18:00:21 +0000 (19:00 +0100)
pdns/docs/markdown/appendix/documentation.md
pdns/docs/mkdocs.yml

index 14668f886f20d4fff4e6ab7e3b4a711e92501671..beb13cb80e4cc2676244f2a4b77c128cc3dfc002 100644 (file)
@@ -3,18 +3,17 @@ The PowerDNS documentation started life as SGML DocBook, and was later converted
 Pieter Lexis contributed a Markdown conversion, which is the basis of the current documentation.
 
 If you note an issue with the new documentation, please open a ticket on
-https://github.com/powerdns/pdns/issues and tell us about it. Or, even
-better, fork our repo, and edit the files in
-https://github.com/PowerDNS/pdns/tree/master/pdns/docs/markdown to improve
-things.
+[GitHub](https://github.com/powerdns/pdns/issues) and tell us about it. Or, even
+better, fork our repo, and edit the files in pdns/tree/master/pdns/docs/markdown
+to improve things.
 
 If your change is simple (say, a typo or a new paragraph), you can do all this 
 entirely from GitHub. Simply fork PowerDNS, find the Markdown file you want to change, 
-edit in place, commit, and create a fork request. 
+edit in place, commit, and create a pull request.
 
-To test-build the documentation, run ''pip install mkdocs'', ''pip install
-pandoc'' and ''pip install pandocfilters'', followed by ''make
-html-new/index.html'' in the pdns/docs directory.
+To test-build the documentation, run `pip install mkdocs`, `pip install pandoc`
+nd `pip install pandocfilters`, followed by `make html-new/index.html` in the
+pdns/docs directory.
 
 To test your changes live, use ''mkdocs serve --dev-addr=0.0.0.0:8000'', and the new version
 of your documentation will appear on port 8000 of your machine.
index 2d6f69825aa763f6a4150432e65f9f7ebc063643..64494716f6d59b06513e9940262b9378dbf316db 100644 (file)
@@ -61,6 +61,6 @@ pages:
   - [security/powerdns-advisory-2006-02.md, 'Security', 'Advisory 2006-02']
   - [security/powerdns-advisory-2006-01.md, 'Security', 'Advisory 2006-01']
   - [appendix/backend-writers-guide.md, 'Tools and Appendices', "Backend Writer's Guide"]
-  - [appendix/documentation.md, 'Tools and Appendices', "Documentation detauls"]
+  - [appendix/documentation.md, 'Tools and Appendices', "Documentation details"]
   - [appendix/compiling-powerdns.md, 'Tools and Appendices', 'Compiling PowerDNS']
   - [tools/analysis.md, 'Tools and Appendices', 'DNS Analysis Tools']