LICENSE.docs Documentation

1. Project Overview & Quickstart (containers/LICENSE.docs) Copy Chapter

LICENSE.docs

Open-source repository containers/LICENSE.docs

Repository Details Copy Section

• Repository: containers/LICENSE.docs
• Primary Language: Code

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (containers/docs) Copy Chapter

File: README.md Copy Chapter

Fedora Docs Template

This repository contains documentation around container tooling.

Structure Copy Chapter

|-- README.md
|-- antora.yml ....................... 1.
|-- build.sh ......................... 2.
|-- preview.sh ....................... 3.
|-- site.yml ......................... 4.
`-- modules
    `-- ROOT ......................... 5.
        |-- assets
        |   `-- images ............... 6.
        |       `-- *
        |-- nav.adoc ................. 7.
        `-- pages .................... 8.
            |-- *

1. Metadata definition.
2. A script that does a local build. Uses docker.
3. A script that shows a preview of the site in a web browser by running a local web server. Uses docker.
4. A definition file for the build script.
5. A "root module of this documentation component". Please read below for an explanation.
6. Images to be used on any page.
7. Menu definition. Also defines the hierarchy of all the pages.
8. Pages with the actual content. They can be also organised into subdirectories if desired.

Components and Modules Copy Chapter

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.
• 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 Copy Chapter

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

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 for instructions.

Both scripts use docker, so please make sure you have it installed on your system.

To build and preview the site, run:

$ ./build.sh && ./preview.sh

The result will be available at http://localhost:8080

File: antora.yml Copy Chapter

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: containers

Title will be visible on the page.

title: Fedora Container Docs

If you don't plan to have multiple versions of the docs (for example, to

document multiple versions of some software), you can ignore this field.

Otherwise, change "~" to a specific version.

version: ~

We encourage you to name the index page as "index.adoc". If you absolutely

have to use a different name, please reflect it here. You can ignore this

field otherwise.

start_page: ROOT:index.adoc

This lists all the menu definitions of your component.

nav:

• modules/ROOT/nav.adoc

File: CODE-OF-CONDUCT.md Copy Chapter

The Fedora Docs Template Project Community Code of Conduct Copy Chapter

The Fedora Docs Template project follows the Containers Community Code of Conduct.

File: SECURITY.md Copy Chapter

Security and Disclosure Information Policy for the Fedora Docs Template Project Copy Chapter

The Fedora Docs Template Project follows the Security and Disclosure Information Policy for the Containers Projects.

File: site.yml Copy Chapter

site:
title: Container Docs Local Preview
start_page: containers::index.adoc
content:
sources:

• url: .
  branches: HEAD
  ui:
  bundle:
  url: https://gitlab.com/fedora/docs/docs-website/ui-bundle/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
  snapshot: true
  
  default_layout: with_menu
  output:
  clean: true
  dir: ./public
  runtime:
  fetch: true
  cache_dir: ./cache
  urls:
  html_extension_style: indexify