Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SEO: rewrite certain xml:id values and validate against Geekodoc #364

Merged
merged 19 commits into from
Jul 23, 2024
Merged

SEO: rewrite certain xml:id values and validate against Geekodoc #364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
6f6195c
xml: manual rewrite of some xml:id values
smithfarm Jul 10, 2024
ebbc088
xml: scripted rewrite of some xml:id values
smithfarm Jul 10, 2024
6f47baa
DC: revert from DocBook5 back to Geekodoc
smithfarm Jul 11, 2024
80d6818
xml/obs_ag_security_concepts.xml: correct rewritten xml:id values
smithfarm Jul 21, 2024
4b74654
obs_ag_troubleshooting.xml: use standard acronym OBS
smithfarm Jul 21, 2024
95532a9
xml/obs_architecture.xml: remove superfluous figure link
smithfarm Jul 21, 2024
be0d87f
obs_preface.xml: rip out a superfluous comment
smithfarm Jul 21, 2024
7239550
art-obs-beginners-guide.xml: fix a FIXME from 2017
smithfarm Jul 21, 2024
ca3d352
MAIN-obs.xml: drop commented-out "Technical Papers" book
smithfarm Jul 21, 2024
97cb0ba
MAIN-obs.xml: drop historical "art-obs-quickstart" tag
smithfarm Jul 21, 2024
d9ff0c3
UG: refer to "Source Services" always in the plural
smithfarm Jul 21, 2024
8c0a735
xml/obs_local_building.xml: improve readability
smithfarm Jul 21, 2024
6fc1afa
xml/obs_best_practice_local_setup.xml: rewrite chapter tag for SEO
smithfarm Jul 22, 2024
324b879
xml/obs_best_practice_upstream.xml: rewrite chapter tag for SEO
smithfarm Jul 22, 2024
680ec1b
xml/obs_basic_workflow.xml: rewrite chapter tag for SEO
smithfarm Jul 22, 2024
9cd211e
xml/obs_best_practice_webui_usage.xml: rewrite chapter tag for SEO
smithfarm Jul 22, 2024
ffc0793
Rewrite remaining tags for SEO
smithfarm Jul 22, 2024
b31d9ee
xml/obs_best_practice_howto.xml: rewrite tags for SEO
smithfarm Jul 22, 2024
05a8958
Fix validation issues for xml:id and linkend
tomschr Jul 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions DC-obs-admin-guide
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
## Basics
MAIN="MAIN-obs.xml"
# See "book-obs-admin-guide.xml"
ROOTID="book.obs-admin"
ROOTID="book-obs-admin"

## Profiling
PROFOS="opensuse;novell"
Expand All @@ -18,8 +18,9 @@ PROFCONDITION="bogus"
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse"

## Use DocBook5 instead of GeekoDoc
DOCBOOK5_RNG_URI="http://docbook.org/xml/5.2/rng/docbookxi.rng"
### Use GeekoDoc
#DOCBOOK5_RNG_URI="http://docbook.org/xml/5.2/rng/docbookxi.rng"
DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat"

## Disabled SUSE logo
XSLTPARAM="--param generate.logo=0"
Expand Down
5 changes: 3 additions & 2 deletions DC-obs-all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ PROFCONDITION="bogus"
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse"

## Use DocBook5 instead of GeekoDoc
DOCBOOK5_RNG_URI="http://docbook.org/xml/5.2/rng/docbookxi.rng"
### Use GeekoDoc
#DOCBOOK5_RNG_URI="http://docbook.org/xml/5.2/rng/docbookxi.rng"
DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat"

## enable sourcing
export DOCCONF=$BASH_SOURCE
7 changes: 4 additions & 3 deletions DC-obs-user-guide
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
## Basics
MAIN="MAIN-obs.xml"
# See "book-obs-user-guide.xml"
ROOTID="book.obs-user"
ROOTID="book-obs-user"

## Profiling
PROFOS="opensuse;novell"
Expand All @@ -18,8 +18,9 @@ PROFCONDITION="bogus"
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse"

## Use DocBook5 instead of GeekoDoc
DOCBOOK5_RNG_URI="http://docbook.org/xml/5.2/rng/docbookxi.rng"
### Use GeekoDoc
#DOCBOOK5_RNG_URI="http://docbook.org/xml/5.2/rng/docbookxi.rng"
DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat"

## Disabled SUSE logo
XSLTPARAM="--param generate.logo=0"
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ daps2docker DC-obs-user-guide validate
or if you want to preview the HTML files you can use

```
rm -rf /tmp/daps2docker-*; daps2docker DC-obs-user-guide html; xdg-open /tmp/daps2docker-*/obs-user-guide/html/book.obs-user/index.html
rm -rf /tmp/daps2docker-*; daps2docker DC-obs-user-guide html; xdg-open /tmp/daps2docker-*/obs-user-guide/html/book-obs-user/index.html
```

For more detailed information see
Expand Down
8 changes: 1 addition & 7 deletions xml/MAIN-obs.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<!ENTITY % entities SYSTEM "entity-decl.ent">
%entities;
]>
<set version="5.1" xml:lang="en" xml:id="art_obs_quickstart"
<set version="5.1" xml:lang="en"
xmlns="http://docbook.org/ns/docbook"
xmlns:dm="urn:x-suse:ns:docmanager"
xmlns:xi="http://www.w3.org/2001/XInclude"
Expand All @@ -22,12 +22,6 @@
</dm:bugtracker>
</dm:docmanager>
</info>
<!--
<book xml:id="book.obs.techpaper">
<title>Technical Papers</title>
<info/>
</book>
-->
<xi:include href="book-obs-user-guide.xml"/>
<xi:include href="book-obs-admin-guide.xml"/>
</set>
Loading