#20 Fix misspellings
Merged 3 years ago by jflory7. Opened 3 years ago by rffontenelle.
fedora-docs/ rffontenelle/documentation-contributors-guide fix-typos  into  master

file modified
+2 -2
@@ -43,14 +43,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 use docker, so please make sure you have it installed on your system. Please see below for instructions.

  

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: fedora-docs

  

file modified
+1 -1
@@ -14,7 +14,7 @@ 

  

  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 fail back to docker

      # which requires root.

  

      if [ -f /usr/bin/podman ]; then

@@ -1,6 +1,6 @@ 

  = Adding new documentation to the site

  

- This section describes how to add new documentation to the website and ensure it is published and listed somewhere. Before you start following this procedure, make sure that you fulfill all the requirements lited in xref:prerequisites.adoc[Prerequisites].

+ This section describes how to add new documentation to the website and ensure it is published and listed somewhere. Before you start following this procedure, make sure that you fulfill all the requirements listed in xref:prerequisites.adoc[Prerequisites].

  

  [IMPORTANT]

  ====
@@ -17,7 +17,7 @@ 

  

  . In the new repository, edit the [filename]`antora.yml` configuration file in the repository root. The file contains comments that point out which parts you need to change. At a minimum, always change the `name` and `title`.

  

- . Additionally, edit the [filename]`site.yml` configuration file. Note that this file is only used when building a local preview of your content set - on the website it is overriden by the sitewide `site.yml` configuration. The only directives you need to edit in this file is the `title` and `start_page`.

+ . Additionally, edit the [filename]`site.yml` configuration file. Note that this file is only used when building a local preview of your content set - on the website it is overridden by the site-wide `site.yml` configuration. The only directives you need to edit in this file is the `title` and `start_page`.

  

  . At this point, when the initial configuration is finished and the repository is configured with the correct name and other required directives, push these changes to the newly created repository (or make a pull request if you can not push directly). This set of changes will be required for any other contributions, so make sure they are in as early as possible.

  

@@ -24,7 +24,7 @@ 

  antora generate site.yml

  ----

  

- This will create a new directory ``public`` which contains all the nessesary files. Navigate there and run a server command. You might allready have a Python simple server, in which case run:

+ This will create a new directory ``public`` which contains all the necessary files. Navigate there and run a server command. You might already have a Python simple server, in which case run:

  

  [source]

  ----

no initial comment

Metadata Update from @jflory7:
- Pull-request tagged with: type - existing docs
- Request assigned

3 years ago

Thanks @rffontenelle, this looks good. A lot of the changes you made here could also be made to the template repo, since this is what we tell people to copy-paste when starting a new docs project:

https://pagure.io/fedora-docs/template

Merging this! :clapper:

Pull-Request has been merged by jflory7

3 years ago