From 58913d046a28843ea12f3fa1213b3f572d12ca01 Mon Sep 17 00:00:00 2001 From: Oğuz Ersen Date: Mar 29 2020 19:13:39 +0000 Subject: Fix typos This commit will fix errors in the following files: modules/contributing/pages/adding-new-docs.adoc modules/contributing/pages/git.adoc modules/contributing/pages/local-preview.adoc --- diff --git a/modules/contributing/pages/adding-new-docs.adoc b/modules/contributing/pages/adding-new-docs.adoc index 086af87..3a2ee47 100644 --- a/modules/contributing/pages/adding-new-docs.adoc +++ b/modules/contributing/pages/adding-new-docs.adoc @@ -23,7 +23,7 @@ Before you start creating an entirely new documentation set, consult the mailing . Fork the new repository, so you are not pushing updates directly into it. -. Start adding the actual ASCIIDoc content. While writing, make sure files your new source files are included in the [filename]`nav.adoc` configuration file of the module you are using ([filename]`./modules/ROOT/` by default, the location will change based on what you configured in [filename]`antora.yml` earlier). Also make sure to use xref:local-preview.adoc[local preview] often to check your markup. +. Start adding the actual ASCIIDoc content. While writing, make sure your new source files are included in the [filename]`nav.adoc` configuration file of the module you are using ([filename]`./modules/ROOT/` by default, the location will change based on what you configured in [filename]`antora.yml` earlier). Also make sure to use xref:local-preview.adoc[local preview] often to check your markup. . Once you finish, commit your changes and push them to your fork. diff --git a/modules/contributing/pages/git.adoc b/modules/contributing/pages/git.adoc index 11dda0e..d63a1bc 100644 --- a/modules/contributing/pages/git.adoc +++ b/modules/contributing/pages/git.adoc @@ -47,7 +47,7 @@ For example: `$HOME/fedora/docs` .. Copy the contents of the '''SSH''' box . Add your fork to the local checkout .. From a terminal, go to the directory you cloned above. (For example: `cd $HOME/fedora/docs/quick-docs`) -.. From a terminal, run `git remote add origin `. For example: `git remote add origin ssh://git@pagure.io/forks/bcotton/fedora-docs/quick-docs.git`) +.. From a terminal, run `git remote add origin `. (For example: `git remote add origin ssh://git@pagure.io/forks/bcotton/fedora-docs/quick-docs.git`) NOTE: This document uses the terminal for git commands. However, you may also choose to use a graphical git tool. diff --git a/modules/contributing/pages/local-preview.adoc b/modules/contributing/pages/local-preview.adoc index e9679e9..e4677dd 100644 --- a/modules/contributing/pages/local-preview.adoc +++ b/modules/contributing/pages/local-preview.adoc @@ -3,7 +3,7 @@ = Building a local preview Because the documentation site is using a markup language instead of a WYSIWYG editor, the sources do not look exactly like the rendered page will. Therefore it is necessary to check that your changes look the way you want them to before you push and make a merge request. This involves building a local preview. -There are two shell scripts available in each existing repository (including the template repository used to create new content): `build.sh` and docker`preview.sh`. +There are two shell scripts available in each existing repository (including the template repository used to create new content): `build.sh` and `preview.sh`. To preview, run the `build.sh` script; this is the one that actually builds a local version of the site (or, more precisely, the subset of the full site that resides in your current repository). Then, run `preview.sh`, which starts a webserver and serves the site at link:http://localhost:8080/[]. Opening this URL in any web browser will show you the preview, which will be available until you kill the process (kbd:[Ctrl+C] in the terminal).