luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-10 03:16:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Convert the resources page to Markdown

Browse Source 
And change mentions of ‘mailing lists’ to ‘support’ while I’m there.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-11-23 18:31:24 +00:00
parent 2c4a0c83e1
commit 54eb9b8900
4 changed files with 45 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/reference/glib/glib.toml.in
View File

@ -45,6 +45,7 @@ content_files = [
"cross-compiling.md",
"running.md",
"programming.md",
"resources.md",
"gvariant-format-strings.md",
"gvariant-text-format.md",

1
docs/reference/glib/meson.build
View File

@ -175,6 +175,7 @@ expand_content_files = [
'host-utils.md',
'data-structures.md',
'programming.md',
'resources.md',
'shell.md',
'spawn.md',
'string-utils.md',

43
docs/reference/glib/resources.md Normal file
View File

@ -0,0 +1,43 @@
Title: Support and Bug Reports
SPDX-License-Identifier: LGPL-2.1-or-later
SPDX-FileCopyrightText: 2002 Matthias Clasen
SPDX-FileCopyrightText: 2018 Collabora, Ltd.
SPDX-FileCopyrightText: 2019 Emmanuele Bassi
# Support and Bug Reports
## Filing a Bug Report or Feature Request
If you encounter a bug, misfeature, or missing feature in GLib, please
file a bug report on the issue tracker at
[https://gitlab.gnome.org/GNOME/glib/issues/new](https://gitlab.gnome.org/GNOME/glib/issues/new).
We’d also appreciate reports of incomplete or misleading information in
the GLib documentation; file those with the ‘Documentation’ label.
Don’t hesitate to file a bug report, even if you think we may know
about it already, or aren’t sure of the details. Just give us as much
information as you have, and if it’s already fixed or has already been
discussed, we’ll add a note to that effect in the report.
The issue tracker should definitely be used for feature requests, it’s
not only for bugs. We track all GLib development in GitLab, so it’s
the way to be sure the GLib developers won’t forget about an issue.
## Code Contributions
If you develop a bugfix or enhancement for GLib, please open a merge request
for that in GitLab as well. All branches must be offered under the terms of
the GNU LGPL license, so be sure you are authorized to give us the branch
under those terms.
If you want to discuss your branch before or after developing it, open a
topic on [Discourse](https://discourse.gnome.org/tags/glib).
But be sure to create the GitLab merge request as well; if the branch is only
on the list and not in GitLab, it’s likely to slip through the cracks.
## Discussions and User Questions
The [GLib issue tracker](https://gitlab.gnome.org/GNOME/glib/issues)
is meant for discussions with actionable topics. If you want to ask a question
about using GLib, or discuss new features, you should use
[the `glib` tag on Discourse](https://discourse.gnome.org/tags/glib).

77
docs/reference/glib/resources.xml
View File

@ -1,77 +0,0 @@
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
]>
<refentry id="glib-resources" revision="17 Jan 2002">
<refmeta>
<refentrytitle>Mailing lists and bug reports</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>Mailing lists and bug reports</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Mailing lists and bug reports</refname>
<refpurpose>
Getting help with GLib
</refpurpose>
</refnamediv>
<refsect1>
<title>Filing a bug report or feature request</title>
<para>
If you encounter a bug, misfeature, or missing feature in GLib, please
file a bug report on the issue tracker at
<ulink url="https://gitlab.gnome.org/GNOME/glib/issues/new">https://gitlab.gnome.org/GNOME/glib/issues/new</ulink>.
We'd also appreciate reports of incomplete or misleading information in
the GLib documentation; file those with the ‘Documentation’ label.
</para>
<para>
Don't hesitate to file a bug report, even if you think we may know
about it already, or aren't sure of the details. Just give us as much
information as you have, and if it's already fixed or has already been
discussed, we'll add a note to that effect in the report.
</para>
<para>
The issue tracker should definitely be used for feature requests, it's
not only for bugs. We track all GLib development in GitLab, so it's
the way to be sure the GLib developers won't forget about an issue.
</para>
</refsect1>
<refsect1>
<title>Code Contributions</title>
<para>
If you develop a bugfix or enhancement for GLib, please open a merge request
for that in GitLab as well. All branches must be offered under the terms of
the GNU LGPL license, so be sure you are authorized to give us the branch
under those terms.
</para>
<para>
If you want to discuss your branch before or after developing it, open a
topic on <ulink url="https://discourse.gnome.org/tags/glib">Discourse</ulink>.
But be sure to create the GitLab merge request as well; if the branch is only
on the list and not in GitLab, it's likely to slip through the cracks.
</para>
</refsect1>
<refsect1>
<title>Discussions and user questions</title>
<para>
The <ulink url="https://gitlab.gnome.org/GNOME/glib/issues">GLib issue tracker</ulink>
is meant for discussions with actionable topics. If you want to ask a question
about using GLib, or discuss new features, you should use
<ulink url="https://discourse.gnome.org/tags/glib">the glib tag on Discourse</ulink>.
</para>
</refsect1>
</refentry>