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.

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
Show file tree
Hide file tree
Changes from 1 commit
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
2 changes: 1 addition & 1 deletion xml/book-obs-user-guide.xml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<part xml:id="par-working">
<title>Usage</title>
<xi:include href="obs_basic_workflow.xml"/>
<xi:include href="osc_building.xml"/>
<xi:include href="obs_local_building.xml"/>

<xi:include href="obs_source_services.xml"/>
<!-- tbd: <xi:include href="obs_signing.xml"/>-->
Expand Down
37 changes: 24 additions & 13 deletions xml/osc_building.xml → xml/obs_local_building.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,36 @@
<!ENTITY % entities SYSTEM "entity-decl.ent">
%entities;
]>
<chapter version="5.1" xml:id="cha-obs-building"
<chapter version="5.1" xml:id="cha-obs-local-building"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a redirect to obs-landing

xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Local Building</title>
<info>
<abstract>
<para>
Every build which happens on the server can also be executed locally in the same environment using
the osc tool. All what you need is to checkout the source code and build the build recipe. The
Every build that happens on the server can also be executed locally in the same environment using
the osc tool. All you need is to check out the source code and run <command>osc build</command> to run the build recipe. The
following explains it for RPM format, but it works for any. osc will download needed binaries
and execute the local build.
</para>
</abstract>
</info>
<remark>toms 2017-08-18: Also integrate content from obs_build_containers.xml</remark>

<sect1 xml:id="sec-obs-building-generic">
<title>Generic build options</title>
<sect1 xml:id="sec-obs-local-building-generic">
<title>Generic Local Build Options</title>
<para>
Frequently, local builds are undertaken on local checkouts of source packages that
already reside on an &obsa; server - for example, to test changes before commiting
them to the server.
</para>
<para>
It is also possible to trigger a local build in an arbitrary local directory containing
sources, without any corresponding source package on an &obsa; server. (However, osc
will still need a connection to the server in order to download build dependencies.)
The following text describes what the source directory should contain, at a minimum.
</para>
<para>
Independent of the build format you need at least one source file as build description.
The file name and structure is format specific. You can find some supported formats described below.
Expand All @@ -49,8 +60,9 @@
</listitem>
</itemizedlist>
<para>
For existing packages, this is already the case. To build an
existing package, the general procedure is as follows:</para>
In the typical case of source packages locally checked out from an &obsa;
server, this is already the case. To build an existing package, the general
procedure is as follows:</para>
<procedure>
<step>
<para>
Expand Down Expand Up @@ -83,8 +95,8 @@
</step>
<step>
<para>
The simplest way to run a build is just to call the build command. osc will try
to detect your installed OS and build for it if possible.
The simplest way to run a build is just to call the <command>osc build</command>
command. osc will try to detect your installed OS and build for it if possible.
</para>
<screen>&prompt.user;<command>osc</command> build</screen>
<para>
Expand All @@ -95,8 +107,7 @@
</step>
<step>
<para>
It will download the required dependencies and execute the build script. Therefore it needs to ask for root
permissions in most cases.
It will download the required dependencies and execute the build script. Therefore it needs to ask for root permissions in most cases.
</para>
<variablelist>
<varlistentry>
Expand Down Expand Up @@ -141,8 +152,8 @@ The buildroot was: /var/tmp/build-root/openSUSE_Tumbleweed-x86_64</screen>
</procedure>
</sect1>

<sect1 xml:id="sec-obs-building-advanced">
<title>Advanced Build Environment Handling</title>
<sect1 xml:id="sec-obs-local-building-advanced">
<title>Advanced Local Build Environment Handling</title>
<para>
The default build environment for local builds is usually chroot. While this is simplest environment
and is therefore easy and fast to handle, it has also a number of shortcomings. For one it is
Expand Down