📝🏗️ Initialize Design Team docs for 2025
This commit makes various tweaks and changes to how the Fedora Design Team docs repository serves documentation. Key changes are noted below: * Ignored more common build artifacts in `.gitignore` * Change URL schema from `/design-docs/` to `/design/` * Remove all artifacts from the pizza factory example * Update partials file with several data-points about the Fedora Design Team and common collaboration points Signed-off-by: Justin W. Wheeler <jwf@redhat.com>
This commit is contained in:
parent
02784022cb
commit
4ae0f56ce5
15 changed files with 55 additions and 46 deletions
14
.gitignore
vendored
14
.gitignore
vendored
|
|
@ -1,4 +1,10 @@
|
|||
/build/
|
||||
/cache/
|
||||
/public/
|
||||
/preview.pid
|
||||
# Documentation artifacts
|
||||
# Antora-specific rules for preview documentation
|
||||
_package/
|
||||
_preview/
|
||||
|
||||
# Miscellaneous artifacts
|
||||
build
|
||||
cache
|
||||
preview.pid
|
||||
public
|
||||
|
|
|
|||
|
|
@ -425,4 +425,3 @@ the avoidance of doubt, this paragraph does not form part of the
|
|||
public licenses.
|
||||
|
||||
Creative Commons may be contacted at creativecommons.org.
|
||||
|
||||
|
|
@ -2,10 +2,10 @@
|
|||
# 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: design-docs # <---- PLEASE MODIFY
|
||||
name: design
|
||||
|
||||
# Title will be visible on the page.
|
||||
title: Design Docs # <---- PLEASE MODIFY
|
||||
title: Fedora Design Team
|
||||
|
||||
# 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.
|
||||
|
|
@ -19,4 +19,4 @@ start_page: ROOT:index.adoc
|
|||
|
||||
# This lists all the menu definitions of your component.
|
||||
nav:
|
||||
- modules/ROOT/nav.adoc
|
||||
- modules/ROOT/nav.adoc
|
||||
|
|
|
|||
|
|
@ -77,13 +77,13 @@ build () {
|
|||
# Check whether podman is available, else faill back to docker
|
||||
# which requires root.
|
||||
|
||||
if [ -f /usr/bin/podman ]; then
|
||||
if [ -n "$(command -v podman)" ]; then
|
||||
echo ""
|
||||
echo "This build script is using Podman to run the build in an isolated environment."
|
||||
echo ""
|
||||
podman run --rm -it -v $(pwd):/antora:z $image $cmd --stacktrace
|
||||
|
||||
elif [ -f /usr/bin/docker ]; then
|
||||
elif [ -n "$(command -v docker)" ]; then
|
||||
echo ""
|
||||
echo "This build script is using Docker to run the build in an isolated environment."
|
||||
echo ""
|
||||
|
|
|
|||
0
modules/ROOT/assets/images/.gitkeep
Normal file
0
modules/ROOT/assets/images/.gitkeep
Normal file
Binary file not shown.
|
Before Width: | Height: | Size: 220 KiB |
|
|
@ -1,9 +0,0 @@
|
|||
This is an example of a example file. Unlike files in `pages/`, files in this directory are not built as standalone pages, but only if they are included in a file within `pages/`. Also unlike examples,
|
||||
A file in this directory can be included within any file in the `pages/` directory.
|
||||
|
||||
Most common use cases for examples is using output from an external script (for example, translation string statistics) in docs. You can use an external script to update the example, and when the site is rebuilt, it will show updated output.
|
||||
|
||||
If you want to include this particular example somewhere, you can use the following syntax: `include::example$example-example.adoc[]`.
|
||||
Note the use of `example$` instead of an actual file location.
|
||||
|
||||
See link:https://docs.antora.org/antora/3.0/examples-directory/[Antora docs on examples] for more information about partials.
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
* xref:architecture.adoc[Architecture]
|
||||
** xref:pizza-oven.adoc[Pizza Oven]
|
||||
** xref:pizza-dough.adoc[Pizza Dough]
|
||||
* xref:community.adoc[Community]
|
||||
* xref:faq.adoc[FAQ]
|
||||
|
|
@ -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-oven.adoc[pizza oven]. This way, we can achieve a mediocre result for a high price and a reasonable number of failures.
|
||||
|
|
@ -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.
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
= 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 straightforward. And in fact, writing documentation makes you very happy. Just try and see for yourself!
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
= Pizza Dough Architecture
|
||||
|
||||
I would never thought that a pizza dough can have an architecture. Yet here we are.
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
= Pizza Oven Architecture
|
||||
|
||||
Pizza oven architecture would be described on this page. Since this is just a template, I choose to disappoint you and not describe the pizza oven architecture.
|
||||
|
|
@ -1 +1,38 @@
|
|||
:year: 2022
|
||||
// This is a data store of information about the Fedora Design Team.
|
||||
|
||||
// Team name:
|
||||
:team_name: Fedora Design Team
|
||||
|
||||
// Team summary:
|
||||
:team_summary: The {team_name} is Fedora's in-house design agency. We provide artwork, user experience, usability, and general design services to the Fedora Project.
|
||||
|
||||
// Team page URL:
|
||||
:team_url: https://docs.fedoraproject.org/en-US/design/
|
||||
|
||||
// Team activity status.
|
||||
// Choose from: Active, Inactive
|
||||
:team_status: Active
|
||||
|
||||
// Preferred asynchronous communication channel
|
||||
:team_asynch_communication: https://discussion.fedoraproject.org/tags/c/project/7/design-team
|
||||
:team_asynch_communication_name: Fedora Discussion
|
||||
|
||||
// Preferred synchronous communication channel
|
||||
:team_synch_communication: https://matrix.to/#/#design:fedoraproject.org
|
||||
:team_synch_communication_name: Fedora Chat/Matrix
|
||||
|
||||
// Issue tracker
|
||||
:team_issue_tracker: https://gitlab.com/fedora/design/team/requests
|
||||
:team_issue_tracker_name: GitLab
|
||||
|
||||
// Meetings
|
||||
:team_meetings: https://calendar.fedoraproject.org/design/
|
||||
:team_meetings_name: Fedora Calendar
|
||||
:team_meetings_agenda_name: SFC Etherpad
|
||||
:team_meetings_agenda_url: https://pad.sfconservancy.org/p/fedora-design-meetings
|
||||
:team_meetings_minutes_name: Møte
|
||||
:team_meetings_minutes_url: https://meetbot.fedoraproject.org/teams/design/
|
||||
|
||||
// Common URLs
|
||||
:url_commblog: https://communityblog.fedoraproject.org
|
||||
:url_wiki: https://fedoraproject.org/wiki
|
||||
|
|
|
|||
4
site.yml
4
site.yml
|
|
@ -1,6 +1,6 @@
|
|||
site:
|
||||
title: Local Preview
|
||||
start_page: design-docs::index.adoc
|
||||
title: (Local Preview) Fedora Design Team
|
||||
start_page: design::index.adoc
|
||||
content:
|
||||
sources:
|
||||
- url: .
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue