forked from docs/team-docs
first cut of a new team page structure
This commit is contained in:
parent
b4e2d8f745
commit
50be068287
28 changed files with 300 additions and 39 deletions
|
|
@ -1,2 +1,6 @@
|
|||
* xref:meetings.adoc[Meetings]
|
||||
* xref:charter.adoc[Charter]
|
||||
* xref:docs-charter.adoc[How we work]
|
||||
* xref:team-members.adoc[Who we are]
|
||||
* xref:working-infrastructure.adoc[Where to find]
|
||||
* xref:contribution-options.adoc[How to contribute]
|
||||
* xref:communication-meetings.adoc[How to make contact]
|
||||
* xref:archive.adoc[What we have achieved so far]
|
||||
|
|
|
|||
BIN
modules/ROOT/pages/.DS_Store
vendored
Normal file
BIN
modules/ROOT/pages/.DS_Store
vendored
Normal file
Binary file not shown.
16
modules/ROOT/pages/archive.adoc
Normal file
16
modules/ROOT/pages/archive.adoc
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Archive
|
||||
|
||||
[abstract]
|
||||
____
|
||||
TBD
|
||||
____
|
||||
[NOTE]
|
||||
====
|
||||
*_TOC_*
|
||||
|
||||
* Documentation of work we have done over years
|
||||
|
||||
** Pre Antora docs (Fedora 1 - 2?)
|
||||
====
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
= Docs team meetings
|
||||
= Communication and Meetings
|
||||
|
||||
Fedora Docs currently holds weekly meetings on IRC/Telegram/Matrix.
|
||||
See the link:++https://calendar.fedoraproject.org//docs/++[docs calendar] for current meeting times,
|
||||
17
modules/ROOT/pages/contribution-options.adoc
Normal file
17
modules/ROOT/pages/contribution-options.adoc
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= How to contribute
|
||||
|
||||
[abstract]
|
||||
____
|
||||
TBD
|
||||
____
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
*_TOC_*
|
||||
|
||||
* Documentation of work we have done over years
|
||||
|
||||
** Pre Antora docs (Fedora 1 - 2?)
|
||||
====
|
||||
15
modules/ROOT/pages/docs-charter.adoc
Normal file
15
modules/ROOT/pages/docs-charter.adoc
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Team Organisation and procedures
|
||||
|
||||
[abstract]
|
||||
____
|
||||
TBD
|
||||
____
|
||||
[NOTE]
|
||||
====
|
||||
*_TOC_*
|
||||
|
||||
* Doc Teams charter
|
||||
====
|
||||
|
||||
3
modules/ROOT/pages/how-use-web-ide-ui.adoc
Normal file
3
modules/ROOT/pages/how-use-web-ide-ui.adoc
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
= How to Use the Gitlab web IDE interfac
|
||||
|
||||
TBD
|
||||
22
modules/ROOT/pages/team-members.adoc
Normal file
22
modules/ROOT/pages/team-members.adoc
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Who we are – The Fedora documentation team members
|
||||
|
||||
[abstract]
|
||||
____
|
||||
The Fedora Documentation Team is a large community with a large number of members, different tasks and varying degrees of cooperation.
|
||||
____
|
||||
[NOTE]
|
||||
====
|
||||
TOC
|
||||
|
||||
* Basic organization
|
||||
** Maybe Core team / Editorial team
|
||||
** Editor in chief for specific documentation areas, e.g. Quickdocs
|
||||
** production line administrators
|
||||
* List of members of core team / editorieal team / arganisators, how we name it
|
||||
** Name
|
||||
** Nick name / reference to wiki personal page
|
||||
** Domain of expertise
|
||||
* List of members of other sub groups
|
||||
====
|
||||
17
modules/ROOT/pages/working-infrastructure.adoc
Normal file
17
modules/ROOT/pages/working-infrastructure.adoc
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Fedora Documentation Infrastructure
|
||||
|
||||
[abstract]
|
||||
____
|
||||
The fedora docs ars stored in git repositories.
|
||||
____
|
||||
[NOTE]
|
||||
====
|
||||
*_TOC_*
|
||||
|
||||
* Repositories on gitlab
|
||||
* Organization / overview of repositories including links
|
||||
* Where to find what
|
||||
* TBD
|
||||
====
|
||||
BIN
modules/contributing/.DS_Store
vendored
Normal file
BIN
modules/contributing/.DS_Store
vendored
Normal file
Binary file not shown.
2
modules/contributing/how-use-file-edit-if.adoc
Normal file
2
modules/contributing/how-use-file-edit-if.adoc
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
= How to use the file edit interface
|
||||
|
||||
|
|
@ -1,12 +1,13 @@
|
|||
* xref:index.adoc[Contributing]
|
||||
** For writers:
|
||||
*** xref:prerequisites.adoc[Prerequisites]
|
||||
//** xref:repo-structure.adoc[Repository Structure]
|
||||
*** xref:contributing-to-existing-docs.adoc[Contributing to Existing Documentation]
|
||||
*** xref:contributing-to-release-notes.adoc[Contributing to Release Notes]
|
||||
*** xref:adding-new-docs.adoc[Adding New Documentation to the Site]
|
||||
*** xref:local-preview.adoc[Building a Local Preview]
|
||||
*** xref:git.adoc[Git for docs writers]
|
||||
//** xref:working-with-translations.adoc[Working with Translations]
|
||||
** For designers:
|
||||
*** xref:design-ux.adoc[Design & UX]
|
||||
** xref:content-contribution.adoc[Content Contribution]
|
||||
*** xref:use-file-edit-if.adoc[Hot to use the file edit interface]
|
||||
*** xref:use-web-ide-ui.adoc[How to Use the Gitlab web IDE interface]
|
||||
*** xref:use-local-work-env.adoc[How to create and use a local work environment]
|
||||
**** xref:use-local-work-preview.adoc[Building a Local Preview]
|
||||
**** xref:use-local-work-git.adoc[Git for docs writers]
|
||||
*** xref:contrib-upd-document.adoc[Update an existing documentation page]
|
||||
*** xref:contrib-new-documentation.adoc[Create and publish new documentation sites]
|
||||
*** xref:style-guide.adoc[The Fedora contributor’s Style Guide]
|
||||
*** xref:write-asciidoc-fedora-docs[AsciiDoc for Fedora]
|
||||
*** xref:working-with-translations.adoc[Working with Translations]
|
||||
** xref:design-ux-contribution.adoc[Design and user interface contributions]
|
||||
|
|
|
|||
16
modules/contributing/pages/content-contribution.adoc
Normal file
16
modules/contributing/pages/content-contribution.adoc
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
= Content contribution
|
||||
|
||||
|
||||
Summary:
|
||||
Here you find all information you need to contribute.
|
||||
|
||||
How to use the file edit interface::
|
||||
Short summary TBD
|
||||
How to Use the Gitlab web IDE interface::
|
||||
Short summary TBD
|
||||
How to create and use a local work environment:;
|
||||
Short summary TBD
|
||||
The Fedora contributor's Style Guide;;
|
||||
Short summary TBD
|
||||
How to code in AsciiDoc::
|
||||
Short summary
|
||||
|
|
@ -2,6 +2,14 @@ include::ROOT:partial$attributes.adoc[]
|
|||
|
||||
= Create and publish new documentation sites
|
||||
|
||||
[abstract]
|
||||
____
|
||||
This section describes how to add a complete new piece of documentation that covers a new area in its entirety. This spans several pages and is usually associated with the creation of a new, dedicated repository. A local working environment is best suited for this. But it is also possible to use the GitLab web IDE.
|
||||
____
|
||||
[NOTE]
|
||||
====
|
||||
The following text is not yet edited and needs to be adjusted.
|
||||
====
|
||||
This section describes how to create and publish new documentation to the docs.fedoraproject.org website.
|
||||
Before you start following this procedure, review all the requirements listed in xref:prerequisites.adoc[Prerequisites].
|
||||
|
||||
9
modules/contributing/pages/contrib-upd-document.adoc
Normal file
9
modules/contributing/pages/contrib-upd-document.adoc
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Update an existing documentation page
|
||||
|
||||
[abstract]
|
||||
____
|
||||
This section describes the procedure to edit an existing page. This typically involves minor changes, e.g. a correction to the text or an update to the content of a corresponding software change. The File Edit Interface can be used conveniently for this purpose.
|
||||
____
|
||||
|
||||
|
|
@ -1,5 +1,14 @@
|
|||
= Design & UX of docs.fedoraproject.org site
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs>
|
||||
= Design & UX contributions
|
||||
|
||||
[abstract]
|
||||
_____
|
||||
This section provides information for designers, user interface (UI), or user experioence (UX) developer how to contribute to the docs.fedoraproject.org site.
|
||||
_____
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The following text is still unedited and needs adjustment.
|
||||
====
|
||||
|
||||
This page explains how to contribute to the Fedora Docs Team as a designer or user interface (U.I.) / user experience (U.X.) developer.
|
||||
|
||||
5
modules/contributing/pages/index-old.adoc
Normal file
5
modules/contributing/pages/index-old.adoc
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
= 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 https://antora.org/[Antora website] and https://docs.antora.org/antora/latest/page/[Antora documentation].
|
||||
|
|
@ -1,4 +1,56 @@
|
|||
= 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.
|
||||
= How to contribute
|
||||
|
||||
This guide explains Antora in the context of the Fedora Documentation website. For more general information about the Antora publishing system, see the https://antora.org/[Antora website] and https://docs.antora.org/antora/latest/page/[Antora documentation].
|
||||
[abstract]
|
||||
____
|
||||
This document explains how to work with the publishing system used to build the Fedora Documentation website, including user as well as contributor's documentation. It covers content contribution as well as design or ui contributions. 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 covers the Antora WEB CMS in the context of the Fedora Documentation website. For more general information about the Antora publishing system, see the https://antora.org/[Antora website] and https://docs.antora.org/antora/latest/page/[Antora documentation].
|
||||
|
||||
There are many and very different ways to contribute to Fedora documentation
|
||||
|
||||
== Content contributions
|
||||
|
||||
=== Prerequisites
|
||||
|
||||
The only requirements for contributing documentation to Fedora Docs are:
|
||||
|
||||
* link:++https://admin.fedoraproject.org/accounts/++[*Fedora Account System*] (*FAS*) account.
|
||||
* Must have signed https://fedoraproject.org/wiki/Legal:Fedora_Project_Contributor_Agreement[Fedora Project Contributor Agreement] from FAS (see https://admin.fedoraproject.org/accounts/group/view/cla_done[here])
|
||||
* Basic knowledge of *AsciiDoc* markup language (see xref:asciidoc-fedora:markup.adoc[AsciiDoc for Fedora])
|
||||
|
||||
|
||||
=== Contribute to existing articles
|
||||
|
||||
Many ways for various type of contributions, e.g. typo fixes, adding short information, e.g. a link, update an article, contribute a new article.
|
||||
|
||||
Generell procedure:
|
||||
|
||||
* A author contributes a git “pull request”, i.e. a modified version of a documentation item, mostly a page.
|
||||
* A member of editorial boards checks and publishes or asks questions. Allow 2-3 days for a answer to an request.
|
||||
|
||||
=== Contribute a new articles
|
||||
|
||||
TBD
|
||||
|
||||
== Ways to contribute
|
||||
|
||||
The quick way – Editing a specific file::
|
||||
Edit a specific file you with to improve.
|
||||
Suitable for minor fixes of existing pages
|
||||
|
||||
The easy way – Using the gitlab web IDE::
|
||||
quite comfortable, no need to install anything locally, most of the steps automatic
|
||||
Suitable fpr existing aritcles as well as new ondes.
|
||||
|
||||
Tthe advanced way – Creating a local writing environment::
|
||||
comfortable, work locally w/o internet connections dpendencies
|
||||
|
||||
== Design contributions
|
||||
|
||||
TBD
|
||||
|
||||
== Technical contributions
|
||||
|
||||
TBD
|
||||
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
= ASCIIDoc markup
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
= Prerequisites
|
||||
|
||||
The only requirements for contributing documentation updates to Fedora Docs are:
|
||||
|
||||
* A link:++https://accounts.fedoraproject.org/++[Fedora Account System] (FAS) account.
|
||||
* You must have signed the https://fedoraproject.org/wiki/Legal:Fedora_Project_Contributor_Agreement[Fedora Project Contributor Agreement] in FAS (in your profile, go to "Settings" -> "Agreements").
|
||||
* You will need a basic knowledge of the *AsciiDoc* markup language, which is used to write the documentation pages (see xref:asciidoc-fedora:markup.adoc[AsciiDoc for Fedora]).
|
||||
|
||||
|
||||
You can xref:contributing-to-existing-docs.adoc#_editing_online_in_pagure[modify/edit documentation pages directly in your browser] (without installing any new tools/software on your computer).
|
||||
For larger updates which may be easier to work on offline, you may also need the following:
|
||||
|
||||
* A plaintext editor, preferably with AsciiDoc syntax highlighting to work on the documentation pages. e.g., [application]`vim`, [application]`emacs`, [application]`Atom`, [application]`VSCode`.
|
||||
* [application]`git` (see xref::git.adoc[Git for docs writers]).
|
||||
* [application]`Podman` or [application]`Docker CE` to test your changes offline.
|
||||
|
|
@ -1 +0,0 @@
|
|||
= Repository structure
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
= Contributing to existing documentation
|
||||
= How to use the file edit interface
|
||||
|
||||
This section describes how to contribute to existing documentation - that is, documentation that already has been published on the website.
|
||||
Before you start following this procedure, make sure that you fulfill all the requirements listed in xref:prerequisites.adoc[Prerequisites].
|
||||
Before you start following this procedure, make sure that you fulfill all the requirements listed in xref:index.adoc[Prerequisites].
|
||||
|
||||
[TIP]
|
||||
If you are interested in contributing to Release Notes, see the xref:contributing-to-release-notes.adoc[appropriate page].
|
||||
|
|
@ -74,7 +74,7 @@ see link:++https://commit.style++[commit.style] by Tim Pope (author of [applicat
|
|||
. If you added any new files, then ensure they are included in a reasonable spot in the repository's [filename]`nav.adoc` configuration file
|
||||
|
||||
. Build locally and make sure everything looks the way you expect.
|
||||
See xref:local-preview.adoc[Building a local preview] for instructions.
|
||||
See xref:use-local-work-preview.adoc[Building a local preview] for instructions.
|
||||
|
||||
. Once you finish, commit your changes and push them to your fork.
|
||||
|
||||
12
modules/contributing/pages/use-local-work-env.adoc
Normal file
12
modules/contributing/pages/use-local-work-env.adoc
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
= How to create and use a local work environment
|
||||
|
||||
TBD
|
||||
|
||||
|
||||
|
||||
|
||||
For larger updates or to contribute all-new documentation, you may also need:
|
||||
|
||||
* A plaintext editor such as [application]`vim`, [application]`emacs`, [application]`Atom`, [application]`VSCode`, etc., preferably with AsciiDoc syntax highlighting.
|
||||
* [application]`git` (see xref::use-local-work-git.adoc[Git for docs writers])
|
||||
* [application]`Podman` if you use a Linux OS such as Fedora or [application]`Docker CE` if you use macOS.
|
||||
60
modules/contributing/pages/use-local-work-preview.adoc
Normal file
60
modules/contributing/pages/use-local-work-preview.adoc
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
:experimental:
|
||||
|
||||
= Building a local preview
|
||||
Because the documentation site is using a markup language instead of a WYSIWYG editor, the sources do not look exactly like the rendered page will. Therefore it is necessary to check that your changes look the way you want them to before you push and make a pull request. This involves building a local preview.
|
||||
|
||||
There are two shell scripts available in each existing repository (including the template repository used to create new content): `build.sh` and `preview.sh`.
|
||||
|
||||
To preview, run the `build.sh` script; this is the one that actually builds a local version of the site (or, more precisely, the subset of the full site that resides in your current repository). Then, run `preview.sh`, which starts a webserver and serves the site at link:http://localhost:8080/[]. Opening this URL in any web browser will show you the preview, which will be available until you kill the process (kbd:[Ctrl+C] in the terminal).
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
To run the scripts you'll need to install [application]`Podman` if using a Linux OS such as Fedora or [application]`Docker CE` if using macOS.
|
||||
====
|
||||
|
||||
== Previewing multiple repositories
|
||||
If your work spans content in multiple repositories,
|
||||
e.g. because you xref:asciidoc-fedora:markup.adoc#external-antora-link[link to another repository],
|
||||
you can extend the preview by adding more repositories to `site.yml` as follows:
|
||||
|
||||
----
|
||||
content:
|
||||
sources:
|
||||
- url: .
|
||||
branches: HEAD
|
||||
- url: https://pagure.io/fedora-docs/another-repository.git
|
||||
branches: main
|
||||
----
|
||||
|
||||
Correct entries to use can be found from
|
||||
https://pagure.io/fedora-docs/docs-fp-o/blob/prod/f/site.yml[docs-fp-o site.yml].
|
||||
|
||||
== Using the regular Antora scripts
|
||||
If you want to use the regular Antora build and preview workflow - follow the instructions on https://docs.antora.org/[Antora Documentation page].
|
||||
|
||||
Once you have ``Antora CLI`` and ``Antora Site Generator`` you can build and preview the pages without the container scripts.
|
||||
|
||||
To build the pages in the project directory run:
|
||||
|
||||
[source]
|
||||
----
|
||||
antora generate site.yml
|
||||
----
|
||||
|
||||
This will create a new directory ``public`` which contains all the necessary files. Navigate there and run a server command. You might already have a Python simple server, in which case run:
|
||||
|
||||
[source]
|
||||
----
|
||||
python3 -m http.server
|
||||
----
|
||||
|
||||
or if you only have Python 2 on your machine:
|
||||
|
||||
[source]
|
||||
----
|
||||
python -m SimpleHTTPServer
|
||||
----
|
||||
|
||||
It opens a local preview at port 8000.
|
||||
|
||||
If you have cargo (Rust package manager), you could also install and use ``miniserve`` or any other simple server of your choice for that matter.
|
||||
3
modules/contributing/pages/use-web-ide-ui.adoc
Normal file
3
modules/contributing/pages/use-web-ide-ui.adoc
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
= How to Use the Gitlab web IDE interfac
|
||||
|
||||
TBD
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
= Write AsciiDoc for Fedora Documentation
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
I would like to insert AsciiDoc Tips here, which are currentliy a separate Module "AsciiDoc for Fedora" further down the navigation"
|
||||
====
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue