Skip to content

Commit

Permalink
restructuring in progress
Browse files Browse the repository at this point in the history
  • Loading branch information
sounix000 committed Nov 28, 2023
1 parent f9e2a87 commit 3ff519b
Show file tree
Hide file tree
Showing 7 changed files with 316 additions and 92 deletions.
21 changes: 21 additions & 0 deletions DC-kernel-boot-parameters-modify-generic
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Basics
MAIN="kernel-boot-parameters-modify.asm.xml"
SRC_DIR="articles"
ROOTID="kernel-boot-parameters-modify"
IMG_SRC_DIR="images"

# Profiling
PROFOS="generic"
# PROFARCH="x86_64;zseries;power;aarch64"
# PROFCONDITION="suse-product;beta"
# PROFCONDITION="community-project"

# When content is ready for publication, comment the
# line below or set DRAFT=0
DRAFT=0

## stylesheet location
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"

DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat"
23 changes: 23 additions & 0 deletions DC-kernel-boot-parameters-modify-non-sles
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Basics
# MAIN="kernel-boot-parameters-modify.asm.xml"
# SRC_DIR="articles"
# ROOTID="kernel-boot-parameters-modify"
# IMG_SRC_DIR="images"
MAIN="kernel-boot-parameters-modify.xml"
ROOTID="kernel-boot-parameters-modify"

# Profiling
PROFOS="non-sles"
# PROFARCH="x86_64;zseries;power;aarch64"
# PROFCONDITION="suse-product;beta"
# PROFCONDITION="community-project"

# When content is ready for publication, comment the
# line below or set DRAFT=0
DRAFT=1

## stylesheet location
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"

DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat"
23 changes: 23 additions & 0 deletions DC-kernel-boot-parameters-modify-sles
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Basics
# MAIN="kernel-boot-parameters-modify.asm.xml"
# SRC_DIR="articles"
# ROOTID="kernel-boot-parameters-modify"
# IMG_SRC_DIR="images"
MAIN="kernel-boot-parameters-modify.xml"
ROOTID="kernel-boot-parameters-modify"

# Profiling
PROFOS="sles"
# PROFARCH="x86_64;zseries;power;aarch64"
# PROFCONDITION="suse-product;beta"
# PROFCONDITION="community-project"

# When content is ready for publication, comment the
# line below or set DRAFT=0
DRAFT=1

## stylesheet location
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"

DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat"
12 changes: 0 additions & 12 deletions DC-task-modify-kernel-boot-parameters-non-sles

This file was deleted.

12 changes: 0 additions & 12 deletions DC-task-modify-kernel-boot-parameters-sles

This file was deleted.

189 changes: 189 additions & 0 deletions articles/kernel-boot-parameters-modify.asm.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- file: templates/articles/assembly.xml -->
<?xml-model href="https://cdn.docbook.org/schema/5.2/rng/assemblyxi.rnc"
type="application/relax-ng-compact-syntax"?>
<!DOCTYPE assembly
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<assembly version="5.2" xml:lang="en"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns="http://docbook.org/ns/docbook">
<!-- resources section references all topic chunks used in the final article
-->
<!-- R E S O U R C E S -->
<!-- Glue files -->
<resources>
<resource xml:id="_glue-example" href="../glues/glue.xml">
<description>Glue example</description>
</resource>
<resource xml:id="_glue-more-info" href="../glues/glue-more-info.xml">
<description>Glue for more information</description>
</resource>
<resource xml:id="_glue-whats-next" href="../glues/glue-whats-next.xml">
<description>Glue what's next</description>
</resource>
</resources>
<!-- Concept files -->
<resources>
<resource xml:id="_concept-example" href="../concepts/concept.xml">
<description>Concept example</description>
</resource>
</resources>
<!-- Tasks -->
<resources>
<resource xml:id="_task-example" href="../tasks/task.xml">
<description>Task example</description>
</resource>
</resources>
<!-- References -->
<resources>
<resource xml:id="_reference-example" href="../references/reference.xml">
<description>Reference example</description>
</resource>
</resources>
<!-- Legal -->
<resources>
<resource href="../common/legal.xml" xml:id="_legal">
<description>Legal Notice</description>
</resource>
<resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl">
<description>GNU Free Documentation License</description>
</resource>
</resources>
<!-- S T R U C T U R E -->
<structure renderas="article" xml:id="kernel-boot-parameters-modify" xml:lang="en">
<merge>
<title>Your title, limit to 55 characters, if possible</title>
<subtitle>Subtitle if necessary</subtitle>
<!-- Create changelog to enable versioning; add most recent entries at the top. -->
<revhistory xml:id="rh-kernel-boot-parameters-modify">
<revision><revnumber>2</revnumber><date>2024-11-11</date>
<revdescription>
<para>
Describe the purpose of this revision
</para>
</revdescription>
</revision>
<revision><revnumber>1</revnumber><date>2024-10-10</date>
<revdescription>
<para>
Describe the purpose of this revision
</para>
</revdescription>
</revision>
</revhistory>
<!-- TODO: provide a listing of possible and validatable meta entry values. Maybe in our geekodoc repo? -->
<!-- add author's e-mail -->
<meta name="maintainer" content="" its:translate="no"/>
<!-- ISO date of last update as YYYY-MM-DD -->
<meta name="updated" content="2023-11-11" its:translate="no"/>
<!-- this does not work yet. Use the dm tags listed below for now
<meta name="bugtracker" its:translate="no">
<phrase role="url">https://bugzilla.suse.com/enter_bug.cgi</phrase>
<phrase role="component">Non-product-specific documentation</phrase>
<phrase role="product">Smart Docs</phrase>
<phrase role="assignee">[email protected]</phrase>
</meta>
-->
<!-- not supported, yet. Use dm: tag for now
<meta name="translation" its:translate="no">
<phrase role="trans">yes</phrase>
<phrase role="language">de-de,cs-cz</phrase>
</meta>
-->
<!-- enter the platform identifier or a list of
identifiers, separated by ; -->
<meta name="architecture" content="x86;power" its:translate="no"/>
<meta name="productname" its:translate="no">
<!-- enter product name and version --><productname version="15-SP5">&sles;</productname>
</meta>
<meta name="title" its:translate="yes">short title for SEO and social media, max. 55 chars</meta>
<meta name="description" its:translate="yes">short description, max. 150 chars</meta>
<meta name="social-descr" its:translate="yes">ultrashort description for social media, max 55 chars</meta>
<!-- suitable category, comma-separated list of categories -->
<meta name="category" content="Systems Management" its:translate="no"/>
<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
<dm:bugtracker>
<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
<dm:component>Smart Docs</dm:component>
<dm:product>Documentation</dm:product>
<dm:assignee>[email protected]</dm:assignee>
</dm:bugtracker>
<dm:translation>yes</dm:translation>
</dm:docmanager>
<abstract>
<variablelist>
<varlistentry>
<term>WHAT?</term>
<listitem>
<para>
Describe your topic in one sentence.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>WHY?</term>
<listitem>
<para>
State the reason why one should read this.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>EFFORT</term>
<listitem>
<para>
What's the effort one has to put in?
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GOAL</term>
<listitem>
<para>
What's the reader's take-away from this article?
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>REQUIREMENTS</term>
<listitem>
<itemizedlist>
<listitem>
<para>
List the requirements to accomplish the task(s) described below.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</abstract>
</merge>
<!-- pull in all the topic files you need -->
<!-- pick the appropriate type of include to match your needs -->
<!-- pull in a topic as is -->
<module resourceref="_glue-example" renderas="section"/>
<!-- pull in a topic and switch the title -->
<module resourceref="_concept-example" renderas="section">
<merge>
<title>You are a very special concept now!</title>
</merge>
</module>
<module resourceref="_task-example" renderas="section"/>
<module resourceref="_reference-example" renderas="section"/>
<module resourceref="_glue-more-info" renderas="section"/>
<module resourceref="_glue-whats-next" renderas="section"/>
<module resourceref="_legal"/>
<module resourceref="_gfdl">
<output renderas="appendix"/>
</module>
</structure>
</assembly>
Loading

0 comments on commit 3ff519b

Please sign in to comment.