From 7f8216ea1b63c3d56faf025f3741c5eab09a0d61 Mon Sep 17 00:00:00 2001 From: Aleksandra Fedorova Date: Dec 08 2018 00:32:34 +0000 Subject: Initial setup for CI docs --- diff --git a/antora.yml b/antora.yml index 3ea0e50..3217a24 100644 --- a/antora.yml +++ b/antora.yml @@ -1,9 +1,9 @@ # Name will be mostly visible in the URL. Treat it as an indentifier. # 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 +name: fedora-ci # <---- PLEASE MODIFY # Title will be visible on the page. -title: Pizza Factory # <---- PLEASE MODIFY +title: Fedora CI # <---- PLEASE MODIFY # 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 "master" to a specific version. version: master diff --git a/modules/ROOT/assets/images/pizza.png b/modules/ROOT/assets/images/pizza.png deleted file mode 100644 index bdecba7..0000000 Binary files a/modules/ROOT/assets/images/pizza.png and /dev/null differ diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index a4054d4..2ad565f 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1,5 +1,2 @@ -* xref:architecture.adoc[Architecture] -** xref:pizza-owen.adoc[Pizza Owen] -** xref:pizza-dough.adoc[Pizza Dough] -* xref:community.adoc[Community] +* xref:sti.adoc[Standard Test Interface] * xref:faq.adoc[FAQ] diff --git a/modules/ROOT/pages/architecture.adoc b/modules/ROOT/pages/architecture.adoc deleted file mode 100644 index 97c3e57..0000000 --- a/modules/ROOT/pages/architecture.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Pizza Factory Architecture - -The architecture of our pizza factory is quite simple. We bake our very expensive xref:pizza-dough.adoc[pizza dough] in a very cheap xref:pizza-owen.adoc[pizza owen]. This way, we can achieve a medicore result for a high price and a reasonable number of failures. diff --git a/modules/ROOT/pages/community.adoc b/modules/ROOT/pages/community.adoc deleted file mode 100644 index def9977..0000000 --- a/modules/ROOT/pages/community.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Pizza Factory Community - -Our community is basically the same as the community of Fedora Docs. That's mostly because this is a template for new pieces of the Fedora Docs. diff --git a/modules/ROOT/pages/faq.adoc b/modules/ROOT/pages/faq.adoc index 8a8da48..dffb2cc 100644 --- a/modules/ROOT/pages/faq.adoc +++ b/modules/ROOT/pages/faq.adoc @@ -1,7 +1,7 @@ = Frequently Asked Questions (FAQ) [qanda] -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! +Should I test my package?:: + Of course you should! +How I get help?:: + Use #fedora-ci channel on IRC. diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index f11d625..2b17998 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,7 +1,3 @@ -= The Pizza Project += Fedora CI -The Pizza Project is a useful project with a very bad name — it helps you with writing some new documentation for Fedora. - -In fact, this is just a source template for a new piece of the Fedora Docs. - -image::pizza.png[Pizza] +Here we store documentation on CI pipelines, test frameworks, infrastructure details, bots and messages. diff --git a/modules/ROOT/pages/pizza-dough.adoc b/modules/ROOT/pages/pizza-dough.adoc deleted file mode 100644 index 5b59bae..0000000 --- a/modules/ROOT/pages/pizza-dough.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Pizza Dough Architecture - -I would never thought that a pizza dough can have an architecture. Yet here we are. diff --git a/modules/ROOT/pages/pizza-owen.adoc b/modules/ROOT/pages/pizza-owen.adoc deleted file mode 100644 index b15ebaf..0000000 --- a/modules/ROOT/pages/pizza-owen.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Pizza Owen Architecture - -Pizza owen architecture would be described on this page. Since this is just a template, I choose to disappoint you and not describe the pizza owen architecture. diff --git a/modules/ROOT/pages/sti.adoc b/modules/ROOT/pages/sti.adoc new file mode 100644 index 0000000..b38f135 --- /dev/null +++ b/modules/ROOT/pages/sti.adoc @@ -0,0 +1,3 @@ +# Standard Test Interface + +The interface provides wrapper to fit your tests into various CI pipelines. diff --git a/site.yml b/site.yml index 96b79fd..99fc9c9 100644 --- a/site.yml +++ b/site.yml @@ -1,6 +1,6 @@ site: title: Local Preview - start_page: pizza-factory::index + start_page: fedora-ci::index content: sources: - url: .