[gjs: 1/2] various documentation improvements




commit db37c420fc9f648b441be097ddd4105b4e502cab
Author: Sonny Piers <sonny fastmail net>
Date:   Sat Apr 4 22:39:54 2020 +0200

    various documentation improvements

 doc/Hacking.md | 28 +++++++++++++++++++++++++---
 doc/Mapping.md |  4 ++--
 doc/Modules.md |  2 +-
 3 files changed, 28 insertions(+), 6 deletions(-)
---
diff --git a/doc/Hacking.md b/doc/Hacking.md
index edab9f54..99031911 100644
--- a/doc/Hacking.md
+++ b/doc/Hacking.md
@@ -18,8 +18,17 @@ systems.)
 The readline library is not required, but strongly recommended.
 We recommend installing your system's development packages for GLib,
 libffi, gobject-introspection, and readline.
-(For example, on Ubuntu you would run
-`sudo apt-get install libglib2.0-dev libffi-dev libreadline-dev libgirepository1.0-dev libreadline-dev`.)
+
+<details>
+    <summary>Ubuntu</summary>
+    <code>sudo apt-get install libglib2.0-dev libffi-dev libreadline-dev libgirepository1.0-dev</code>
+</details>
+
+<details>
+    <summary>Fedora</summary>
+    <code>sudo dnf install glib2-devel libffi readline-devel gobject-introspection-devel</code>
+</details>
+
 But, if your system's versions of these packages aren't new enough, then
 the build process will download and build sufficient versions.
 
@@ -156,4 +165,17 @@ This will build GJS into a separate build directory with code coverage
 instrumentation enabled, run the test suite to collect the coverage
 data, and open the generated HTML report.
 
-[embedder](https://github.com/spidermonkey-embedders/spidermonkey-embedding-examples/blob/esr78/docs/Building%20SpiderMonkey.md)
\ No newline at end of file
+[embedder](https://github.com/spidermonkey-embedders/spidermonkey-embedding-examples/blob/esr78/docs/Building%20SpiderMonkey.md)
+
+## Troubleshooting
+
+### I sent a merge request from my fork but CI does not pass.
+
+Check the job log, most likely you missed the following
+
+> The container registry is not enabled in $USERNAME/gjs, enable it in the project general settings panel
+
+* Go to your fork general setting, for example https://gitlab.gnome.org/$USERNAME/gjs/edit
+* Expand "Visibility, project features, permissions"
+* Enable "Container registry"
+* Hit "Save changes"
diff --git a/doc/Mapping.md b/doc/Mapping.md
index e5f80bd0..48ff8f8f 100644
--- a/doc/Mapping.md
+++ b/doc/Mapping.md
@@ -202,7 +202,7 @@ if (myApp.flags & Gio.ApplicationFlags.HANDLES_OPEN) {
 }
 ```
 
-[gjs-docs]: http://devdocs.baznga.org/
+[gjs-docs]: https://gjs-docs.gnome.org
 [mdn-bitwise]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators/Bitwise_Operators
 
 ## Structs and Unions
@@ -221,7 +221,7 @@ widget.connect("key-press-event", (widget, event) => {
 });
 ```
 
-[gdk-event]: http://devdocs.baznga.org/gdk30~3.22p/gdk.event
+[gdk-event]: https://gjs-docs.gnome.org/gdk40/gdk.event
 
 ## Multiple return values (caller-allocates)
 
diff --git a/doc/Modules.md b/doc/Modules.md
index dbc2b91a..05cb6a7d 100644
--- a/doc/Modules.md
+++ b/doc/Modules.md
@@ -181,7 +181,7 @@ var MyNewClass = class {
 Mainloop is simply a layer of convenience and backwards-compatibility over some GLib functions (such as 
[`GLib.timeout_add()`][gjs-timeoutadd] which in GJS is mapped to [`g_timeout_add_full()`][c-timeoutaddfull]). 
It's use is not generally recommended anymore.
 
 [c-timeoutaddfull]: https://developer.gnome.org/glib/stable/glib-The-Main-Event-Loop.html#g-timeout-add-full
-[gjs-timeoutadd]: http://devdocs.baznga.org/glib20~2.50.0/glib.timeout_add
+[gjs-timeoutadd]: https://gjs-docs.gnome.org/glib20/glib.timeout_add
 
 ## [Package](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/script/package.js)
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]