diff options
author | K900 <me@0upti.me> | 2023-11-11 18:08:59 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-11-11 18:08:59 +0300 |
commit | e792d7fec0cc387cc5da0cb077115280514f8326 (patch) | |
tree | 5818bedc97da579fb6f7d0e3dbef70038bf1246f /nixos/doc/manual/development | |
parent | 28ce810d966e980405b7c836170e0717637b2be3 (diff) | |
parent | e30f48be948272df2d57237ef955023f937f4421 (diff) |
Merge pull request #264442 from anthonyroussel/update-url-redirects
treewide: fix redirected and broken URLs
Diffstat (limited to 'nixos/doc/manual/development')
-rw-r--r-- | nixos/doc/manual/development/writing-documentation.chapter.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/nixos/doc/manual/development/writing-documentation.chapter.md b/nixos/doc/manual/development/writing-documentation.chapter.md index c07a2618c07e1..3d9bd318cf339 100644 --- a/nixos/doc/manual/development/writing-documentation.chapter.md +++ b/nixos/doc/manual/development/writing-documentation.chapter.md @@ -33,13 +33,13 @@ symlink at `./result/share/doc/nixos/index.html`. ## Editing DocBook XML {#sec-writing-docs-editing-docbook-xml} For general information on how to write in DocBook, see [DocBook 5: The -Definitive Guide](http://www.docbook.org/tdg5/en/html/docbook.html). +Definitive Guide](https://tdg.docbook.org/tdg/5.1/). Emacs nXML Mode is very helpful for editing DocBook XML because it validates the document as you write, and precisely locates errors. To use it, see [](#sec-emacs-docbook-xml). -[Pandoc](http://pandoc.org) can generate DocBook XML from a multitude of +[Pandoc](https://pandoc.org/) can generate DocBook XML from a multitude of formats, which makes a good starting point. Here is an example of Pandoc invocation to convert GitHub-Flavoured MarkDown to DocBook 5 XML: @@ -62,9 +62,9 @@ topic from scratch. Keep the following guidelines in mind when you create and add a topic: -- The NixOS [`book`](http://www.docbook.org/tdg5/en/html/book.html) +- The NixOS [`book`](https://tdg.docbook.org/tdg/5.0/book.html) element is in `nixos/doc/manual/manual.xml`. It includes several - [`parts`](http://www.docbook.org/tdg5/en/html/book.html) which are in + [`parts`](https://tdg.docbook.org/tdg/5.0/book.html) which are in subdirectories. - Store the topic file in the same directory as the `part` to which it |