PR#16: Typo fixes and tab→spaces - fedora-docs/template

fedora-docs / template

#16 Typo fixes and tab→spaces

Merged 3 years ago by jflory7. Opened 3 years ago by rffontenelle.

fedora-docs/ rffontenelle/template some-fixes into master

build.sh: fix misspelling and replace tab with spaces

Rafael Fontenelle • 3 years ago

e15dfd2

Fix misspellings

Rafael Fontenelle • 3 years ago

5e6c150

README.md

file modified

+2 -2

		`@@ -38,14 +38,14 @@`

		`Antora introduces two new terms:`

		`- * Component — Simply put, a component is a part of the documentation website with its own menu. Components can also be versioned. In the Fedora Docs, we use separate components for user documentation, the Fedora Poject, Fedora council, Mindshare, FESCO, but also subprojects such as CommOps or Modulartity.`
		`+ * Component — Simply put, a component is a part of the documentation website with its own menu. Components can also be versioned. In the Fedora Docs, we use separate components for user documentation, the Fedora Project, Fedora council, Mindshare, FESCO, but also subprojects such as CommOps or Modulartity.`
		`* Module — A component can be broken down into multiple modules. Modules still share a single menu on the site, but their sources can be stored in different git repositories, even owned by different groups. The default module is called "ROOT" (that's what is in this example). If you don't want to use multiple modules, only use "ROOT". But to define more modules, simply duplicate the "ROOT" directory and name it anything you want. You can store modules in one or more git repositories.`

		`## Local preview`

		`This repo includes scripts to build and preview the contents of this repository.`

		`- NOTE: Please note that if you reference pages from other repositoreis, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions.`
		`+ NOTE: Please note that if you reference pages from other repositories, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions.`

		`Both scripts work on Fedora (using Podman) and macOS (using Docker).`

antora.yml

file modified

+1 -1

		`@@ -1,4 +1,4 @@`
		`- # Name will be mostly visible in the URL. Treat it as an indentifier.`
		`+ # Name will be mostly visible in the URL. Treat it as an identifier.`
		`# Tip: If you want to use the local preview scripts that come with this repository, please change this value in the site.yml file as well. (under site/start_page)`
		`name: pizza-factory # <---- PLEASE MODIFY`

build.sh

file modified

+8 -8

		`@@ -14,14 +14,14 @@`

		`elif [ "$(expr substr "$(uname -s)" 1 5)" = "Linux" ]; then`
		`# Running on Linux.`
		`- # Check whether podman is available, else faill back to docker`
		`+ # Check whether podman is available, else fall back to docker`
		`# which requires root.`

		`if [ -f /usr/bin/podman ]; then`
		`echo ""`
		`echo "This build script is using Podman to run the build in an isolated environment."`
		`echo ""`
		`- podman run --rm -it -v "$(pwd):/antora:z" $image $cmd`
		`+ podman run --rm -it -v "$(pwd):/antora:z" $image $cmd`

		`elif [ -f /usr/bin/docker ]; then`
		`echo ""`
		`@@ -29,18 +29,18 @@`
		`echo ""`

		`if groups \| grep -wq "docker"; then`
		`- docker run --rm -it -v "$(pwd):/antora:z" $image $cmd`
		`- else`
		`+ docker run --rm -it -v "$(pwd):/antora:z" $image $cmd`
		`+ else`
		`echo ""`
		`echo "This build script is using $runtime to run the build in an isolated environment. You might be asked for your password."`
		`echo "You can avoid this by adding your user to the 'docker' group, but be aware of the security implications. See https://docs.docker.com/install/linux/linux-postinstall/."`
		`echo ""`
		`sudo docker run --rm -it -v "$(pwd):/antora:z" $image $cmd`
		`- fi`
		`+ fi`
		`else`
		`echo ""`
		`- echo "Error: Container runtime haven't been found on your system. Fix it by:"`
		`- echo "$ sudo dnf install podman"`
		`- exit 1`
		`+ echo "Error: Container runtime haven't been found on your system. Fix it by:"`
		`+ echo "$ sudo dnf install podman"`
		`+ exit 1`
		`fi`
		`fi`

modules/ROOT/pages/faq.adoc

file modified

+1 -1

		`@@ -4,4 +4,4 @@`
		`Can I see a built preview of this template to get a better idea about the result?::`
		`Of course you can! Just look at the README of the repository — it should tell you everything.`
		`Is writing documentation hard and dreadful?::`
		`- Absolutely not. Writing documentation in asciidoc is very simple and straighforward. And in fact, writing documentation makes you very happy. Just try and see for yourself!`
		`+ Absolutely not. Writing documentation in asciidoc is very simple and straightforward. And in fact, writing documentation makes you very happy. Just try and see for yourself!`