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 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
3 changes: 1 addition & 2 deletions xml/book-obs-user-guide.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
<xi:include href="obs_basic_workflow.xml"/>
<xi:include href="osc_building.xml"/>

<xi:include href="obs_source_service.xml"/>
<xi:include href="obs_source_services.xml"/>
<!-- tbd: <xi:include href="obs_signing.xml"/>-->

<xi:include href="obs_scm_ci_workflow_integration.xml" />
Expand Down Expand Up @@ -108,7 +108,6 @@
<xi:include href="obs_image_templates.xml"/>
<!-- <xi:include href="obs_build_config.xml"/>-->
<!-- advanced parts -->
<!-- <xi:include href="obs_source_service.xml"/>-->
<xi:include href="obs_multibuild.xml"/>
<!-- <xi:include href="obs_signing.xml"/>-->
<!--<xi:include href="obs_product_building.xml"/>-->
Expand Down
2 changes: 1 addition & 1 deletion xml/obs_scm_ci_workflow_integration.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,7 @@ rebuild_master:
target_project: home:jane</screen>

<note>
<para>If you rely on <xref xrefstyle="select:title" linkend="cha-obs-source-service"/>
<para>If you rely on <xref xrefstyle="select:title" linkend="cha-obs-source-services"/>
to run, for instance to pick up changes from a PR with the <emphasis>obs_scm</emphasis> service, you can't make use of this step.
Package links do not run the services. Use the <emphasis>branch_package</emphasis> step instead.</para>
</note>
Expand Down
52 changes: 24 additions & 28 deletions xml/obs_source_service.xml → xml/obs_source_services.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
<!ENTITY % entities SYSTEM "entity-decl.ent">
%entities;
]>
<chapter version="5.1" xml:id="cha-obs-source-service"
<chapter version="5.1" xml:id="cha-obs-source-services"
Copy link
Member

Choose a reason for hiding this comment

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

I fear we are going to need redirects for this too...

xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" >
<title>Using Source Services</title>
<info/>

<sect1 xml:id="sec-obs-sserv-about">
<title>About Source Service</title>
<title>About Source Services</title>
<para>
Source Services are tools to validate, generate or modify sources in a
trustable way. They are designed as smallest possible tools and can be
Expand All @@ -23,8 +23,8 @@
<itemizedlist>
<listitem>
<para>
Server side generated files are easy to identify and are not
modifiable by the user. This way other user can trust them to be
Server-side generated files are easy to identify and are not
modifiable by the user. This way, other users can trust them to be
generated in the documented way without modifications.
</para>
</listitem>
Expand All @@ -40,42 +40,42 @@
</listitem>
<listitem>
<para>
Services are runnable at any time without user commit.
Source services are runnable at any time without user commit.
</para>
</listitem>
<listitem>
<para>
Services are runnable on server and client side in the same way.
Source services are runnable on server and client side in the same way.
</para>
</listitem>
<listitem>
<para>
Services are safe. A source checkout and service run never harms
Source services are safe. A source checkout and service run never harms
the system of a user.
</para>
</listitem>
<listitem>
<para>
Services avoid unnecessary commits.
Source services avoid unnecessary commits.
This means there are no time-dependent changes. In case the package
already contains the same file, the newly generated file are dropped.
already contains the same file, the newly generated file is dropped.
</para>
</listitem>
<listitem>
<para>
Services running local or inside the build environment can get created,
Source services running local or inside the build environment can get created,
added and used by everybody.
</para>
</listitem>
<listitem>
<para>
Services running in default or server side mode must be installed by
Source services running in default or server side mode must be installed by
the administrator of the &obsa; server.
</para>
</listitem>
<listitem>
<para>
The use of a service can be defined per package or project wide.
The use of a source service can be defined per package or project wide.
</para>
</listitem>
</itemizedlist>
Expand Down Expand Up @@ -143,12 +143,12 @@
</sect1>

<sect1 xml:id="sec-obs-sserv-mode">
<title>Modes of Services</title>
<para> Each service can be used in a mode defining when it should run
<title>Modes of Source Services</title>
<para> Each source service can be used in a mode defining when it should run
and how to use the result. This can be done per package or globally for an
entire project. </para>
<table>
<title>Service Modes</title>
<title>Source Service Modes</title>
<tgroup cols="4">
<colspec colnum="1" colwidth="1*"/>
<colspec colnum="2" colwidth="2*"/>
Expand Down Expand Up @@ -299,9 +299,9 @@
</sect1>

<sect1 xml:id="sec-obs-sserv-validate">
<title>Defining Services for Validation</title>
<title>Defining Source Services for Validation</title>
<para>
Source Services can be used to validate sources. This can be defined
Source services can be used to validate sources. This can be defined
at different levels:
</para>
<itemizedlist>
Expand Down Expand Up @@ -418,22 +418,22 @@
create a token.
</para>
<sect2 xml:id="sec-obs-sserv-gitlab">
<title>Using it on gitlab</title>
<title>Creating a webhook on GitLab</title>
<para>
Go to your repository settings page in your gitlab instance. Select Integrations
there. All what you need to fill is the URL
Go to your repository settings page in your gitlab instance. Select Integrations
there. All what you need to fill is the URL
</para>
<screen>https://<replaceable>YOUR_INSTANCE</replaceable>/trigger/runservice</screen>
<para>
and the Secret Token. Hit the <guimenu>Add webhook</guimenu> button and you are good.
You may specify project and package via CGI parameters in case you created a
wildcard token:
and the Secret Token. Hit the <guimenu>Add webhook</guimenu> button and you are good.
You may specify project and package via CGI parameters in case you created a
wildcard token:
</para>
<screen>https://<replaceable>YOUR_INSTANCE</replaceable>/trigger/runservice?project=<replaceable>PROJECT</replaceable>&amp;package=<replaceable>PACKAGE</replaceable></screen>

</sect2>
<sect2 xml:id="sec-obs-sserv-github-com">
<title>Using it on github.com</title>
<title>Creating a webhook on GitHub</title>
<para>
Go to your repository settings page of your repository on github.com. Select Webhooks
settings and create a hook via <guimenu>Add Webhook</guimenu> button. Define the payload
Expand All @@ -448,8 +448,4 @@
</sect2>
</sect1>

<sect1 condition="tbd">
<title>Interfaces for Using Source Services</title>
<para><remark>tbd</remark></para>
</sect1>
</chapter>