separate 'docs docs' from the 'contributing' part

This commit is contained in:
Adam Samalik 2018-09-03 15:50:02 +02:00
commit 2ccbec4ee0
15 changed files with 31 additions and 22 deletions

View file

@ -1,7 +1,17 @@
# Fedora Docs Template
# Fedora Docs documentation
This repository contains a minimal source structure for a new Fedora Docs source.
## Content of this repo
### Fedora Docs docs (placeholder)
Under `modules/ROOT`, a placeholder for the Fedora Docs docs — intended to be moved to its own repository.
### Fedora Docs docs / contributing
Under `modules/contributing`, the contributor's guide — the primary content of this repository.
## Structure
```
@ -14,15 +24,10 @@ This repository contains a minimal source structure for a new Fedora Docs source
`-- ROOT ......................... 5.
|-- assets
| `-- images ............... 6.
| `-- pizza.png
| `-- ...
|-- nav.adoc ................. 7.
`-- pages .................... 8.
|-- architecture.adoc
|-- community.adoc
|-- faq.adoc
|-- index.adoc
|-- pizza-dough.adoc
`-- pizza-owen.adoc
|-- ...
```
1. Metadata definition.

View file

@ -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: documentation-contributors-guide
name: fedora-docs
# Title will be visible on the page.
title: Documentation Contributor's Guide
title: Fedora 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 "master" to a specific version.
version: master
@ -14,3 +14,4 @@ start_page: ROOT:index
# This lists all the menu definitions of your component.
nav:
- modules/ROOT/nav.adoc
- modules/contributing/nav.adoc

View file

@ -1,8 +0,0 @@
* xref:index.adoc[Introduction]
* xref:prerequisites.adoc[Prerequisites]
//* xref:repo-structure.adoc[Repository Structure]
* xref:contributing-to-existing-docs.adoc[Contributing to Existing Documentation]
* xref:adding-new-docs.adoc[Adding New Documentation to the Site]
* xref:local-preview.adoc[Building a Local Preview]
//* xref:working-with-translations.adoc[Working with Translations]
//* xref:markup.adoc[ASCIIDoc Markup]

View file

@ -1,4 +1,3 @@
= Introduction
This document explains how to work with the new publishing system used to build the Fedora Documentation website and others. It will guide you through contributing to existing documentation as well as creating completely new content sets and publishing them in the English originals as well as any possible translations.
= Fedora Docs
This guide explains Antora in the context of the Fedora Documentation website. For more general information about the Antora publishing system, see the link:https://antora.org/[project website] and link:https://docs.antora.org/antora/1.0/page/[Antora documentation].
NOTE: This page is a placeholder for the Fedora Docs documentation. At this moment, only contributors' guide is available.

View file

Before

Width:  |  Height:  |  Size: 220 KiB

After

Width:  |  Height:  |  Size: 220 KiB

Before After
Before After

View file

@ -0,0 +1,8 @@
* xref:index.adoc[Contributing]
** xref:prerequisites.adoc[Prerequisites]
//** xref:repo-structure.adoc[Repository Structure]
** xref:contributing-to-existing-docs.adoc[Contributing to Existing Documentation]
** xref:adding-new-docs.adoc[Adding New Documentation to the Site]
** xref:local-preview.adoc[Building a Local Preview]
//** xref:working-with-translations.adoc[Working with Translations]
//** xref:markup.adoc[ASCIIDoc Markup]

View file

@ -0,0 +1,4 @@
= Introduction
This document explains how to work with the new publishing system used to build the Fedora Documentation website and others. It will guide you through contributing to existing documentation as well as creating completely new content sets and publishing them in the English originals as well as any possible translations.
This guide explains Antora in the context of the Fedora Documentation website. For more general information about the Antora publishing system, see the link:https://antora.org/[project website] and link:https://docs.antora.org/antora/1.0/page/[Antora documentation].

View file

@ -1,6 +1,6 @@
site:
title: Documentation Contributor's Guide
start_page: documentation-contributors-guide::index
start_page: fedora-docs::index
content:
sources:
- url: .