From 788b162842f56dafeab534e149428d4c584d8b7a Mon Sep 17 00:00:00 2001 From: Björn Persson Date: Nov 24 2018 13:28:26 +0000 Subject: [PATCH 1/2] Expanded the authoring instructions. The guidelines authoring instructions have been amended to: · Recommend Asciidoctor as a lightweight way of previewing one's changes. · Point out that there is a command-line program in rubygem-asciidoctor. · Explain how the purpose of the container-based method differs from the purpose of the Asciidoctor method. · Mention that the makefile will download container blobs. --- diff --git a/README.md b/README.md index f77c719..0fa5feb 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,31 @@ You can view the actual packaging guidelines ## Packaging Guideline Development -### Building and viewing the guidelines locally +### Checking the Effect of Your Changes + +To quickly check whether the changes you have made to a .adoc file +cause the desired changes to the HTML code, +use Asciidoctor. +It is in the package rubygem-asciidoctor, +and is, despite the package name, usable from a command prompt: + +``` +$ asciidoctor path/to/file.adoc +``` + +This will generate an HTML file corresponding to the input file. +The style will differ +but the HTML code as such is supposed to match what will end up on the website, +allowing you to see whether the Asciidoc code works as you intended. + +### Building the Whole Set of Guidelines + +For building the whole set of guidelines locally +and viewing them in the same style as on the website, +there is a container-based build procedure. +This will download and execute container blobs containing Antora, +and produce a complete set of HTML documents and stylesheets, +which can then be browsed through a temporary HTTP server. Prerequisites: From f1b1d86f206630219b4e01e34621f79ce93c1317 Mon Sep 17 00:00:00 2001 From: Björn Persson Date: Nov 24 2018 13:32:30 +0000 Subject: [PATCH 2/2] grammar and spelling --- diff --git a/README.md b/README.md index 0fa5feb..e5cb03a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Fedora Packaging Committee -Welcome! This is the pagure instance for the Fedora Packaging Committee. +Welcome! This is the Pagure instance for the Fedora Packaging Committee. -The pagure repository is used to store source of Packaging Guidelines, +The Pagure repository is used to store the source of Packaging Guidelines, track related issues and accept changes via pull requests. @@ -47,7 +47,7 @@ Prerequisites: * `podman` * `python3` -Run following commands and open http://localhost:8000/ +Run the following commands and open http://localhost:8000/ ``` $ make @@ -57,7 +57,7 @@ $ make serve ### Writing [Antora](https://antora.org/) is used for -managing the various documents which comprise the guideliens +managing the various documents which comprise the guidelines and integrating them into the rest of Fedora Documentation. The guidelines themselves are written in