adapt to antora
Signed-off-by: Igor Gnatenko <ignatenkobrain@fedoraproject.org>
This commit is contained in:
parent
3a32f38153
commit
8a2c101fb5
103 changed files with 149 additions and 0 deletions
3
.gitignore
vendored
Normal file
3
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
/build/
|
||||
/cache/
|
||||
/public/
|
||||
12
Makefile
Normal file
12
Makefile
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
ANTORA_DIR := $(dir $(realpath $(firstword $(MAKEFILE_LIST))))
|
||||
|
||||
doc: .FORCE
|
||||
podman run --rm -it -v "$(ANTORA_DIR):/antora:z" \
|
||||
antora/antora --html-url-extension-style=indexify site.yml
|
||||
|
||||
serve: .FORCE
|
||||
python3 -m http.server --directory "$(ANTORA_DIR)public"
|
||||
|
||||
.FORCE:
|
||||
.DEFAULT_GOAL := doc
|
||||
.PHONY: doc serve
|
||||
16
guidelines/antora.yml
Normal file
16
guidelines/antora.yml
Normal 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: packaging-guidelines
|
||||
|
||||
# Title will be visible on the page.
|
||||
title: Packaging Guidelines
|
||||
|
||||
# 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
|
||||
97
guidelines/modules/ROOT/nav.adoc
Normal file
97
guidelines/modules/ROOT/nav.adoc
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
* xref:Ada.adoc[Ada]
|
||||
* xref:Alternatives.adoc[Alternatives]
|
||||
* xref:AppData.adoc[AppData]
|
||||
* xref:AutoProvidesAndRequiresFiltering.adoc[AutoProvidesAndRequiresFiltering]
|
||||
* xref:Bundled_Libraries.adoc[Bundled_Libraries]
|
||||
* xref:Bundled_Libraries_Virtual_Provides.adoc[Bundled_Libraries_Virtual_Provides]
|
||||
* xref:C_and_C+\+.adoc[C_and_C++]
|
||||
* xref:Cmake.adoc[Cmake]
|
||||
* xref:Committee.adoc[Committee]
|
||||
* xref:Conflicts.adoc[Conflicts]
|
||||
* xref:CronFiles.adoc[CronFiles]
|
||||
* xref:CryptoPolicies.adoc[CryptoPolicies]
|
||||
* xref:D.adoc[D]
|
||||
* xref:Debuginfo.adoc[Debuginfo]
|
||||
* xref:DefaultServices.adoc[DefaultServices]
|
||||
* xref:Deprecating_Packages.adoc[Deprecating_Packages]
|
||||
* xref:DevAssistant.adoc[DevAssistant]
|
||||
* xref:Directory_Replacement.adoc[Directory_Replacement]
|
||||
* xref:DistTag.adoc[DistTag]
|
||||
* xref:Drupal7.adoc[Drupal7]
|
||||
* xref:EclipsePlugins.adoc[EclipsePlugins]
|
||||
* xref:Emacs.adoc[Emacs]
|
||||
* xref:Emacs_Old.adoc[Emacs_Old]
|
||||
* xref:EnvironmentModules.adoc[EnvironmentModules]
|
||||
* xref:EPEL.adoc[EPEL]
|
||||
* xref:FontsPolicy.adoc[FontsPolicy]
|
||||
* xref:FontsSpecTemplate.adoc[FontsSpecTemplate]
|
||||
* xref:Fortran.adoc[Fortran]
|
||||
* xref:FrequentlyMadeMistakes.adoc[FrequentlyMadeMistakes]
|
||||
* xref:FullExceptionList.adoc[FullExceptionList]
|
||||
* xref:GAP.adoc[GAP]
|
||||
* xref:GCJGuidelines.adoc[GCJGuidelines]
|
||||
* xref:Globus.adoc[Globus]
|
||||
* xref:Guidelines:Systemd.adoc[Guidelines:Systemd]
|
||||
* xref:GuidelinesTodo.adoc[GuidelinesTodo]
|
||||
* xref:Haskell.adoc[Haskell]
|
||||
* xref:Initial_Service_Setup.adoc[Initial_Service_Setup]
|
||||
* xref:Java.adoc[Java]
|
||||
* xref:JavaScript.adoc[JavaScript]
|
||||
* xref:JPackagePolicy.adoc[JPackagePolicy]
|
||||
* xref:KernelModules.adoc[KernelModules]
|
||||
* xref:Langpacks.adoc[Langpacks]
|
||||
* xref:LibreOfficeExtensions.adoc[LibreOfficeExtensions]
|
||||
* xref:LibreOfficeExtentions.adoc[LibreOfficeExtentions]
|
||||
* xref:LicensingGuidelines.adoc[LicensingGuidelines]
|
||||
* xref:Lisp.adoc[Lisp]
|
||||
* xref:Meson.adoc[Meson]
|
||||
* xref:MinGW.adoc[MinGW]
|
||||
* xref:MinGW_Old.adoc[MinGW_Old]
|
||||
* xref:Mono.adoc[Mono]
|
||||
* xref:MPI.adoc[MPI]
|
||||
* xref:Naming.adoc[Naming]
|
||||
* xref:NamingGuidelines.adoc[NamingGuidelines]
|
||||
* xref:NewMeetingTime.adoc[NewMeetingTime]
|
||||
* xref:No_Bundled_Libraries.adoc[No_Bundled_Libraries]
|
||||
* xref:Node.js.adoc[Node.js]
|
||||
* xref:OCaml.adoc[OCaml]
|
||||
* xref:Octave.adoc[Octave]
|
||||
* xref:OldJPackagePolicy.adoc[OldJPackagePolicy]
|
||||
* xref:Old_Ruby.adoc[Old_Ruby]
|
||||
* xref:OpenOffice.orgExtensions.adoc[OpenOffice.orgExtensions]
|
||||
* xref:PatchUpstreamStatus.adoc[PatchUpstreamStatus]
|
||||
* xref:Perl.adoc[Perl]
|
||||
* xref:Per-Product_Configuration.adoc[Per-Product_Configuration]
|
||||
* xref:PHP.adoc[PHP]
|
||||
* xref:PkgConfigBuildRequires.adoc[PkgConfigBuildRequires]
|
||||
* xref:PreupgradeAssistant.adoc[PreupgradeAssistant]
|
||||
* xref:Python%2FEggs.adoc[Python%2FEggs]
|
||||
* xref:Python.adoc[Python]
|
||||
* xref:Python_Appendix.adoc[Python_Appendix]
|
||||
* xref:PythonAppendix.adoc[PythonAppendix]
|
||||
* xref:Python_Eggs.adoc[Python_Eggs]
|
||||
* xref:Python_F21.adoc[Python_F21]
|
||||
* xref:Python_Old.adoc[Python_Old]
|
||||
* xref:R.adoc[R]
|
||||
* xref:ReviewGuidelines.adoc[ReviewGuidelines]
|
||||
* xref:RPMMacros.adoc[RPMMacros]
|
||||
* xref:RPM_Source_Dir.adoc[RPM_Source_Dir]
|
||||
* xref:Ruby.adoc[Ruby]
|
||||
* xref:Rust.adoc[Rust]
|
||||
* xref:Scriptlets.adoc[Scriptlets]
|
||||
* xref:ScriptletSnippets.adoc[ScriptletSnippets]
|
||||
* xref:SourceURL.adoc[SourceURL]
|
||||
* xref:SSLCertificateHandling.adoc[SSLCertificateHandling]
|
||||
* xref:SugarActivityGuidelines.adoc[SugarActivityGuidelines]
|
||||
* xref:Systemd.adoc[Systemd]
|
||||
* xref:SysVInitScript.adoc[SysVInitScript]
|
||||
* xref:Tcl.adoc[Tcl]
|
||||
* xref:Tmpfiles.d.adoc[Tmpfiles.d]
|
||||
* xref:Treatment_Of_Bundled_Libraries.adoc[Treatment_Of_Bundled_Libraries]
|
||||
* xref:UnownedDirectories.adoc[UnownedDirectories]
|
||||
* xref:UsersAndGroups.adoc[UsersAndGroups]
|
||||
* xref:Versioning.adoc[Versioning]
|
||||
* xref:WeakDependencies.adoc[WeakDependencies]
|
||||
* xref:Web_Assets.adoc[Web_Assets]
|
||||
* xref:What_Can_Be_Packaged.adoc[What_Can_Be_Packaged]
|
||||
* xref:WordPress_plugin_packaging_guidelines.adoc[WordPress_plugin_packaging_guidelines]
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue