1
0
Fork 0
forked from docs/team-docs

Add barebones site

This commit is contained in:
Petr Bokoč 2018-08-11 10:35:52 +02:00
commit cb11337905
13 changed files with 55 additions and 0 deletions

16
antora.yml Normal file
View file

@ -0,0 +1,16 @@
# 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
# Title will be visible on the page.
title: Documentation Contributor's Guide
# 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
# 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
# This lists all the menu definitions of your component.
nav:
- modules/ROOT/nav.adoc

Binary file not shown.

After

Width:  |  Height:  |  Size: 220 KiB

9
modules/ROOT/nav.adoc Normal file
View file

@ -0,0 +1,9 @@
* xref:introduction.adoc[Introduction]
* xref:prerequisites.adoc[Before You Start]
* 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]
* xref:writing-tips.adoc[Writing Tips]

View file

View file

View file

View file

View file

@ -0,0 +1,8 @@
[id='prerequisites']
= Prerequisites
Before you start contributing, you will need at least the following:
* A *FAS* account
* A plaintext editor such as [application]`vim`, [application]`emacs`, [application]`Atom`, etc., preferably with ASCIIDoc syntax highlighting.
* [application]`git` and working knowledge of it. xref:repo-structure

View file

@ -0,0 +1,2 @@
[id='repo-structure']
= Repository Structure

View file

20
site.yml Normal file
View file

@ -0,0 +1,20 @@
site:
title: Documentation Contributor's Guide
start_page: documentation-contributors-guide::index
content:
sources:
- url: .
branches: HEAD
ui:
bundle:
url: https://asamalik.fedorapeople.org/ui-bundle.zip
snapshot: true
default_layout: with_menu
output:
clean: true
dir: ./public
destinations:
- provider: archive
runtime:
pull: true
cache_dir: ./cache