From 4617f7fed0067db9fe9b7b9ee6a0f5d888f244d6 Mon Sep 17 00:00:00 2001 From: Adam Samalik Date: Oct 10 2018 12:37:29 +0000 Subject: import sources from docs-fp-o --- diff --git a/README.md b/README.md index f1001d2..82ad1f6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,43 @@ -# release-docs-home +# Fedora Modularity Docs -Homepage + config of the release docs, pointing to the install guide, the sysadmin guide, and the release notes \ No newline at end of file +Please report Issues and submit Pull Requests for **Content Fixes** here. +Never done a pull request (or "PR")? Here's the [Pagure documentation for +Pull Requests](https://docs.pagure.org/pagure/usage/pull_requests.html). + + +General appearance issues and publishing issues should be reported against +the [publishing software](https://pagure.io/fedora-docs/docs-fp-o). + +## How to edit these documents + +All of this is written in AsciiDoc. It's a simple mostly-plain-text +markup language. You may want to look at: + + +* [AsciiDoc Syntax Quick Reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/) +* [AsciiDoc Writer’s Guide](http://asciidoctor.org/docs/asciidoc-writers-guide/) +* [Antora Documentation](https://docs.antora.org/antora/1.0/page/) + + +## 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. + +Both scripts use docker, so please make sure you have it installed on your system. Please see below for instructions. + +To build and preview the site, run: + +``` +$ ./build.sh && ./preview.sh +``` + +The result will be available at http://localhost:8080 + +### Installing docker on Fedora + +``` +$ sudo dnf install docker +$ sudo systemctl start docker && sudo systemctl enable docker +``` diff --git a/antora.yml b/antora.yml new file mode 100644 index 0000000..570554b --- /dev/null +++ b/antora.yml @@ -0,0 +1,8 @@ +name: fedora +title: Fedora +version: f26 +nav: +#- modules/ROOT/nav.adoc +- modules/release-notes/nav.adoc +- modules/install-guide/nav.adoc +- modules/system-administrators-guide/nav.adoc diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc new file mode 100644 index 0000000..960cddb --- /dev/null +++ b/modules/ROOT/nav.adoc @@ -0,0 +1 @@ +* xref:index.adoc[starting page] diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc new file mode 100644 index 0000000..1565314 --- /dev/null +++ b/modules/ROOT/pages/index.adoc @@ -0,0 +1,3 @@ += Welcome to Fedora + +NOTE: We still need the Release notes to be moved to Antora. As a start, the https://docs.fedoraproject.org/f28/release-notes/welcome/Welcome.html[Welcome to Fedora] page from release notes will be the homepage here. \ No newline at end of file